Skip to main content
All endpoints live under one base URL:
Paths in these docs, such as GET /identity, are relative to that base URL.

​
Request and response format

  • Requests and responses are JSON. Send Content-Type: application/json with every request that has a body.
  • GET endpoints take their inputs as query parameters. To send several values for an array filter, repeat the parameter (for example ?location=new_york&location=boston).
  • Path parameters such as {roleId} are part of the URL. If a body or query field has the same name, the URL value wins.
  • Request bodies are limited to 12 MB. A larger body is rejected with 413 before it reaches the API, so that response has neither the standard error envelope nor a request id.
  • Every response carries an X-Request-Id header. Quote it when you contact Paraform about a specific request.
  • Responses are never cached: every response is sent with Cache-Control: private, no-store.

​
Versioning

The version is part of the path (/v1). Within a version, the API documents some stable vocabularies (for example batch errorCode values and market-status status values) as never renamed, but extended: new values may be added, so treat unknown values as described on each endpoint’s page.

​
Health check

GET /health needs no API key and returns {"status": "ok", ...} while the API is serving requests.