Market data / API reference
Get exchange source health
Request and response reference for GET /v1/exchange/source-health.
GET
/v1/exchange/source-healthAuthentication: Feed bearer
Use the base URL and access configuration provided to your institution. Examples are request templates, not transaction results. Field tables focus on client fields; preserve additional metadata returned by the configured service.
Request
Use your feed-scoped bearer token against the market-data service. Feed access does not authorize exchange execution.
curl -X GET "$OSAI_MARKET_DATA_BASE_URL/v1/exchange/source-health?feed_id=$FEED_ID&feed_version=$FEED_VERSION" \
-H "Authorization: Bearer $OSAI_FEED_TOKEN"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
feed_id | query · string | Required | Use the value defined for this resource. |
feed_version | query · string | Required | Use the value defined for this resource. |
Request body
This operation does not define a JSON request body.
Responses
Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.
200 · Database-observed source and ingestion times; corrections do not refresh old source timestamps.
| Field | Type | Description & constraints |
|---|---|---|
contract_versionRequired in parent object | string | Defined by the resource contract.Values: osai-candles/v1 |
feed_idRequired in parent object | string | Defined by the resource contract. |
feed_versionRequired in parent object | string | Defined by the resource contract.Pattern: ^[1-9][0-9]*$ |
policy_idRequired in parent object | string | Defined by the resource contract. |
policy_versionRequired in parent object | string | Defined by the resource contract.Pattern: ^[1-9][0-9]*$ |
statusRequired in parent object | string | Defined by the resource contract.Values: NO_DATA, FRESH, STALE, CLOCK_SKEW |
observed_atRequired in parent object | stringdate-time | Defined by the resource contract. |
source_as_ofRequired in parent object | string | nulldate-time | Defined by the resource contract. |
last_ingested_atRequired in parent object | string | nulldate-time | Defined by the resource contract. |
source_age_msRequired in parent object | integer | null | Defined by the resource contract. |
freshness_msRequired in parent object | integer | Defined by the resource contract.Minimum: 1Maximum: 86400000 |
executableRequired in parent object | boolean | Defined by the resource contract.Values: false |
400 · Request denied or dependency unavailable.
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | string | Defined by the resource contract. |
401 · Request denied or dependency unavailable.
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | string | Defined by the resource contract. |
403 · Request denied or dependency unavailable.
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | string | Defined by the resource contract. |
404 · Request denied or dependency unavailable.
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | string | Defined by the resource contract. |
405 · Request denied or dependency unavailable.
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | string | Defined by the resource contract. |
429 · Request denied or dependency unavailable.
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | string | Defined by the resource contract. |
503 · Request denied or dependency unavailable.
| Field | Type | Description & constraints |
|---|---|---|
errorRequired in parent object | string | Defined by the resource contract. |
Retries & recovery
Keep the original request identifiers and any required idempotency key. A timeout does not establish failure. Read the original resource or command before another financial write; use expected versions for concurrent changes.