Exchange / API reference
Get Capabilities
Request and response reference for GET /v1/exchange/markets/{market}/capabilities.
GET
/v1/exchange/markets/{market}/capabilitiesAuthentication: Console sessionPermission: exchange.read
Use the base URL and access configuration provided to your institution. Examples are request templates, not transaction results. Field tables focus on client fields; preserve additional metadata returned by the configured service.
Request
This interface uses an approved institutional session, not a financial API key. Session writes also need Origin and CSRF protection. Use the JavaScript sample within an authorized browser integration.
curl -X GET "$OSAI_CONSOLE_BASE_URL/v1/exchange/markets/$MARKET_ID/capabilities" \
-H "Origin: $OSAI_APP_ORIGIN" \
--cookie "$OSAI_SESSION_COOKIE_FILE"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
market | path · string | Required | Use the value defined for this resource. |
Request body
This operation does not define a JSON request body.
Responses
Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.
200 · HTTP 200 response
| Field | Type | Description & constraints |
|---|---|---|
specificationRequired in parent object | string | Defined by the resource contract.Values: osai-exchange/v1 |
marketRequired in parent object | object | Defined by the resource contract. |
market.market_idRequired in parent object | string | Defined by the resource contract. |
market.pairRequired in parent object | string | Defined by the resource contract. |
market.base_currencyRequired in parent object | string | Defined by the resource contract. |
market.quote_currencyRequired in parent object | string | Defined by the resource contract. |
market.self_trade_policyRequired in parent object | string | Defined by the resource contract. |
market.versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.price_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.quantity_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.price_tickRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.quantity_stepRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.minimum_quantityRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.maximum_quantityRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.maximum_priceRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.maximum_retained_ordersRequired in parent object | integer | Defined by the resource contract. |
market.maximum_retained_commandsRequired in parent object | integer | Defined by the resource contract. |
market.fee_schedulesRequired in parent object | array | Defined by the resource contract. |
market.fee_schedules[].schedule_idRequired in parent object | string | Defined by the resource contract. |
market.fee_schedules[].versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.fee_schedules[].effective_fromRequired in parent object | stringdate-time | Defined by the resource contract. |
market.fee_schedules[].effective_untilRequired in parent object | stringdate-time | Defined by the resource contract. |
market.fee_schedules[].makerRequired in parent object | object | Defined by the resource contract. |
market.fee_schedules[].maker.currencyRequired in parent object | string | Defined by the resource contract. |
market.fee_schedules[].maker.minor_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.fee_schedules[].maker.numeratorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.fee_schedules[].maker.denominatorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.fee_schedules[].maker.roundingRequired in parent object | string | Defined by the resource contract.Values: FLOOR, CEILING |
market.fee_schedules[].takerRequired in parent object | object | Defined by the resource contract. |
market.fee_schedules[].taker.currencyRequired in parent object | string | Defined by the resource contract. |
market.fee_schedules[].taker.minor_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.fee_schedules[].taker.numeratorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.fee_schedules[].taker.denominatorRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
market.fee_schedules[].taker.roundingRequired in parent object | string | Defined by the resource contract.Values: FLOOR, CEILING |
market.allowed_order_instructionsOptional | array | Defined by the resource contract. |
market.allowed_order_instructions[].typeRequired in parent object | string | Defined by the resource contract.Values: LIMIT, MARKET |
market.allowed_order_instructions[].time_in_forceRequired in parent object | string | Defined by the resource contract.Values: GTC, IOC, FOK, POST_ONLY |
market.allowed_order_instructions[].price_protection_requiredRequired in parent object | boolean | Defined by the resource contract. |
supported_order_instructionsRequired in parent object | array | Defined by the resource contract. |
supported_order_instructions[].typeRequired in parent object | string | Defined by the resource contract.Values: LIMIT, MARKET |
supported_order_instructions[].time_in_forceRequired in parent object | string | Defined by the resource contract.Values: GTC, IOC, FOK, POST_ONLY |
supported_order_instructions[].price_protection_requiredRequired in parent object | boolean | Defined by the resource contract. |
priorityRequired in parent object | string | Defined by the resource contract.Values: PRICE_TIME |
execution_priceRequired in parent object | string | Defined by the resource contract.Values: RESTING_LIMIT_PRICE |
replacement_priorityRequired in parent object | string | Defined by the resource contract.Values: NEW_ORDER_NEW_PRIORITY |
book_recoveryRequired in parent object | string | Defined by the resource contract.Values: COMMAND_ATOMIC_ABSOLUTE_LEVELS |
capacity_evidenceRequired in parent object | string | Defined by the resource contract. |
match_settlement_stateRequired in parent object | string | Defined by the resource contract.Values: MATCHED_NOT_SETTLED |
400 · Invalid bounded instruction
No client body fields are defined for this response.
401 · Authentication required
No client body fields are defined for this response.
403 · Permission, recent verified MFA or CSRF denied
No client body fields are defined for this response.
409 · Version, preview, instruction or capacity conflict
No client body fields are defined for this response.
503 · Unavailable or unknown commit outcome; query the original command before retrying
No client body fields are defined for this response.
Retries & recovery
Keep the original request identifiers and any required idempotency key. A timeout does not establish failure. Read the original resource or command before another financial write; use expected versions for concurrent changes.