Authentication
Anthid endpoints use one or more of the following credential types:
Not every endpoint accepts every credential type. The authentication section on each generated endpoint page is authoritative.
Keep credentials private. Do not embed API keys, user tokens, or service tokens in public client-side code.
REST
REST requests use JSON for both request bodies and responses. IncludeContent-Type: application/json when sending a request body.
Organization API key example:
x-organization-id, a missing or malformed header returns 400. A caller context that requires an organization but has none returns 401; policy denials remain 403. Check the endpoint’s response definitions for its exact access rules.
gRPC
The Streaming API accepts an organization API key or user bearer token in gRPC metadata. This example uses an API key. Clone the public protobuf repository sogrpcurl can load the current split service definition.
Wire conventions
Use each endpoint’s schema for casing, required fields, and pagination. These conventions differ across APIs:
The Instruments API supplies shared reference data. A listed instrument is not a promise of broker trading support.
An
Idempotency-Key on intent submission makes a retry safe: the same key with the same request is answered with the intent the first one made, and the same key with a different request is refused with 409. See Request correlation and retries before implementing automatic retries.