API Docs

Clean JSON endpoints secured by API Key: no marketing HTML, only structured data your agent can consume directly.

Developer Center MCP Docs CLI Docs Skills Docs API Docs Get API Key

How to obtain an API Key

Register an account → log in → create an API Key by yourself, the whole process does not require manual review and is available immediately.

1. Click "Sign up" in the upper right corner of the website to register an account (corporate email is required).
2. Sign in with email and password.
3. Go to the "Request API Key" page，Click the "Create API Key" button.
4. Copy the generated Key (plaintext is displayed only once, lost needs to be recreated).
5. All /api/v1/dev/* interfaces are invoked by carrying Authorization: Bearer < key > in the request header.

api-key-flow

bash

# 1. Register an account
curl -X POST "https://api.tikchip.cn/api/v1/auth/register" \
  -H "Content-Type: application/json" \
  -d '{"email":"you@company.com","password":"YourPass123","password_confirm":"YourPass123","company":"Your Company","username":"yourname"}'

# 2. Log in to get JWT
curl -X POST "https://api.tikchip.cn/api/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"username":"you@company.com","password":"YourPass123"}'
# → Return data.token (JWT, used for subsequent management interfaces)

# 3. Create API Key with JWT
curl -X POST "https://api.tikchip.cn/api/v1/dev/keys" \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'
# → Return data.api_key (tk_xxx, only displayed once, save now)

# 4. Calling Business Interface with API Key
curl -H "Authorization: Bearer <API_KEY>" \
  "https://api.tikchip.cn/api/v1/dev/search?keyword=STM32"

Apply for API Key Now

Authentication

Send Authorization: Bearer <key> in the request header, or use X-TikChip-Key.

curl

bash

curl -H "Authorization: Bearer $TIKCHIP_API_KEY" \
  "https://api.tikchip.cn/api/v1/dev/search?keyword=STM32F103C8T6&in_stock_only=true"

Rate Limits & Quota

Search endpoints allow 60 requests per minute; submit_inquiry defaults to 20 calls per Key per day. Over-limit requests return 429 with Retry-After.

429

http

HTTP/1.1 429 Too Many Requests
Retry-After: 12

Endpoint List

All endpoints live under the /api/v1/dev prefix and require an Agent API Key.

Tool	Method	Endpoint
search_components	GET	/api/v1/dev/search
get_component_detail	GET	/api/v1/dev/component/{mpn}
compare_components	POST	/api/v1/dev/compare
check_stock	GET	/api/v1/dev/stock
recommend_alternatives	GET	/api/v1/dev/alternatives
submit_inquiry	POST	/api/v1/dev/inquiry
register_b2b_account	POST	/api/v1/dev/register
get_inquiry_messages	GET	/api/v1/dev/inquiry/{id}/messages
reply_to_inquiry	POST	/api/v1/dev/inquiry/{id}/reply
list_inquiries	GET	/api/v1/dev/inquiries
get_bom_price	POST	/api/v1/dev/bom/price

Discovery endpoints (no Key required)

Agents can read the public endpoints below to discover this site's capabilities.

discovery

http

GET /api/v1/dev/agent-card.json   # Agent robots (identity/capability/frequency)
GET /api/v1/dev/manifest          # List of Machine Readable Tools
GET /api/v1/dev/openapi           # OpenAPI 3.0 Documentation

Get API Key