Skip to main content
The Exchanges API allows you to retrieve exchange resources. An exchange represents an instance of a RecurringExchange for a single date.

​
Resource

​
Exchange

Resource that represents an instance of a RecurringExchange for a single date.
​
name
string
required
Resource name with one of these patterns:
  • recurringExchanges/{recurring_exchange}/exchanges/{exchange}
  • dataProviders/{data_provider}/recurringExchanges/{recurring_exchange}/exchanges/{exchange}
  • modelProviders/{model_provider}/recurringExchanges/{recurring_exchange}/exchanges/{exchange}
​
date
Date
required
Date of the Exchange. Must be a complete date (no field can be unset/zero).
​
state
State
State of this Exchange.Enum values:
  • STATE_UNSPECIFIED: Default value used if the state is omitted
  • ACTIVE: The exchange has not yet reached a terminal state
  • SUCCEEDED: The exchange has completed successfully
  • FAILED: The exchange has failed
​
audit_trail_hash
bytes
SHA256 hash of the audit trail, if uploaded.
​
graphviz_representation
string
DOT language representation of the Exchange. This gives the status and relationship between all steps.See https://graphviz.org/doc/info/lang.html for the language specification.

​
Methods

​
GetExchange

Returns the Exchange with the specified resource key.
​
name
string
required
Resource name of the Exchange to retrieve.Format: recurringExchanges/{recurring_exchange}/exchanges/{exchange} (or with dataProviders/modelProviders prefix)
Response Returns an Exchange resource. Example Request 
GetExchangeRequest {
  name: "recurringExchanges/123/exchanges/456"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us