Getting started

Base URL

https://api.hooks.social

Calls you make from this site run on the server with your key. The key is not put in the page address.

Check the key

curl -sS \
  -H "Accept: application/json" \
  -H "User-Agent: hooks-social" \
  -H "Authorization: Bearer hk_live_…" \
  "https://api.hooks.social/v1/me"

GET /v1/me returns the balance and rate limit for that key. Read meta.credits on a data response for the debit.

Read a TikTok profile

curl -sS \
  -H "Accept: application/json" \
  -H "User-Agent: hooks-social" \
  -H "Authorization: Bearer hk_live_…" \
  "https://api.hooks.social/v1/tiktok/profile?username=tiktok"

Send a User-Agent. The default Python urllib agent is turned away. curl and browsers are fine.

Envelope

{
  "data": {},
  "error": null,
  "meta": {
    "credits": 1,
    "cached": false,
    "latency_ms": 840,
    "request_id": "…"
  }
}

Status codes

Next

Endpoint reference for every TikTok and Instagram path. The API also serves its own docs and openapi.json. This page is using the live OpenAPI document.

Support

Stuck, or something doesn't look right? Email support@hooks.social. Status shows how each source is doing right now.