SQUAWKFLOW / DEVELOPERS
OPENAPIPOSTMANAPI KEYS
API v1 · Getting started

Market structure data without the plumbing

SquawkFlow exposes the same public market-structure data used by our free tools through a stable JSON API. You can start without an account, then add an API key when you need a higher quota.

1. Make your first request

Anonymous requests are identified by IP address. No signup or token is required.

curl 'https://api.squawkflow.com/api/v1/gex/spx'

2. Authenticate for a larger quota

Create a key in Account → Developer, then send it in the X-API-Key header. The ?key= query parameter also works, but headers keep credentials out of URLs and logs.

curl 'https://api.squawkflow.com/api/v1/gex/spx' \
  -H "X-API-Key: $SQUAWKFLOW_API_KEY"

3. Read the response envelope

Every market-data response has the same top-level fields:

{
  "success": true,
  "data": {},
  "meta": {
    "cached_at": "2026-08-14T19:12:25Z",
    "next_update": "2026-08-14T19:12:50Z"
  },
  "usage": {
    "requests_used": 42,
    "requests_remaining": 958
  }
}

Errors use an HTTP status code plus a predictable body:

{
  "success": false,
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Request quota exceeded. Retry after 120 seconds."
  }
}

Where to go next