1. CRX
  2. API reference
  3. Market data
  4. Read service status

Read service status

GET/health

Returns API status and each chain's contracts. Not rate limited.

Authentication

None.

Responses

200

OK.

FieldTypeDescription
status requiredstring ok
healthyboolean

false during start-up checks, while the service restarts, or when a chain update cannot be decoded or checked. Balance age is in chains[].balances_as_of.

drainingboolean

true while the service restarts. GET /health returns 503, and any POST, PUT or DELETE returns 503 service_restarting with Retry-After.

trade_typestring

The Trade type string a taker signs.

trade_typehashstring

keccak256 of trade_type.

chains requiredarray of object
chains[].key requiredstring

Chain key to send as chain.

chains[].chain_id requiredinteger

EIP-155 chain ID.

chains[].core requiredstring

Core contract address; the EIP-712 verifyingContract.

chains[].domain requiredstring

EIP-712 domain separator for Quote and Trade.

chains[].enabled requiredboolean

true if the API serves this chain.

chains[].base_tokenstring or null

Collateral token address. null until known.

chains[].pausedboolean

true while CRX is paused and until deposits made during the pause are credited. Omitted if unknown.

chains[].deposits_openboolean

true if deposits are open. Omitted if unknown.

chains[].balances_as_ofintegerminimum 0

Time of the latest balances, in Unix time (milliseconds). Omitted if unknown.

408

timeout: no answer within 30 seconds.

code timeout

503

Start-up chain checks are on hold, or the service is restarting. The body is the 200 body with healthy: false, and boot_checks: "held" or draining: true.