Docs / More

REST API

The SDK wraps a plain REST API — usable from any language. Base URL https://api.zapi.ink, scraper calls at /v1/{category:scraper}/{endpoint}, authenticated with the x-api-key header:

curl
curl -X POST "https://api.zapi.ink/v1/social:instagram/profile" \  -H "x-api-key: zpi_xxx" \  -H "content-type: application/json" \  -d '{"username":"instagram"}' # response envelope — the SDK unwraps .data for you# { "project": "social:instagram", "data": { ... }, "timestamp": ... }
curl -X POST "https://api.zapi.ink/v1/social:instagram/profile" \  -H "x-api-key: zpi_xxx" \  -H "content-type: application/json" \  -d '{"username":"instagram"}' # response envelope — the SDK unwraps .data for you# { "project": "social:instagram", "data": { ... }, "timestamp": ... }

Error statuses match the error table above — 401 bad key, 403 plan gate, 429 rate limit (respect Retry-After), 5xx retry with backoff. Bulk jobs live at POST /v1/{category:scraper}/{endpoint}/bulk and GET /v1/bulk/{jobId}.

Edit this page on GitHubWas this page helpful? ·