Skip to navigation

Exchange Item

View as Markdown

Retrieve an exchange by ID.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Resolve a single exchangeId to its exchange record. Other records, such as products and fees, reference an exchange by ID, so use this endpoint when you have an exchangeId and need the exchange it points to. Exchanges are read-only reference data.

Common Failure Scenarios

  • No exchange matches the id. This returns HTTP 404 with an empty body.
  • The id parameter is missing or repeated (HTTP 404), or isn’t a whole number (HTTP 400).
  • The caller’s user type, or the API key’s permissions, can’t read exchanges. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read exchanges.
(no message text)404No exchange matches the id.
(no message text)404The id parameter is missing or repeated.
"Bad Request"400id isn’t a whole number.

Related Endpoints

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idlongRequired

Response

Exchange
namestring<=64 characters
idlongOptional
micCodestringOptional<=64 characters