Developer Documentation

Comprehensive cable and connector reference for IT professionals, home users, and A/V enthusiasts. Covers connector types, cable standards, device compatibility, setup guides, speed benchmarks, interactive tools, glossary, and in-depth guides. 15 languages supported.

Quick Start

curl -s "https://cablefyi.com/api/v1/connectors/"

API Endpoints

Method Endpoint Description
GET /api/v1/connectors/ List connector types
GET /api/v1/connectors/{slug}/ Connector detail
GET /api/v1/standards/ Cable standards
GET /api/v1/cables/ All cables
GET /api/v1/devices/ Devices with ports
GET /api/v1/compatibility/ Compatibility results
GET /api/v1/setup-guides/ Setup guides
GET /api/v1/benchmarks/ Speed benchmarks
GET /api/v1/terms/ Glossary terms
GET /api/v1/guide-series/ Guide series
GET /api/v1/guides/ Guide articles
GET /api/v1/tools/ Interactive tools
GET /api/v1/faqs/ FAQs
GET /api/v1/stats/ Site statistics
GET /api/v1/search/?q={query} Search across all content

URL Patterns

Use these patterns to construct URLs programmatically:

/connectors/ Browse all connector types (e.g. /connectors/)
/connectors/{slug}/ Connector detail with pinouts (e.g. /connectors/usb-type-c/)
/standards/ Cable standards (e.g. /standards/)
/standards/{slug}/ Standard detail (e.g. /standards/hdmi-2-1/)
/cables/ All cables (e.g. /cables/)
/cables/{slug}/ Cable detail (e.g. /cables/usb-c-to-usb-c/)
/devices/ Devices with port info (e.g. /devices/)
/devices/{slug}/ Device detail (e.g. /devices/macbook-pro-m3/)
/setup/{slug}/ Setup guide (e.g. /setup/dual-monitor-usb-c/)
/speed/{slug}/ Speed benchmark (e.g. /speed/thunderbolt-4/)
/compare/ Comparisons (e.g. /compare/)
/compare/{slug1}-vs-{slug2}/ Side-by-side comparison (e.g. /compare/usb-c-vs-thunderbolt-4/)
/terms/ Cable terminology glossary (e.g. /terms/)
/terms/{slug}/ Glossary term detail (e.g. /terms/bandwidth/)
/guides/ In-depth guides (e.g. /guides/)
/guides/{slug}/ Guide detail (e.g. /guides/usb-c-explained/)
/tools/ Interactive tools (e.g. /tools/)
/tools/{slug}/ Tool detail (e.g. /tools/cable-finder/)
/search/ Search cables, connectors, glossary (e.g. /search/?q=usb-c)

Response Format

All endpoints return JSON with pagination:

Example JSON response
{
  "count": 636,
  "next": "https://example.com/api/v1/items/?page=2",
  "previous": null,
  "results": [
    {"slug": "example", "name": "Example Item", "...": "..."}
  ]
}

OpenAPI Specification

Full API schema available as OpenAPI 3.1.0 JSON. Import into Swagger UI, Postman, or any OpenAPI-compatible tool.

SDK Packages

PyPI
pip install cablefyi

Submarine cables and landing points API client

Embed Widget

Embed data cards on your site: https://widget.cablefyi.com
npm install cablefyi-embed

Format Support

  • Markdown endpoints: Append .md to any page URL for LLM-friendly markdown output.
  • Internationalization: Content available in 14 languages: ko, ja, zh-hans, es, fr, de, pt, ru, vi, tr, ar, hi, th, id.