Developer Documentation

Comprehensive Bluetooth Low Energy reference for embedded engineers, IoT developers, and product designers. Covers BLE SoC chips, Bluetooth versions 4.0-6.0, GATT profiles and services, beacon protocols (iBeacon, Eddystone), mesh networking, manufacturers, use cases, interactive tools, glossary, and guides. 15 languages supported.

Quick Start

curl -s "https://blefyi.com/api/v1/chips/"

API Endpoints

Method Endpoint Description
GET /api/v1/chips/ List all BLE SoC chips
GET /api/v1/chips/{slug}/ BLE chip detail with full specs
GET /api/v1/versions/ Bluetooth versions
GET /api/v1/manufacturers/ BLE chip manufacturers
GET /api/v1/profiles/ GATT profiles and services
GET /api/v1/beacons/ Beacon protocols
GET /api/v1/use-cases/ BLE use cases
GET /api/v1/mesh/ Mesh topology concepts
GET /api/v1/glossary/ Glossary terms
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:

/chip/ Browse all BLE SoC chips (e.g. /chip/)
/chip/{slug}/ BLE chip detail with full specs (e.g. /chip/nrf52840/)
/version/ Bluetooth versions 4.0-6.0 (e.g. /version/)
/version/{slug}/ Bluetooth version detail (e.g. /version/bluetooth-5-4/)
/profile/ GATT profiles and services (e.g. /profile/)
/profile/{slug}/ Profile detail with characteristics (e.g. /profile/heart-rate/)
/beacon/ Beacon protocols (e.g. /beacon/)
/beacon/{slug}/ Beacon protocol detail (e.g. /beacon/ibeacon/)
/manufacturer/ BLE chip manufacturers (e.g. /manufacturer/)
/manufacturer/{slug}/ Manufacturer detail (e.g. /manufacturer/nordic-semiconductor/)
/mesh/ Bluetooth Mesh concepts (e.g. /mesh/)
/mesh/{slug}/ Mesh topology detail (e.g. /mesh/relay-node/)
/use-case/ BLE use cases (e.g. /use-case/)
/use-case/{slug}/ Use case detail (e.g. /use-case/wearable-fitness/)
/glossary/ BLE terminology glossary (e.g. /glossary/)
/glossary/{slug}/ Glossary term detail (e.g. /glossary/gatt/)
/guide/ In-depth BLE guides (e.g. /guide/)
/guide/{slug}/ Guide article (e.g. /guide/ble-vs-classic/)
/tools/ Interactive BLE tools (e.g. /tools/)
/tools/chip-selector/ BLE chip selector wizard (e.g. /tools/chip-selector/)
/tools/gatt-browser/ GATT service and characteristic browser (e.g. /tools/gatt-browser/)
/tools/power-estimator/ BLE power consumption estimator (e.g. /tools/power-estimator/)
/tools/range-calculator/ BLE range calculator (e.g. /tools/range-calculator/)
/tools/uuid-generator/ BLE UUID generator (e.g. /tools/uuid-generator/)
/tools/packet-builder/ BLE advertising packet builder (e.g. /tools/packet-builder/)
/timeline/ BLE technology timeline (e.g. /timeline/)
/compare/ BLE comparison index (e.g. /compare/)
/compare/{slug}/ Side-by-side comparison (e.g. /compare/nrf52840-vs-esp32/)
/search/ Search chips, profiles, terms (e.g. /search/?q=nordic)

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 blefyi

BLE chip data, GATT profiles, Bluetooth version reference

npm
npm install @fyipedia/blefyi

TypeScript BLE chip and profile utilities

RubyGems
gem install blefyi

Ruby BLE chip reference

crates.io
cargo add blefyi

Rust BLE chip reference

Embed Widget

Embed data cards on your site: https://widget.blefyi.com
npm install blefyi-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.