Documentation / New API reference / OTC
Get OTC Contract V1 Listings
Reference
Last reviewed 2026-10-07
Paginated current OTC alpha listings.
Try it
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
listing_id | query | string | Filter by listing ID (exact match). | |
seller | query | string | Filter by seller (SS58 or 0x-hex; normalized to SS58). | |
hotkey | query | string | Filter by hotkey (SS58 or 0x-hex; normalized to SS58). | |
netuid | query | integer (int32) | Filter by subnet ID. | |
status | query | string | active, cancelled, taken, or all (default). | |
price_min | query | string | Minimum price (RAO, inclusive). | |
price_max | query | string | Maximum price (RAO, inclusive). | |
amount_min | query | string | Minimum amount (RAO, inclusive). | |
amount_max | query | string | Maximum amount (RAO, inclusive). | |
created_block_start | query | integer (int32) | Created-block range start (inclusive). | |
created_block_end | query | integer (int32) | Created-block range end (inclusive). | |
created_timestamp_start | query | integer (int64) | Created-time range start, Unix seconds (inclusive). | |
created_timestamp_end | query | integer (int64) | Created-time range end, Unix seconds (inclusive). | |
page | query | integer (int32) | Page number (1-indexed). Default: 1. Bounded window: (page − 1) × limit must be below 1,000,000. Deep OFFSET paging is linear in the offset, so an uncapped page lets one request scan tens of millions of rows; a page past the window is rejected with a 400. Reach deeper history with this endpoint's range filters (block_start/block_end, timestamp_start/timestamp_end) rather than a larger page. | |
limit | query | integer (int32) | Results per page. Default: 50. Max: 200. | |
order_by | query | string | Column to order by. Default: created_block. | |
order_dir | query | string | Sort direction. Default: desc. |
Responses
200 — Paginated list of OTC alpha listings
| Field | Type | Required | Description |
|---|---|---|---|
data | array | Yes | |
data[].amount | string | Yes | Alpha amount (RAO), as a decimal string. |
data[].created_block | integer (int32) | Yes | Block the listing was created in. |
data[].created_timestamp | string | Yes | Creation time, ISO 8601 with millisecond precision. |
data[].force_cancelled | boolean | Yes | Whether the listing was force-cancelled. |
data[].hotkey | string | Yes | Hotkey the alpha is staked to, SS58 address. |
data[].initiated_by | string, nullable | Account that initiated a cancellation, SS58 address (null otherwise). | |
data[].listing_id | string | Yes | Listing ID. |
data[].netuid | integer (int32) | Yes | Subnet ID. |
data[].price | string | Yes | Absolute price (RAO of TAO per whole alpha), as a decimal string. |
data[].seller | string | Yes | Seller coldkey, SS58 address. |
data[].status | string | Yes | active, cancelled, or taken. |
data[].updated_block | integer (int32) | Yes | Block of the last update. |
data[].updated_timestamp | string | Yes | Last-update time, ISO 8601 with millisecond precision. |
pagination | object | Yes | Pagination metadata appended to collection responses. next_page / prev_page are explicitly required+nullable in the OpenAPI spec: per docs/api_standards.md we emit null rather than omitting the field, so the SDK should model them as Option/nullable types that are always present in the response. total_items is the exact number of matching rows on every route (issue #992). It used to stop at 1,000,000, which reported a million transfers when finney holds 7,513,252 and a million events when the real figure is 981,179,110; the cap was removed on 29 Sep 2026 and nothing may reintroduce one — crate::pagination::exact_count_sql is the only count form, and no_capped_count_reaches_the_api_surface in data-debug-scripts fails the build if a capped one comes back. total_pages is still bounded, to crate::pagination::max_reachable_page(per_page), because the page parameter is capped to a 1,000,000-row window: deep OFFSET paging reads every skipped row (24.7M rows / 36.6 GiB / 42 s measured on one endpoint, issue #413). So total_pages is exactly the last page this API will serve and next_page / prev_page stay coherent at the window edge, while total_items tells the caller how many rows there really are. History beyond the window is reached with each endpoint's range filters, not a larger page. |
pagination.current_page | integer (int32) | Yes | 1-indexed page that produced the rows in data. |
pagination.next_page | integer (int32), nullable | Yes | Next page number, or null if this is the last page. |
pagination.per_page | integer (int32) | Yes | Number of items requested per page. |
pagination.prev_page | integer (int32), nullable | Yes | Previous page number, or null if this is the first page. |
pagination.total_items | integer (int64) | Yes | Number of items matching the query across all pages. This is the exact count — every matching row, however many there are. It is not bounded by total_pages, so a listing can legitimately report far more items than total_pages × per_page. |
pagination.total_pages | integer (int32) | Yes | Number of pages at the current per_page that this API will serve: ceil(total_items / per_page), capped at ceil(1000000 / per_page) because the page parameter only reaches into the first 1,000,000 rows. When the cap bites, total_items is still the true total and this is the last page a request can ask for; reach deeper history with the endpoint's range filters instead of a larger page. |
400 — Invalid query parameter
| Field | Type | Required | Description |
|---|---|---|---|
message | string | Yes | Plain-english message describing the failure from the caller's perspective. |
status_code | integer (int32) | Yes | HTTP status code (mirrored in the response status line for convenience). |
500 — Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
message | string | Yes | Plain-english message describing the failure from the caller's perspective. |
status_code | integer (int32) | Yes | HTTP status code (mirrored in the response status line for convenience). |
Every request needs an Authorization header holding your API key — see Getting started with the Taostats API.