Skip to navigation

Get RFQ venue state

Returns whether the RFQ venue currently accepts RFQs from Paradex.

state is the one to act on. It is the more restrictive of two venue states, both also returned:

  • platform_state, the venue’s global state, with the scheduled next state in next_platform_state taking effect at next_platform_state_at (unix milliseconds, 0 when the state is unknown);
  • venue_state, the venue’s maintenance state for Paradex markets.
stateCreateExecuteCancel
AVAILABLEyesyesyes
AVAILABLE_CANCEL_ONLYnonoyes
UNAVAILABLEnonoonly when platform_state is not UNAVAILABLE
UNKNOWNsent to the venuesent to the venuesent to the venue

A create or an execute refused on the state is answered 400 with error RFQ_VENUE_UNAVAILABLE. A cancel is always sent to the venue; while platform_state is UNAVAILABLE the venue refuses it, and the WebSocket RESULT event reports the refusal. UNKNOWN means the state could not be read recently; requests are then sent to the venue, which answers them through the WebSocket RESULT event.

The state is served from a snapshot refreshed every few seconds, so a change on the venue appears here after up to one refresh.

Authentication

Authorizationstring
API Key authentication via header

Response

OK
next_platform_stateenumOptional
The venue's scheduled next global state
Allowed values:
next_platform_state_atintegerOptional

When next_platform_state takes effect, unix milliseconds; 0 when the state is unknown

platform_stateenumOptional
The venue's global state
Allowed values:
stateenumOptional

The state that applies to an RFQ create, execute or cancel: the more restrictive of platform_state and venue_state

Allowed values:
venue_stateenumOptional
The venue's maintenance state for Paradex markets
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error