Base URL
Authentication
All/v1/* endpoints require an API key in the x-api-key header:
Response format
Success
All successful scrape responses follow the same envelope:Error
Endpoints
System
| Method | Path | Auth | Description |
|---|---|---|---|
| GET | /health | No | Health check |
Account
| Method | Path | Credits | Description |
|---|---|---|---|
| GET | /v1/credit-balance | 0 | Check remaining credits |
| Method | Path | Credits | Description |
|---|---|---|---|
| GET | /v1/instagram/profile | 1 | Get user profile |
| GET | /v1/instagram/user/posts | 2 | Get user’s recent posts |
| GET | /v1/instagram/post | 1 | Get single post by shortcode |
| GET | /v1/instagram/post/comments | 2 | Get comments on a post |
| GET | /v1/instagram/hashtag/posts | 1 | Search posts by hashtag |
Caching
Responses are cached server-side to improve performance:| Data type | Cache TTL |
|---|---|
| Profiles | 1 hour |
| Posts | 15 minutes |
| Comments | 5 minutes |
| Hashtag posts | 5 minutes |
X-Request-ID header is included on every response for debugging.
OpenAPI spec
The full OpenAPI 3.1 spec is available at:- JSON:
GET /openapi.json - YAML:
GET /openapi.yaml