Skip to main content
GET
Get the effective market status of a token

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL, with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed.

Path Parameters

tokenId
string
required

The token's id, as GET /tokens lists it. One per chain deployment.

Response

The effective status.

tokenId
string
required
Example:

"7f3b2c10-5d4e-4a6b-9c8d-1e2f3a4b5c6d"

assetId
string
required
Example:

"c0a8e2f4-1b3d-4e5f-8a9b-0c1d2e3f4a5b"

marketStatus
enum<string>
required

UNAVAILABLE while a restriction that stops trading applies at any scope; otherwise the underlying market's status.

Available options:
OPEN,
CLOSED,
UNAVAILABLE
reason
string | null
required

Why. The reasonCode of the most restrictive restriction when UNAVAILABLE because of one; otherwise the market's reason, for example PRE_MARKET, POST_MARKET or MARKET_STATUS_UNKNOWN. null when there is none.

Example:

"POST_MARKET"

activeRestrictions
object[]
required

Every restriction in force on the token, its asset and the underlying market.

asOf
string<date-time>
required

When this status was computed.