Get Trading Limits

Provides real-time trading limits based on global, user, and asset-specific exposure limits.

Limits:

  • The "Max Notional Value" limit is based on the dollar value of outstanding attestations. That is, if a user has a limit of $1,000,000, and has 30 non-expired, non-filled attestations at a value of $999,000, they will not be able to request another attestation for $1000.
  • The "Remaining Attestations" limits the number of non-expired, non-executed attestations. For example if the limit is 50, and a user has 50 outstanding attestations, they must wait for one to execute or expire before requesting another.

If the market is closed or paused, the response will indicate that trading is not allowed and provide the reason. For more information on market hours, see the /v1/status/market endpoint.

Trading Limits Reason Codes

When trading is not allowed, the response will include a reason field which may include one of the following common codes:

  • MARKET_CLOSED: Market is closed.
  • MARKET_PAUSED: Market is temporarily paused.
  • ASSET_PAUSED: Specific asset is paused.
  • ASSET_CLOSED_FOR_SESSION: The asset is not tradable in this session (e.g., not available overnight; see Get Market Data)
  • ASSET_LIMITED: Asset can be traded, but order size is more limited than usual.
  • MAX_LIMIT_REACHED: Maximum limit has been reached.
  • MAX_ATTESTATIONS: Maximum attestations reached.

For caching details on this endpoint, please see: Endpoint Caching.

Query Params
string
required

The GM token symbol.

string
enum
required

The trade side

Allowed:
Responses

400

One of the request parameters is invalid. Please see the returned message and documentation for details.

401

Missing or invalid API key. Please provide your API key in the x-api-key request header.

429

Client is sending too many requests and exceeded the rate limit.

500

An internal server error occurred. Please see the returned message and documentation for details.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json