REST API
PostgREST API (11.2.1)
Download OpenAPI specification:Download
This is a dynamic API generated by PostgREST
/tickers
query Parameters
| market_id | string <numeric> |
| base_currency | string <text> |
| quote_currency | string <text> |
| base_volume | string <numeric> |
| quote_volume | string <numeric> |
| base_volume_nominal | string <double precision> |
| quote_volume_nominal | string <double precision> |
| last_price | string <numeric> |
| ask | string <numeric> |
| bid | string <numeric> |
| high | string <numeric> |
| low | string <numeric> |
| liquidity_in_quote | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "base_currency": "string",
- "quote_currency": "string",
- "base_volume": 0,
- "quote_volume": 0,
- "base_volume_nominal": 0,
- "quote_volume_nominal": 0,
- "last_price": 0,
- "ask": 0,
- "bid": 0,
- "high": 0,
- "low": 0,
- "liquidity_in_quote": 0
}
]/market_registration_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0
}
]/market_registration_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
market_registration_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> <= 70 characters |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> <= 70 characters |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| lot_size | number <numeric> |
| tick_size | number <numeric> |
| min_size | number <numeric> |
| underwriter_id | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0
}/market_registration_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/market_registration_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
market_registration_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> <= 70 characters |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> <= 70 characters |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| lot_size | number <numeric> |
| tick_size | number <numeric> |
| min_size | number <numeric> |
| underwriter_id | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0
}/enumerated_volume
query Parameters
| address | string <text> |
| module | string <text> |
| struct | string <text> |
| volume_as_base | string <numeric> |
| volume_as_quote | string <numeric> |
| generic_asset_name | string <text> |
| name | string <text> |
| symbol | string <text> |
| decimals | string <smallint> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "address": "string",
- "module": "string",
- "struct": "string",
- "volume_as_base": 0,
- "volume_as_quote": 0,
- "generic_asset_name": "string",
- "name": "string",
- "symbol": "string",
- "decimals": 0
}
]/orders
query Parameters
| market_id | string <numeric> |
| order_id | string <numeric> |
| created_at | string <timestamp with time zone> |
| last_updated_at | string <timestamp with time zone> |
| integrator | string <text> |
| total_filled | string <numeric> |
| remaining_size | string <numeric> |
| order_status | string <public.order_status> |
| order_type | string <public.order_type> |
| user | string <text> |
| direction | string <public.order_direction> |
| price | string <numeric> |
| average_execution_price | string <numeric> |
| custodian_id | string <numeric> |
| self_match_behavior | string <smallint> |
| restriction | string <smallint> |
| last_increase_stamp | string <numeric> |
| min_base | string <numeric> |
| max_base | string <numeric> |
| min_quote | string <numeric> |
| max_quote | string <numeric> |
| total_fees_paid_in_quote_subunits | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "order_id": 0,
- "created_at": "string",
- "last_updated_at": "string",
- "integrator": "string",
- "total_filled": 0,
- "remaining_size": 0,
- "order_status": "open",
- "order_type": "limit",
- "user": "string",
- "direction": "sell",
- "price": 0,
- "average_execution_price": 0,
- "custodian_id": 0,
- "self_match_behavior": 0,
- "restriction": 0,
- "last_increase_stamp": 0,
- "min_base": 0,
- "max_base": 0,
- "min_quote": 0,
- "max_quote": 0,
- "total_fees_paid_in_quote_subunits": 0
}
]/orders
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
orders
| market_id | number <numeric> Note:
This is a Primary Key. |
| order_id | number <numeric> Note:
This is a Primary Key. |
| created_at | string <timestamp with time zone> |
| last_updated_at | string <timestamp with time zone> |
| integrator | string <text> |
| total_filled | number <numeric> |
| remaining_size | number <numeric> |
| order_status | string <public.order_status> Enum: "open" "closed" "cancelled" |
| order_type | string <public.order_type> Enum: "limit" "market" "swap" |
| user | string <text> |
| direction | string <public.order_direction> Enum: "sell" "buy" "ask" "bid" |
| price | number <numeric> |
| average_execution_price | number <numeric> |
| custodian_id | number <numeric> |
| self_match_behavior | integer <smallint> |
| restriction | integer <smallint> |
| last_increase_stamp | number <numeric> |
| min_base | number <numeric> |
| max_base | number <numeric> |
| min_quote | number <numeric> |
| max_quote | number <numeric> |
| total_fees_paid_in_quote_subunits | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "order_id": 0,
- "created_at": "string",
- "last_updated_at": "string",
- "integrator": "string",
- "total_filled": 0,
- "remaining_size": 0,
- "order_status": "open",
- "order_type": "limit",
- "user": "string",
- "direction": "sell",
- "price": 0,
- "average_execution_price": 0,
- "custodian_id": 0,
- "self_match_behavior": 0,
- "restriction": 0,
- "last_increase_stamp": 0,
- "min_base": 0,
- "max_base": 0,
- "min_quote": 0,
- "max_quote": 0,
- "total_fees_paid_in_quote_subunits": 0
}/orders
query Parameters
| market_id | string <numeric> |
| order_id | string <numeric> |
| created_at | string <timestamp with time zone> |
| last_updated_at | string <timestamp with time zone> |
| integrator | string <text> |
| total_filled | string <numeric> |
| remaining_size | string <numeric> |
| order_status | string <public.order_status> |
| order_type | string <public.order_type> |
| user | string <text> |
| direction | string <public.order_direction> |
| price | string <numeric> |
| average_execution_price | string <numeric> |
| custodian_id | string <numeric> |
| self_match_behavior | string <smallint> |
| restriction | string <smallint> |
| last_increase_stamp | string <numeric> |
| min_base | string <numeric> |
| max_base | string <numeric> |
| min_quote | string <numeric> |
| max_quote | string <numeric> |
| total_fees_paid_in_quote_subunits | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/orders
query Parameters
| market_id | string <numeric> |
| order_id | string <numeric> |
| created_at | string <timestamp with time zone> |
| last_updated_at | string <timestamp with time zone> |
| integrator | string <text> |
| total_filled | string <numeric> |
| remaining_size | string <numeric> |
| order_status | string <public.order_status> |
| order_type | string <public.order_type> |
| user | string <text> |
| direction | string <public.order_direction> |
| price | string <numeric> |
| average_execution_price | string <numeric> |
| custodian_id | string <numeric> |
| self_match_behavior | string <smallint> |
| restriction | string <smallint> |
| last_increase_stamp | string <numeric> |
| min_base | string <numeric> |
| max_base | string <numeric> |
| min_quote | string <numeric> |
| max_quote | string <numeric> |
| total_fees_paid_in_quote_subunits | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
orders
| market_id | number <numeric> Note:
This is a Primary Key. |
| order_id | number <numeric> Note:
This is a Primary Key. |
| created_at | string <timestamp with time zone> |
| last_updated_at | string <timestamp with time zone> |
| integrator | string <text> |
| total_filled | number <numeric> |
| remaining_size | number <numeric> |
| order_status | string <public.order_status> Enum: "open" "closed" "cancelled" |
| order_type | string <public.order_type> Enum: "limit" "market" "swap" |
| user | string <text> |
| direction | string <public.order_direction> Enum: "sell" "buy" "ask" "bid" |
| price | number <numeric> |
| average_execution_price | number <numeric> |
| custodian_id | number <numeric> |
| self_match_behavior | integer <smallint> |
| restriction | integer <smallint> |
| last_increase_stamp | number <numeric> |
| min_base | number <numeric> |
| max_base | number <numeric> |
| min_quote | number <numeric> |
| max_quote | number <numeric> |
| total_fees_paid_in_quote_subunits | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "order_id": 0,
- "created_at": "string",
- "last_updated_at": "string",
- "integrator": "string",
- "total_filled": 0,
- "remaining_size": 0,
- "order_status": "open",
- "order_type": "limit",
- "user": "string",
- "direction": "sell",
- "price": 0,
- "average_execution_price": 0,
- "custodian_id": 0,
- "self_match_behavior": 0,
- "restriction": 0,
- "last_increase_stamp": 0,
- "min_base": 0,
- "max_base": 0,
- "min_quote": 0,
- "max_quote": 0,
- "total_fees_paid_in_quote_subunits": 0
}/tvl_per_market
query Parameters
| base_value | string <numeric> |
| quote_value | string <numeric> |
| market_id | string <numeric> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| base_name | string <text> |
| base_symbol | string <text> |
| base_decimals | string <smallint> |
| quote_name | string <text> |
| quote_symbol | string <text> |
| quote_decimals | string <smallint> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "base_value": 0,
- "quote_value": 0,
- "market_id": 0,
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "base_name": "string",
- "base_symbol": "string",
- "base_decimals": 0,
- "quote_name": "string",
- "quote_symbol": "string",
- "quote_decimals": 0
}
]/place_market_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| integrator | string <character varying> |
| direction | string <text> |
| size | string <numeric> |
| self_match_behavior | string <smallint> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "user": "string",
- "custodian_id": 0,
- "integrator": "string",
- "direction": "string",
- "size": 0,
- "self_match_behavior": 0
}
]/place_market_order_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
place_market_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| order_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| integrator | string <character varying> <= 70 characters |
| direction | string <text> |
| size | number <numeric> |
| self_match_behavior | integer <smallint> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "user": "string",
- "custodian_id": 0,
- "integrator": "string",
- "direction": "string",
- "size": 0,
- "self_match_behavior": 0
}/place_market_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| integrator | string <character varying> |
| direction | string <text> |
| size | string <numeric> |
| self_match_behavior | string <smallint> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/place_market_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| integrator | string <character varying> |
| direction | string <text> |
| size | string <numeric> |
| self_match_behavior | string <smallint> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
place_market_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| order_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| integrator | string <character varying> <= 70 characters |
| direction | string <text> |
| size | number <numeric> |
| self_match_behavior | integer <smallint> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "user": "string",
- "custodian_id": 0,
- "integrator": "string",
- "direction": "string",
- "size": 0,
- "self_match_behavior": 0
}/place_limit_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| order_id | string <numeric> |
| side | string <boolean> |
| integrator | string <character varying> |
| initial_size | string <numeric> |
| price | string <numeric> |
| restriction | string <smallint> |
| self_match_behavior | string <smallint> |
| size | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "market_id": 0,
- "user": "string",
- "custodian_id": 0,
- "order_id": 0,
- "side": true,
- "integrator": "string",
- "initial_size": 0,
- "price": 0,
- "restriction": 0,
- "self_match_behavior": 0,
- "size": 0
}
]/place_limit_order_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
place_limit_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| market_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| order_id | number <numeric> |
| side | boolean <boolean> |
| integrator | string <character varying> <= 70 characters |
| initial_size | number <numeric> |
| price | number <numeric> |
| restriction | integer <smallint> |
| self_match_behavior | integer <smallint> |
| size | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "market_id": 0,
- "user": "string",
- "custodian_id": 0,
- "order_id": 0,
- "side": true,
- "integrator": "string",
- "initial_size": 0,
- "price": 0,
- "restriction": 0,
- "self_match_behavior": 0,
- "size": 0
}/place_limit_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| order_id | string <numeric> |
| side | string <boolean> |
| integrator | string <character varying> |
| initial_size | string <numeric> |
| price | string <numeric> |
| restriction | string <smallint> |
| self_match_behavior | string <smallint> |
| size | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/place_limit_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| order_id | string <numeric> |
| side | string <boolean> |
| integrator | string <character varying> |
| initial_size | string <numeric> |
| price | string <numeric> |
| restriction | string <smallint> |
| self_match_behavior | string <smallint> |
| size | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
place_limit_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| market_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| order_id | number <numeric> |
| side | boolean <boolean> |
| integrator | string <character varying> <= 70 characters |
| initial_size | number <numeric> |
| price | number <numeric> |
| restriction | integer <smallint> |
| self_match_behavior | integer <smallint> |
| size | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "market_id": 0,
- "user": "string",
- "custodian_id": 0,
- "order_id": 0,
- "side": true,
- "integrator": "string",
- "initial_size": 0,
- "price": 0,
- "restriction": 0,
- "self_match_behavior": 0,
- "size": 0
}/candlesticks_last_indexed_txn
query Parameters
| resolution | string <integer> |
| txn_version | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "resolution": 0,
- "txn_version": 0
}
]/candlesticks_last_indexed_txn
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
candlesticks_last_indexed_txn
| resolution | integer <integer> Note:
This is a Primary Key. |
| txn_version | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "resolution": 0,
- "txn_version": 0
}/candlesticks_last_indexed_txn
query Parameters
| resolution | string <integer> |
| txn_version | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
candlesticks_last_indexed_txn
| resolution | integer <integer> Note:
This is a Primary Key. |
| txn_version | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "resolution": 0,
- "txn_version": 0
}/market_account_handles
query Parameters
| user | string <character varying> |
| handle | string <character varying> |
| creation_time | string <timestamp with time zone> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "user": "string",
- "handle": "string",
- "creation_time": "string"
}
]/market_account_handles
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
market_account_handles
| user | string <character varying> <= 70 characters Note:
This is a Primary Key. |
| handle | string <character varying> <= 70 characters |
| creation_time | string <timestamp with time zone> |
Responses
Request samples
- Payload
Content type
{- "user": "string",
- "handle": "string",
- "creation_time": "string"
}/market_account_handles
query Parameters
| user | string <character varying> |
| handle | string <character varying> |
| creation_time | string <timestamp with time zone> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
market_account_handles
| user | string <character varying> <= 70 characters Note:
This is a Primary Key. |
| handle | string <character varying> <= 70 characters |
| creation_time | string <timestamp with time zone> |
Responses
Request samples
- Payload
Content type
{- "user": "string",
- "handle": "string",
- "creation_time": "string"
}/balance_updates
query Parameters
| time | string <timestamp with time zone> |
| txn_version | string <numeric> |
| user | string <character varying> |
| market_id | string <numeric> |
| custodian_id | string <numeric> |
| base_total | string <numeric> |
| base_available | string <numeric> |
| base_ceiling | string <numeric> |
| quote_total | string <numeric> |
| quote_available | string <numeric> |
| quote_ceiling | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "time": "string",
- "txn_version": 0,
- "user": "string",
- "market_id": 0,
- "custodian_id": 0,
- "base_total": 0,
- "base_available": 0,
- "base_ceiling": 0,
- "quote_total": 0,
- "quote_available": 0,
- "quote_ceiling": 0
}
]/competition_leaderboard_users
query Parameters
| user | string <text> |
| volume | string <numeric> |
| integrators_used | string <text[]> |
| n_trades | string <integer> |
| points | string <numeric> |
| competition_id | string <integer> |
| rank | string <bigint> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "user": "string",
- "volume": 0,
- "integrators_used": [
- "string"
], - "n_trades": 0,
- "points": 0,
- "competition_id": 0,
- "rank": 0
}
]/fill_events_deduped
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| emit_address | string <character varying> |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> |
| maker_custodian_id | string <numeric> |
| maker_order_id | string <numeric> |
| maker_side | string <boolean> |
| market_id | string <numeric> |
| price | string <numeric> |
| sequence_number_for_trade | string <numeric> |
| size | string <numeric> |
| taker_address | string <character varying> |
| taker_custodian_id | string <numeric> |
| taker_order_id | string <numeric> |
| taker_quote_fees_paid | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "emit_address": "string",
- "time": "string",
- "maker_address": "string",
- "maker_custodian_id": 0,
- "maker_order_id": 0,
- "maker_side": true,
- "market_id": 0,
- "price": 0,
- "sequence_number_for_trade": 0,
- "size": 0,
- "taker_address": "string",
- "taker_custodian_id": 0,
- "taker_order_id": 0,
- "taker_quote_fees_paid": 0
}
]/fill_events_deduped
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
fill_events_deduped
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| emit_address | string <character varying> <= 70 characters |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> <= 70 characters |
| maker_custodian_id | number <numeric> |
| maker_order_id | number <numeric> |
| maker_side | boolean <boolean> |
| market_id | number <numeric> |
| price | number <numeric> |
| sequence_number_for_trade | number <numeric> |
| size | number <numeric> |
| taker_address | string <character varying> <= 70 characters |
| taker_custodian_id | number <numeric> |
| taker_order_id | number <numeric> |
| taker_quote_fees_paid | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "emit_address": "string",
- "time": "string",
- "maker_address": "string",
- "maker_custodian_id": 0,
- "maker_order_id": 0,
- "maker_side": true,
- "market_id": 0,
- "price": 0,
- "sequence_number_for_trade": 0,
- "size": 0,
- "taker_address": "string",
- "taker_custodian_id": 0,
- "taker_order_id": 0,
- "taker_quote_fees_paid": 0
}/fill_events_deduped
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| emit_address | string <character varying> |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> |
| maker_custodian_id | string <numeric> |
| maker_order_id | string <numeric> |
| maker_side | string <boolean> |
| market_id | string <numeric> |
| price | string <numeric> |
| sequence_number_for_trade | string <numeric> |
| size | string <numeric> |
| taker_address | string <character varying> |
| taker_custodian_id | string <numeric> |
| taker_order_id | string <numeric> |
| taker_quote_fees_paid | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/fill_events_deduped
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| emit_address | string <character varying> |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> |
| maker_custodian_id | string <numeric> |
| maker_order_id | string <numeric> |
| maker_side | string <boolean> |
| market_id | string <numeric> |
| price | string <numeric> |
| sequence_number_for_trade | string <numeric> |
| size | string <numeric> |
| taker_address | string <character varying> |
| taker_custodian_id | string <numeric> |
| taker_order_id | string <numeric> |
| taker_quote_fees_paid | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
fill_events_deduped
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| emit_address | string <character varying> <= 70 characters |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> <= 70 characters |
| maker_custodian_id | number <numeric> |
| maker_order_id | number <numeric> |
| maker_side | boolean <boolean> |
| market_id | number <numeric> |
| price | number <numeric> |
| sequence_number_for_trade | number <numeric> |
| size | number <numeric> |
| taker_address | string <character varying> <= 70 characters |
| taker_custodian_id | number <numeric> |
| taker_order_id | number <numeric> |
| taker_quote_fees_paid | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "emit_address": "string",
- "time": "string",
- "maker_address": "string",
- "maker_custodian_id": 0,
- "maker_order_id": 0,
- "maker_side": true,
- "market_id": 0,
- "price": 0,
- "sequence_number_for_trade": 0,
- "size": 0,
- "taker_address": "string",
- "taker_custodian_id": 0,
- "taker_order_id": 0,
- "taker_quote_fees_paid": 0
}/competition_metadata
query Parameters
| id | string <integer> |
| start | string <timestamp with time zone> |
| end | string <timestamp with time zone> |
| prize | string <integer> |
| market_id | string <numeric> |
| integrators_required | string <text[]> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "id": 0,
- "start": "string",
- "end": "string",
- "prize": 0,
- "market_id": 0,
- "integrators_required": [
- "string"
]
}
]/competition_metadata
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
competition_metadata
| id | integer <integer> Note:
This is a Primary Key. |
| start | string <timestamp with time zone> |
| end | string <timestamp with time zone> |
| prize | integer <integer> |
| market_id | number <numeric> |
| integrators_required | Array of strings |
Responses
Request samples
- Payload
Content type
{- "id": 0,
- "start": "string",
- "end": "string",
- "prize": 0,
- "market_id": 0,
- "integrators_required": [
- "string"
]
}/competition_metadata
query Parameters
| id | string <integer> |
| start | string <timestamp with time zone> |
| end | string <timestamp with time zone> |
| prize | string <integer> |
| market_id | string <numeric> |
| integrators_required | string <text[]> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/competition_metadata
query Parameters
| id | string <integer> |
| start | string <timestamp with time zone> |
| end | string <timestamp with time zone> |
| prize | string <integer> |
| market_id | string <numeric> |
| integrators_required | string <text[]> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
competition_metadata
| id | integer <integer> Note:
This is a Primary Key. |
| start | string <timestamp with time zone> |
| end | string <timestamp with time zone> |
| prize | integer <integer> |
| market_id | number <numeric> |
| integrators_required | Array of strings |
Responses
Request samples
- Payload
Content type
{- "id": 0,
- "start": "string",
- "end": "string",
- "prize": 0,
- "market_id": 0,
- "integrators_required": [
- "string"
]
}/recognized_market_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| market_id | string <numeric> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "market_id": 0,
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0
}
]/recognized_market_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
recognized_market_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> <= 70 characters |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> <= 70 characters |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| market_id | number <numeric> |
| lot_size | number <numeric> |
| tick_size | number <numeric> |
| min_size | number <numeric> |
| underwriter_id | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "market_id": 0,
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0
}/recognized_market_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| market_id | string <numeric> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/recognized_market_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| market_id | string <numeric> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
recognized_market_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> <= 70 characters |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> <= 70 characters |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| market_id | number <numeric> |
| lot_size | number <numeric> |
| tick_size | number <numeric> |
| min_size | number <numeric> |
| underwriter_id | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "market_id": 0,
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0
}/liquidity_groups
query Parameters
| group_id | string <integer> |
| name | string <text> |
| market_id | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "group_id": 0,
- "name": "string",
- "market_id": 0
}
]/liquidity_groups
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
liquidity_groups
| group_id | integer <integer> Note:
This is a Primary Key. |
| name | string <text> |
| market_id | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "group_id": 0,
- "name": "string",
- "market_id": 0
}/liquidity_groups
query Parameters
| group_id | string <integer> |
| name | string <text> |
| market_id | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
liquidity_groups
| group_id | integer <integer> Note:
This is a Primary Key. |
| name | string <text> |
| market_id | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "group_id": 0,
- "name": "string",
- "market_id": 0
}/balance_updates_by_handle
query Parameters
| txn_version | string <numeric> |
| handle | string <character varying> |
| market_id | string <numeric> |
| custodian_id | string <numeric> |
| time | string <timestamp with time zone> |
| base_total | string <numeric> |
| base_available | string <numeric> |
| base_ceiling | string <numeric> |
| quote_total | string <numeric> |
| quote_available | string <numeric> |
| quote_ceiling | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "handle": "string",
- "market_id": 0,
- "custodian_id": 0,
- "time": "string",
- "base_total": 0,
- "base_available": 0,
- "base_ceiling": 0,
- "quote_total": 0,
- "quote_available": 0,
- "quote_ceiling": 0
}
]/balance_updates_by_handle
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
balance_updates_by_handle
| txn_version | number <numeric> Note:
This is a Primary Key. |
| handle | string <character varying> <= 70 characters Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| custodian_id | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| base_total | number <numeric> |
| base_available | number <numeric> |
| base_ceiling | number <numeric> |
| quote_total | number <numeric> |
| quote_available | number <numeric> |
| quote_ceiling | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "handle": "string",
- "market_id": 0,
- "custodian_id": 0,
- "time": "string",
- "base_total": 0,
- "base_available": 0,
- "base_ceiling": 0,
- "quote_total": 0,
- "quote_available": 0,
- "quote_ceiling": 0
}/balance_updates_by_handle
query Parameters
| txn_version | string <numeric> |
| handle | string <character varying> |
| market_id | string <numeric> |
| custodian_id | string <numeric> |
| time | string <timestamp with time zone> |
| base_total | string <numeric> |
| base_available | string <numeric> |
| base_ceiling | string <numeric> |
| quote_total | string <numeric> |
| quote_available | string <numeric> |
| quote_ceiling | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/balance_updates_by_handle
query Parameters
| txn_version | string <numeric> |
| handle | string <character varying> |
| market_id | string <numeric> |
| custodian_id | string <numeric> |
| time | string <timestamp with time zone> |
| base_total | string <numeric> |
| base_available | string <numeric> |
| base_ceiling | string <numeric> |
| quote_total | string <numeric> |
| quote_available | string <numeric> |
| quote_ceiling | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
balance_updates_by_handle
| txn_version | number <numeric> Note:
This is a Primary Key. |
| handle | string <character varying> <= 70 characters Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| custodian_id | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| base_total | number <numeric> |
| base_available | number <numeric> |
| base_ceiling | number <numeric> |
| quote_total | number <numeric> |
| quote_available | number <numeric> |
| quote_ceiling | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "handle": "string",
- "market_id": 0,
- "custodian_id": 0,
- "time": "string",
- "base_total": 0,
- "base_available": 0,
- "base_ceiling": 0,
- "quote_total": 0,
- "quote_available": 0,
- "quote_ceiling": 0
}/fees
query Parameters
| start_time_1hr_period | string <timestamp with time zone> |
| market_id | string <numeric> |
| fees_in_quote_subunits | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "start_time_1hr_period": "string",
- "market_id": 0,
- "fees_in_quote_subunits": 0
}
]/fees
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
fees
| start_time_1hr_period | string <timestamp with time zone> Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| fees_in_quote_subunits | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "start_time_1hr_period": "string",
- "market_id": 0,
- "fees_in_quote_subunits": 0
}/fees
query Parameters
| start_time_1hr_period | string <timestamp with time zone> |
| market_id | string <numeric> |
| fees_in_quote_subunits | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
fees
| start_time_1hr_period | string <timestamp with time zone> Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| fees_in_quote_subunits | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "start_time_1hr_period": "string",
- "market_id": 0,
- "fees_in_quote_subunits": 0
}/prices
query Parameters
| market_id | string <numeric> |
| start_time_1m_period | string <timestamp with time zone> |
| price | string <numeric> |
| sum_fill_size_1m_period | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "start_time_1m_period": "string",
- "price": 0,
- "sum_fill_size_1m_period": 0
}
]/prices
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
prices
| market_id | number <numeric> Note:
This is a Primary Key. |
| start_time_1m_period | string <timestamp with time zone> Note:
This is a Primary Key. |
| price | number <numeric> |
| sum_fill_size_1m_period | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "start_time_1m_period": "string",
- "price": 0,
- "sum_fill_size_1m_period": 0
}/prices
query Parameters
| market_id | string <numeric> |
| start_time_1m_period | string <timestamp with time zone> |
| price | string <numeric> |
| sum_fill_size_1m_period | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
prices
| market_id | number <numeric> Note:
This is a Primary Key. |
| start_time_1m_period | string <timestamp with time zone> Note:
This is a Primary Key. |
| price | number <numeric> |
| sum_fill_size_1m_period | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "start_time_1m_period": "string",
- "price": 0,
- "sum_fill_size_1m_period": 0
}/spreads
query Parameters
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| min_ask | string <numeric> |
| max_bid | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "time": "string",
- "min_ask": 0,
- "max_bid": 0
}
]/spreads
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
spreads
| market_id | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> Note:
This is a Primary Key. |
| min_ask | number <numeric> |
| max_bid | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "time": "string",
- "min_ask": 0,
- "max_bid": 0
}/spreads
query Parameters
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| min_ask | string <numeric> |
| max_bid | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
spreads
| market_id | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> Note:
This is a Primary Key. |
| min_ask | number <numeric> |
| max_bid | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "time": "string",
- "min_ask": 0,
- "max_bid": 0
}/coins
query Parameters
| name | string <text> |
| symbol | string <text> |
| decimals | string <smallint> |
| address | string <text> |
| module | string <text> |
| struct | string <text> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "name": "string",
- "symbol": "string",
- "decimals": 0,
- "address": "string",
- "module": "string",
- "struct": "string"
}
]/coins
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
coins
| name | string <text> |
| symbol | string <text> |
| decimals | integer <smallint> |
| address | string <text> Note:
This is a Primary Key. |
| module | string <text> Note:
This is a Primary Key. |
| struct | string <text> Note:
This is a Primary Key. |
Responses
Request samples
- Payload
Content type
{- "name": "string",
- "symbol": "string",
- "decimals": 0,
- "address": "string",
- "module": "string",
- "struct": "string"
}/coins
query Parameters
| name | string <text> |
| symbol | string <text> |
| decimals | string <smallint> |
| address | string <text> |
| module | string <text> |
| struct | string <text> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
coins
| name | string <text> |
| symbol | string <text> |
| decimals | integer <smallint> |
| address | string <text> Note:
This is a Primary Key. |
| module | string <text> Note:
This is a Primary Key. |
| struct | string <text> Note:
This is a Primary Key. |
Responses
Request samples
- Payload
Content type
{- "name": "string",
- "symbol": "string",
- "decimals": 0,
- "address": "string",
- "module": "string",
- "struct": "string"
}/markets
query Parameters
| market_id | string <numeric> |
| registration_time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
| is_recognized | string <boolean> |
| last_fill_price_24hr | string <numeric> |
| price_change_as_percent_24hr | string <numeric> |
| price_change_24hr | string <numeric> |
| min_price_24h | string <numeric> |
| max_price_24h | string <numeric> |
| base_volume_24h | string <numeric> |
| quote_volume_24h | string <numeric> |
| base_name | string <text> |
| base_decimals | string <smallint> |
| base_symbol | string <text> |
| quote_name | string <text> |
| quote_decimals | string <smallint> |
| quote_symbol | string <text> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "registration_time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0,
- "is_recognized": true,
- "last_fill_price_24hr": 0,
- "price_change_as_percent_24hr": 0,
- "price_change_24hr": 0,
- "min_price_24h": 0,
- "max_price_24h": 0,
- "base_volume_24h": 0,
- "quote_volume_24h": 0,
- "base_name": "string",
- "base_decimals": 0,
- "base_symbol": "string",
- "quote_name": "string",
- "quote_decimals": 0,
- "quote_symbol": "string"
}
]/data_status
query Parameters
| current_time | string <timestamp with time zone> |
| processor_last_txn_timestamp_processed | string <timestamp without time zone> |
| processor_last_txn_version_processed | string <bigint> |
| aggregator_user_history_last_txn_version_processed | string <numeric> |
| aggregator_candlesticks_last_txn_version_processed | string <numeric[]> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "current_time": "string",
- "processor_last_txn_timestamp_processed": "string",
- "processor_last_txn_version_processed": 0,
- "aggregator_user_history_last_txn_version_processed": 0,
- "aggregator_candlesticks_last_txn_version_processed": [
- 0
]
}
]/historical_trades
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| integer_price_to_quote_nominal | string <numeric> |
| base_volume | string <numeric> |
| quote_volume | string <numeric> |
| type | string <text> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "integer_price_to_quote_nominal": 0,
- "base_volume": 0,
- "quote_volume": 0,
- "type": "string"
}
]/historical_trades
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
historical_trades
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| integer_price_to_quote_nominal | number <numeric> |
| base_volume | number <numeric> |
| quote_volume | number <numeric> |
| type | string <text> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "integer_price_to_quote_nominal": 0,
- "base_volume": 0,
- "quote_volume": 0,
- "type": "string"
}/historical_trades
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| integer_price_to_quote_nominal | string <numeric> |
| base_volume | string <numeric> |
| quote_volume | string <numeric> |
| type | string <text> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/historical_trades
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| integer_price_to_quote_nominal | string <numeric> |
| base_volume | string <numeric> |
| quote_volume | string <numeric> |
| type | string <text> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
historical_trades
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| integer_price_to_quote_nominal | number <numeric> |
| base_volume | number <numeric> |
| quote_volume | number <numeric> |
| type | string <text> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "integer_price_to_quote_nominal": 0,
- "base_volume": 0,
- "quote_volume": 0,
- "type": "string"
}/place_swap_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| signing_account | string <character varying> |
| integrator | string <character varying> |
| direction | string <text> |
| min_base | string <numeric> |
| max_base | string <numeric> |
| min_quote | string <numeric> |
| max_quote | string <numeric> |
| limit_price | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "signing_account": "string",
- "integrator": "string",
- "direction": "string",
- "min_base": 0,
- "max_base": 0,
- "min_quote": 0,
- "max_quote": 0,
- "limit_price": 0
}
]/place_swap_order_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
place_swap_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| order_id | number <numeric> |
| signing_account | string <character varying> <= 70 characters |
| integrator | string <character varying> <= 70 characters |
| direction | string <text> |
| min_base | number <numeric> |
| max_base | number <numeric> |
| min_quote | number <numeric> |
| max_quote | number <numeric> |
| limit_price | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "signing_account": "string",
- "integrator": "string",
- "direction": "string",
- "min_base": 0,
- "max_base": 0,
- "min_quote": 0,
- "max_quote": 0,
- "limit_price": 0
}/place_swap_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| signing_account | string <character varying> |
| integrator | string <character varying> |
| direction | string <text> |
| min_base | string <numeric> |
| max_base | string <numeric> |
| min_quote | string <numeric> |
| max_quote | string <numeric> |
| limit_price | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/place_swap_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| signing_account | string <character varying> |
| integrator | string <character varying> |
| direction | string <text> |
| min_base | string <numeric> |
| max_base | string <numeric> |
| min_quote | string <numeric> |
| max_quote | string <numeric> |
| limit_price | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
place_swap_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| order_id | number <numeric> |
| signing_account | string <character varying> <= 70 characters |
| integrator | string <character varying> <= 70 characters |
| direction | string <text> |
| min_base | number <numeric> |
| max_base | number <numeric> |
| min_quote | number <numeric> |
| max_quote | number <numeric> |
| limit_price | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "signing_account": "string",
- "integrator": "string",
- "direction": "string",
- "min_base": 0,
- "max_base": 0,
- "min_quote": 0,
- "max_quote": 0,
- "limit_price": 0
}/change_order_size_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| side | string <boolean> |
| new_size | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "user": "string",
- "custodian_id": 0,
- "side": true,
- "new_size": 0
}
]/change_order_size_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
change_order_size_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| order_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| side | boolean <boolean> |
| new_size | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "user": "string",
- "custodian_id": 0,
- "side": true,
- "new_size": 0
}/change_order_size_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| side | string <boolean> |
| new_size | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/change_order_size_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| order_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| side | string <boolean> |
| new_size | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
change_order_size_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> |
| time | string <timestamp with time zone> |
| order_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| side | boolean <boolean> |
| new_size | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "market_id": 0,
- "time": "string",
- "order_id": 0,
- "user": "string",
- "custodian_id": 0,
- "side": true,
- "new_size": 0
}/liquidity
query Parameters
| group_id | string <integer> |
| time | string <timestamp with time zone> |
| bps_times_ten | string <smallint> |
| amount_ask_ticks | string <numeric> |
| amount_bid_ticks | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "group_id": 0,
- "time": "string",
- "bps_times_ten": 0,
- "amount_ask_ticks": 0,
- "amount_bid_ticks": 0
}
]/liquidity
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
liquidity
| group_id | integer <integer> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> Note:
This is a Primary Key. |
| bps_times_ten | integer <smallint> Note:
This is a Primary Key. |
| amount_ask_ticks | number <numeric> |
| amount_bid_ticks | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "group_id": 0,
- "time": "string",
- "bps_times_ten": 0,
- "amount_ask_ticks": 0,
- "amount_bid_ticks": 0
}/liquidity
query Parameters
| group_id | string <integer> |
| time | string <timestamp with time zone> |
| bps_times_ten | string <smallint> |
| amount_ask_ticks | string <numeric> |
| amount_bid_ticks | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
liquidity
| group_id | integer <integer> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> Note:
This is a Primary Key. |
| bps_times_ten | integer <smallint> Note:
This is a Primary Key. |
| amount_ask_ticks | number <numeric> |
| amount_bid_ticks | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "group_id": 0,
- "time": "string",
- "bps_times_ten": 0,
- "amount_ask_ticks": 0,
- "amount_bid_ticks": 0
}/price_levels
query Parameters
| market_id | string <numeric> |
| direction | string <public.order_direction> |
| price | string <numeric> |
| total_size | string <numeric> |
| version | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "direction": "sell",
- "price": 0,
- "total_size": 0,
- "version": 0
}
]/cancel_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| order_id | string <numeric> |
| reason | string <smallint> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "market_id": 0,
- "user": "string",
- "custodian_id": 0,
- "order_id": 0,
- "reason": 0
}
]/cancel_order_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
cancel_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| market_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| order_id | number <numeric> |
| reason | integer <smallint> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "market_id": 0,
- "user": "string",
- "custodian_id": 0,
- "order_id": 0,
- "reason": 0
}/cancel_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| order_id | string <numeric> |
| reason | string <smallint> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/cancel_order_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| user | string <character varying> |
| custodian_id | string <numeric> |
| order_id | string <numeric> |
| reason | string <smallint> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
cancel_order_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| time | string <timestamp with time zone> |
| market_id | number <numeric> |
| user | string <character varying> <= 70 characters |
| custodian_id | number <numeric> |
| order_id | number <numeric> |
| reason | integer <smallint> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "time": "string",
- "market_id": 0,
- "user": "string",
- "custodian_id": 0,
- "order_id": 0,
- "reason": 0
}/fill_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| emit_address | string <character varying> |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> |
| maker_custodian_id | string <numeric> |
| maker_order_id | string <numeric> |
| maker_side | string <boolean> |
| market_id | string <numeric> |
| price | string <numeric> |
| sequence_number_for_trade | string <numeric> |
| size | string <numeric> |
| taker_address | string <character varying> |
| taker_custodian_id | string <numeric> |
| taker_order_id | string <numeric> |
| taker_quote_fees_paid | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0,
- "event_idx": 0,
- "emit_address": "string",
- "time": "string",
- "maker_address": "string",
- "maker_custodian_id": 0,
- "maker_order_id": 0,
- "maker_side": true,
- "market_id": 0,
- "price": 0,
- "sequence_number_for_trade": 0,
- "size": 0,
- "taker_address": "string",
- "taker_custodian_id": 0,
- "taker_order_id": 0,
- "taker_quote_fees_paid": 0
}
]/fill_events
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
fill_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| emit_address | string <character varying> <= 70 characters |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> <= 70 characters |
| maker_custodian_id | number <numeric> |
| maker_order_id | number <numeric> |
| maker_side | boolean <boolean> |
| market_id | number <numeric> |
| price | number <numeric> |
| sequence_number_for_trade | number <numeric> |
| size | number <numeric> |
| taker_address | string <character varying> <= 70 characters |
| taker_custodian_id | number <numeric> |
| taker_order_id | number <numeric> |
| taker_quote_fees_paid | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "emit_address": "string",
- "time": "string",
- "maker_address": "string",
- "maker_custodian_id": 0,
- "maker_order_id": 0,
- "maker_side": true,
- "market_id": 0,
- "price": 0,
- "sequence_number_for_trade": 0,
- "size": 0,
- "taker_address": "string",
- "taker_custodian_id": 0,
- "taker_order_id": 0,
- "taker_quote_fees_paid": 0
}/fill_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| emit_address | string <character varying> |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> |
| maker_custodian_id | string <numeric> |
| maker_order_id | string <numeric> |
| maker_side | string <boolean> |
| market_id | string <numeric> |
| price | string <numeric> |
| sequence_number_for_trade | string <numeric> |
| size | string <numeric> |
| taker_address | string <character varying> |
| taker_custodian_id | string <numeric> |
| taker_order_id | string <numeric> |
| taker_quote_fees_paid | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/fill_events
query Parameters
| txn_version | string <numeric> |
| event_idx | string <numeric> |
| emit_address | string <character varying> |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> |
| maker_custodian_id | string <numeric> |
| maker_order_id | string <numeric> |
| maker_side | string <boolean> |
| market_id | string <numeric> |
| price | string <numeric> |
| sequence_number_for_trade | string <numeric> |
| size | string <numeric> |
| taker_address | string <character varying> |
| taker_custodian_id | string <numeric> |
| taker_order_id | string <numeric> |
| taker_quote_fees_paid | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
fill_events
| txn_version | number <numeric> Note:
This is a Primary Key. |
| event_idx | number <numeric> Note:
This is a Primary Key. |
| emit_address | string <character varying> <= 70 characters |
| time | string <timestamp with time zone> |
| maker_address | string <character varying> <= 70 characters |
| maker_custodian_id | number <numeric> |
| maker_order_id | number <numeric> |
| maker_side | boolean <boolean> |
| market_id | number <numeric> |
| price | number <numeric> |
| sequence_number_for_trade | number <numeric> |
| size | number <numeric> |
| taker_address | string <character varying> <= 70 characters |
| taker_custodian_id | number <numeric> |
| taker_order_id | number <numeric> |
| taker_quote_fees_paid | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0,
- "event_idx": 0,
- "emit_address": "string",
- "time": "string",
- "maker_address": "string",
- "maker_custodian_id": 0,
- "maker_order_id": 0,
- "maker_side": true,
- "market_id": 0,
- "price": 0,
- "sequence_number_for_trade": 0,
- "size": 0,
- "taker_address": "string",
- "taker_custodian_id": 0,
- "taker_order_id": 0,
- "taker_quote_fees_paid": 0
}/tvl_per_asset
query Parameters
| address | string <character varying> |
| module | string <text> |
| struct | string <text> |
| value | string <numeric> |
| coin_name_generic | string <text> |
| market_id | string <numeric> |
| name | string <text> |
| symbol | string <text> |
| decimals | string <smallint> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "address": "string",
- "module": "string",
- "struct": "string",
- "value": 0,
- "coin_name_generic": "string",
- "market_id": 0,
- "name": "string",
- "symbol": "string",
- "decimals": 0
}
]/user_balances
query Parameters
| address | string <text> |
| custodian_id | string <numeric> |
| market_id | string <numeric> |
| handle | string <text> |
| base_total | string <numeric> |
| base_available | string <numeric> |
| base_ceiling | string <numeric> |
| quote_total | string <numeric> |
| quote_available | string <numeric> |
| quote_ceiling | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "address": "string",
- "custodian_id": 0,
- "market_id": 0,
- "handle": "string",
- "base_total": 0,
- "base_available": 0,
- "base_ceiling": 0,
- "quote_total": 0,
- "quote_available": 0,
- "quote_ceiling": 0
}
]/user_balances
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
user_balances
| address | string <text> Note:
This is a Primary Key. |
| custodian_id | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| handle | string <text> |
| base_total | number <numeric> |
| base_available | number <numeric> |
| base_ceiling | number <numeric> |
| quote_total | number <numeric> |
| quote_available | number <numeric> |
| quote_ceiling | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "address": "string",
- "custodian_id": 0,
- "market_id": 0,
- "handle": "string",
- "base_total": 0,
- "base_available": 0,
- "base_ceiling": 0,
- "quote_total": 0,
- "quote_available": 0,
- "quote_ceiling": 0
}/user_balances
query Parameters
| address | string <text> |
| custodian_id | string <numeric> |
| market_id | string <numeric> |
| handle | string <text> |
| base_total | string <numeric> |
| base_available | string <numeric> |
| base_ceiling | string <numeric> |
| quote_total | string <numeric> |
| quote_available | string <numeric> |
| quote_ceiling | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/user_balances
query Parameters
| address | string <text> |
| custodian_id | string <numeric> |
| market_id | string <numeric> |
| handle | string <text> |
| base_total | string <numeric> |
| base_available | string <numeric> |
| base_ceiling | string <numeric> |
| quote_total | string <numeric> |
| quote_available | string <numeric> |
| quote_ceiling | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
user_balances
| address | string <text> Note:
This is a Primary Key. |
| custodian_id | number <numeric> Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| handle | string <text> |
| base_total | number <numeric> |
| base_available | number <numeric> |
| base_ceiling | number <numeric> |
| quote_total | number <numeric> |
| quote_available | number <numeric> |
| quote_ceiling | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "address": "string",
- "custodian_id": 0,
- "market_id": 0,
- "handle": "string",
- "base_total": 0,
- "base_available": 0,
- "base_ceiling": 0,
- "quote_total": 0,
- "quote_available": 0,
- "quote_ceiling": 0
}/fees_24h
query Parameters
| fees | string <numeric> |
| day | string <timestamp with time zone> |
| market_id | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "fees": 0,
- "day": "string",
- "market_id": 0
}
]/competition_exclusion_list
query Parameters
| user | string <text> |
| reason | string <text> |
| competition_id | string <integer> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "user": "string",
- "reason": "string",
- "competition_id": 0
}
]/competition_exclusion_list
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
competition_exclusion_list
| user | string <text> Note:
This is a Primary Key. |
| reason | string <text> |
| competition_id | integer <integer> Note:
This is a Primary Key. |
Responses
Request samples
- Payload
Content type
{- "user": "string",
- "reason": "string",
- "competition_id": 0
}/competition_exclusion_list
query Parameters
| user | string <text> |
| reason | string <text> |
| competition_id | string <integer> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
competition_exclusion_list
| user | string <text> Note:
This is a Primary Key. |
| reason | string <text> |
| competition_id | integer <integer> Note:
This is a Primary Key. |
Responses
Request samples
- Payload
Content type
{- "user": "string",
- "reason": "string",
- "competition_id": 0
}/daily_rolling_volume_history
query Parameters
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| volume_in_quote_subunits | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "time": "string",
- "market_id": 0,
- "volume_in_quote_subunits": 0
}
]/daily_rolling_volume_history
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
daily_rolling_volume_history
| time | string <timestamp with time zone> Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| volume_in_quote_subunits | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "time": "string",
- "market_id": 0,
- "volume_in_quote_subunits": 0
}/daily_rolling_volume_history
query Parameters
| time | string <timestamp with time zone> |
| market_id | string <numeric> |
| volume_in_quote_subunits | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
daily_rolling_volume_history
| time | string <timestamp with time zone> Note:
This is a Primary Key. |
| market_id | number <numeric> Note:
This is a Primary Key. |
| volume_in_quote_subunits | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "time": "string",
- "market_id": 0,
- "volume_in_quote_subunits": 0
}/candlestick_resolutions
query Parameters
| resolution | string <integer> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "resolution": 0
}
]/candlesticks
query Parameters
| market_id | string <numeric> |
| resolution | string <integer> |
| start_time | string <timestamp with time zone> |
| open | string <numeric> |
| high | string <numeric> |
| low | string <numeric> |
| close | string <numeric> |
| volume | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "resolution": 0,
- "start_time": "string",
- "open": 0,
- "high": 0,
- "low": 0,
- "close": 0,
- "volume": 0
}
]/candlesticks
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
candlesticks
| market_id | number <numeric> Note:
This is a Primary Key. |
| resolution | integer <integer> Note:
This is a Primary Key. |
| start_time | string <timestamp with time zone> Note:
This is a Primary Key. |
| open | number <numeric> |
| high | number <numeric> |
| low | number <numeric> |
| close | number <numeric> |
| volume | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "resolution": 0,
- "start_time": "string",
- "open": 0,
- "high": 0,
- "low": 0,
- "close": 0,
- "volume": 0
}/candlesticks
query Parameters
| market_id | string <numeric> |
| resolution | string <integer> |
| start_time | string <timestamp with time zone> |
| open | string <numeric> |
| high | string <numeric> |
| low | string <numeric> |
| close | string <numeric> |
| volume | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Responses
/candlesticks
query Parameters
| market_id | string <numeric> |
| resolution | string <integer> |
| start_time | string <timestamp with time zone> |
| open | string <numeric> |
| high | string <numeric> |
| low | string <numeric> |
| close | string <numeric> |
| volume | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
candlesticks
| market_id | number <numeric> Note:
This is a Primary Key. |
| resolution | integer <integer> Note:
This is a Primary Key. |
| start_time | string <timestamp with time zone> Note:
This is a Primary Key. |
| open | number <numeric> |
| high | number <numeric> |
| low | number <numeric> |
| close | number <numeric> |
| volume | number <numeric> |
Responses
Request samples
- Payload
Content type
{- "market_id": 0,
- "resolution": 0,
- "start_time": "string",
- "open": 0,
- "high": 0,
- "low": 0,
- "close": 0,
- "volume": 0
}/user_history_last_indexed_txn
query Parameters
| txn_version | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "txn_version": 0
}
]/user_history_last_indexed_txn
query Parameters
| select | string Filtering Columns |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates" Preference |
Request Body schema:
user_history_last_indexed_txn
| txn_version | number <numeric> Note:
This is a Primary Key. |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0
}/user_history_last_indexed_txn
query Parameters
| txn_version | string <numeric> |
header Parameters
| Prefer | string Enum: "return=representation" "return=minimal" "return=none" Preference |
Request Body schema:
user_history_last_indexed_txn
| txn_version | number <numeric> Note:
This is a Primary Key. |
Responses
Request samples
- Payload
Content type
{- "txn_version": 0
}/recognized_markets
query Parameters
| market_id | string <numeric> |
| time | string <timestamp with time zone> |
| base_account_address | string <character varying> |
| base_module_name | string <text> |
| base_struct_name | string <text> |
| base_name_generic | string <text> |
| quote_account_address | string <character varying> |
| quote_module_name | string <text> |
| quote_struct_name | string <text> |
| lot_size | string <numeric> |
| tick_size | string <numeric> |
| min_size | string <numeric> |
| underwriter_id | string <numeric> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "market_id": 0,
- "time": "string",
- "base_account_address": "string",
- "base_module_name": "string",
- "base_struct_name": "string",
- "base_name_generic": "string",
- "quote_account_address": "string",
- "quote_module_name": "string",
- "quote_struct_name": "string",
- "lot_size": 0,
- "tick_size": 0,
- "min_size": 0,
- "underwriter_id": 0
}
]/enumerated_volume_24h
query Parameters
| address | string <character varying> |
| module | string <text> |
| struct | string <text> |
| volume_as_base | string <numeric> |
| volume_as_quote | string <numeric> |
| generic_asset_name | string <text> |
| name | string <text> |
| symbol | string <text> |
| decimals | string <smallint> |
| select | string Filtering Columns |
| order | string Ordering |
| offset | string Limiting and Pagination |
| limit | string Limiting and Pagination |
header Parameters
| Range | string Limiting and Pagination |
| Range-Unit | string Default: items Limiting and Pagination |
| Prefer | string Value: "count=none" Preference |
Responses
Response samples
- 200
Content type
[- {
- "address": "string",
- "module": "string",
- "struct": "string",
- "volume_as_base": 0,
- "volume_as_quote": 0,
- "generic_asset_name": "string",
- "name": "string",
- "symbol": "string",
- "decimals": 0
}
]/rpc/user_balance
header Parameters
| Prefer | string Value: "params=single-object" Preference |
Request Body schema:
| custodian required | number <numeric> |
| market required | number <numeric> |
| user_address required | string <text> |
Responses
Request samples
- Payload
Content type
{- "custodian": 0,
- "market": 0,
- "user_address": "string"
}