Rfqs

Get RFQ venue state

Changed on

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.

get/rfqs/platform-state

Request

  • Base URL
    https://api.prod.paradex.trade/v1
  • URL
    https://api.prod.paradex.trade/v1/rfqs/platform-state
  • Auth
    API key in header Authorization

Response

OK

next_platform_state'AVAILABLE' | 'AVAILABLE_CANCEL_ONLY' | 'UNAVAILABLE' | 'UNKNOWN'
next_platform_state_atinteger

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

platform_state'AVAILABLE' | 'AVAILABLE_CANCEL_ONLY' | 'UNAVAILABLE' | 'UNKNOWN'
state'AVAILABLE' | 'AVAILABLE_CANCEL_ONLY' | 'UNAVAILABLE' | 'UNKNOWN'
venue_state'AVAILABLE' | 'AVAILABLE_CANCEL_ONLY' | 'UNAVAILABLE' | 'UNKNOWN'

Example response

{
  "next_platform_state_at": 1640995200000
}

Changes

  • f33feb7333eaRevision changes
    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

  • 72c125c93c2bRevision changes
    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status