Get instrument status

GET 
/v3/instruments/:tradeable/status

Get instrument status

Request

Path Parameters

tradeable stringrequired

Instrument identifier.

Responses

200

application/json

Schema

Schema

oneOf
Success Response
serverTime string
Server time in Coordinated Universal Time (UTC)
result string
Possible values: [success]
tradeable string
isExperiencingDislocation boolean
priceDislocationDirection stringnull
Possible values: [ABOVE_UPPER_BOUND, BELOW_LOWER_BOUND]
isExperiencingExtremeVolatility boolean
extremeVolatilityInitialMarginMultiplier integer
ErrorResponse
serverTime string
Server time in Coordinated Universal Time (UTC)
result string
Possible values: [error]
errors Error (string)[]
Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]
error Error (string)
Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]
Error description.
• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Loading...