Response Format

All endpoints return a consistent JSON structure with metadata, pagination info, and results.

Response Structure

JSON Response

{
  "timestamp": "2026-04-06T12:00:00Z",     // Server timestamp
  "params": {                                // Echo of your request params
    "min_volume": "1000",
    "closed": "False"
  },
  "pagination": {
    "limit": 10,                             // Your requested limit
    "offset": 0,                             // Your requested offset
    "has_more": true                         // More results available?
  },
  "data": {
    "results": [                             // Array of result objects
      { ... },
      { ... }
    ]
  },
  "request_id": "abc-123-def"               // Unique request identifier
}

Field Reference

Field	Type	Description
timestamp	String (ISO 8601)	Server-side timestamp of the response.
params	Object	Echo of the params you sent in the request.
pagination.limit	Integer	Number of results returned in this page.
pagination.offset	Integer	Number of results skipped.
pagination.has_more	Boolean	If true, more results are available. Increment offset to fetch the next page.
data.results	Array	Array of result objects. Structure varies by endpoint — see individual endpoint docs.
request_id	String	Unique identifier for debugging. Include in support requests.

Pagination

To paginate through results, check has_more in the response and increment offset by limit:

Pagination Example

// Page 1
{ "pagination": { "limit": 50, "offset": 0 } }

// Page 2 (if has_more: true)
{ "pagination": { "limit": 50, "offset": 50 } }

// Page 3
{ "pagination": { "limit": 50, "offset": 100 } }

Timestamp Format

All timestamps in responses use ISO 8601 format in UTC: 2026-04-06T12:00:00Z. Some endpoints accept Unix timestamps as strings in params — check each endpoint's documentation for details.