Request Format

All Heisenberg API endpoints use a single POST URL with a JSON body. The agent_id determines which data source to query.

Body Structure

JSON

{
  "agent_id": 574,              // Required — selects the endpoint
  "params": {                   // Optional — filter parameters
    "min_volume": "1000",
    "closed": "False"
  },
  "pagination": {               // Optional — control result size
    "limit": 10,                // 1–200, default varies by endpoint
    "offset": 0                 // Skip N results for pagination
  },
  "formatter_config": {         // Optional — response formatting
    "format_type": "raw"        // "raw" returns structured JSON
  }
}

Field Reference

Field	Type	Required	Description
agent_id	Integer	Yes	Identifies the data endpoint. See API Reference for all IDs.
params	Object	No	Key-value pairs for filtering. All values are strings. Available params vary by endpoint.
pagination.limit	Integer	No	Number of results per page (1–200). Defaults vary by endpoint.
pagination.offset	Integer	No	Number of results to skip. Use for pagination through large result sets.
formatter_config.format_type	String	No	Response format. Use `"raw"` for structured JSON.

Tips

•All params values must be strings, even numbers (e.g. "1000" not 1000).
•Omit optional fields entirely rather than passing null — the API ignores unknown fields.
•Use limit: 200 for bulk retrieval and check has_more in the response for pagination.