{ "openapi": "3.1.0", "info": { "title": "TapeOutScan Data API", "version": "1.0.0", "description": "Read-only indexed assets, holders, mining snapshots, trades, account activity and statistics. API usage shares the website account point balance, membership and daily point usage. Any signed-in account may create API credentials directly. All keys of an account share a 60 requests/minute limit and a 3 requests/second limit. All v1 routes require signed requests. See /docs for full signing, billing and rate-window semantics." }, "servers": [ { "url": "https://tapeoutexplorer.com" } ], "paths": { "/v1/health": { "get": { "summary": "Health and indexed freshness", "operationId": "getHealthandindexedfreshness", "description": "Query point cost: 0. Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Health" }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": 0 } }, "/v1/processors": { "get": { "summary": "Supported processors", "operationId": "getSupportedprocessors", "description": "Query point cost: 0. Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Processor" } }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": 0 } }, "/v1/stats": { "get": { "summary": "Indexed statistics", "operationId": "getIndexedstatistics", "description": "Query point cost: 0. Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Stat" } }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": 0 } }, "/v1/circuits": { "get": { "summary": "Indexed circuits", "operationId": "getIndexedcircuits", "description": "Query point cost: 3. Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "collection", "in": "query", "schema": { "type": "string", "description": "Collection address, CPU ID 30/1, or alias tapeout/behemoth" } }, { "name": "tokenId", "in": "query", "schema": { "type": "string", "description": "Decimal integer within the current SQLite int64 index range", "pattern": "^(0|[1-9][0-9]*)$" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Circuit" } }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": 3 } }, "/v1/circuits/{collection}/{tokenId}": { "get": { "summary": "Indexed circuit detail", "operationId": "getIndexedcircuitdetail", "description": "Query point cost: 2. Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string", "description": "Collection address, CPU ID 30/1, or alias tapeout/behemoth" } }, { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "string", "description": "Decimal integer within the current SQLite int64 index range", "pattern": "^(0|[1-9][0-9]*)$" } }, { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Circuit" }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": 2 } }, "/v1/accounts/{account}/holdings": { "get": { "summary": "Indexed account holdings", "operationId": "getIndexedaccountholdings", "description": "Query point cost: 3. Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "account", "in": "path", "required": true, "schema": { "type": "string", "description": "", "pattern": "^0x[0-9a-fA-F]{40}$" } }, { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "collection", "in": "query", "schema": { "type": "string", "description": "Collection address, CPU ID 30/1, or alias tapeout/behemoth" } }, { "name": "tokenId", "in": "query", "schema": { "type": "string", "description": "Decimal integer within the current SQLite int64 index range", "pattern": "^(0|[1-9][0-9]*)$" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Circuit" } }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": 3 } }, "/v1/accounts/{account}/events": { "get": { "summary": "Indexed account activity", "operationId": "getIndexedaccountactivity", "description": "Query point cost: 2 * ceil(limit/20). Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "account", "in": "path", "required": true, "schema": { "type": "string", "description": "", "pattern": "^0x[0-9a-fA-F]{40}$" } }, { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "collection", "in": "query", "schema": { "type": "string", "description": "Collection address, CPU ID 30/1, or alias tapeout/behemoth" } }, { "name": "fromBlock", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": "2 * ceil(limit/20)" } }, "/v1/trades": { "get": { "summary": "Verified indexed trades", "operationId": "getVerifiedindexedtrades", "description": "Query point cost: 2 * ceil(limit/20). Coverage: BSC CPU 30 and 1 only. Offset pages use independent snapshots, not an immutable export.", "parameters": [ { "name": "chainId", "in": "query", "schema": { "type": "string", "description": "", "enum": [ "56" ], "default": "56" } }, { "name": "collection", "in": "query", "schema": { "type": "string", "description": "Collection address, CPU ID 30/1, or alias tapeout/behemoth" } }, { "name": "tokenId", "in": "query", "schema": { "type": "string", "description": "Decimal integer within the current SQLite int64 index range", "pattern": "^(0|[1-9][0-9]*)$" } }, { "name": "account", "in": "query", "schema": { "type": "string", "description": "", "pattern": "^0x[0-9a-fA-F]{40}$" } }, { "name": "fromBlock", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } }, { "name": "X-TOS-Timestamp", "in": "header", "required": true, "schema": { "type": "string", "description": "Unix seconds within ±60 seconds", "pattern": "^[0-9]{10}$" } }, { "name": "X-TOS-Nonce", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique random nonce per request", "pattern": "^[A-Za-z0-9_-]{16,64}$" } }, { "name": "X-TOS-Signature", "in": "header", "required": true, "schema": { "type": "string", "description": "Lowercase HMAC-SHA256; sign GET + newline + exact path/query + newline + timestamp + newline + nonce + newline + SHA256(empty body). Secret UTF-8 bytes. No trailing newline.", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Success. Shared account points are consumed only for successful queries. Membership rules apply.", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } }, "X-Point-Cost": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Trade" } }, "meta": { "$ref": "#/components/schemas/Meta" }, "requestId": { "type": "string", "description": "" } }, "required": [ "data", "meta", "requestId" ] } } } }, "400": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid signature, clock or revoked key", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Nonce reused", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request or unsupported data", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/point/shared-IP limit; obey Retry-After", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Busy; retry with backoff", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "APIKey": [] } ], "x-point-cost": "2 * ceil(limit/20)" } } }, "components": { "securitySchemes": { "APIKey": { "type": "apiKey", "in": "header", "name": "X-TOS-Key", "description": "Requires X-TOS-Timestamp, X-TOS-Nonce and X-TOS-Signature in the same request." } }, "schemas": { "Processor": { "type": "object", "properties": { "processor": { "type": "string", "description": "" }, "cpuId": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "collection": { "type": "string", "description": "" }, "chainId": { "type": "integer", "const": 56 }, "coverage": { "type": "string", "description": "", "const": "indexed_subset" } }, "required": [ "processor", "cpuId", "name", "collection", "chainId", "coverage" ] }, "Mining": { "type": [ "object", "null" ], "properties": { "hashrate": { "type": [ "string", "null" ] }, "baseHashrate": { "type": [ "string", "null" ] }, "bonusHashrate": { "type": [ "string", "null" ] }, "pool": { "type": [ "string", "null" ] }, "isChampion": { "type": "boolean" }, "updatedAt": { "type": "string", "description": "" } } }, "Circuit": { "type": "object", "properties": { "chainId": { "type": "integer", "const": 56 }, "cpuId": { "type": "string", "description": "" }, "collection": { "type": "string", "description": "" }, "tokenId": { "type": "string", "description": "" }, "assetId": { "type": "string", "description": "" }, "owner": { "type": [ "string", "null" ] }, "taskId": { "type": [ "string", "null" ] }, "status": { "type": "string", "description": "" }, "mintedBlock": { "type": [ "integer", "null" ] }, "observedBlock": { "type": [ "integer", "null" ] }, "updatedAt": { "type": "string", "description": "" }, "nand": { "type": [ "integer", "null" ] }, "latch": { "type": [ "integer", "null" ] }, "mining": { "$ref": "#/components/schemas/Mining" } }, "required": [ "chainId", "cpuId", "collection", "tokenId", "assetId", "owner", "taskId", "status", "mintedBlock", "observedBlock", "updatedAt", "nand", "latch", "mining" ] }, "Trade": { "type": "object", "properties": { "chainId": { "type": "integer", "const": 56 }, "tradeId": { "type": "string", "description": "" }, "collection": { "type": "string", "description": "" }, "tokenId": { "type": "string", "description": "" }, "buyer": { "type": "string", "description": "" }, "seller": { "type": "string", "description": "" }, "sellerProceedsWei": { "type": "string", "description": "" }, "feeWei": { "type": "string", "description": "" }, "buyerTotalWei": { "type": "string", "description": "" }, "currency": { "type": "string", "description": "", "const": "BNB" }, "currencyDecimals": { "type": "integer", "const": 18 }, "marketplace": { "type": "string", "description": "" }, "txHash": { "type": "string", "description": "" }, "logIndex": { "type": "integer" }, "blockNumber": { "type": "integer" }, "blockTime": { "type": [ "string", "null" ] }, "evidenceBasis": { "type": "string", "description": "" }, "indexedAt": { "type": "string", "description": "" } }, "required": [ "chainId", "tradeId", "collection", "tokenId", "buyer", "seller", "sellerProceedsWei", "feeWei", "buyerTotalWei", "currency", "currencyDecimals", "marketplace", "txHash", "logIndex", "blockNumber", "blockTime", "evidenceBasis", "indexedAt" ] }, "Event": { "type": "object", "properties": { "eventId": { "type": "string", "description": "" }, "chainId": { "type": "integer", "const": 56 }, "collection": { "type": "string", "description": "" }, "tokenId": { "type": [ "string", "null" ] }, "type": { "type": "string", "description": "" }, "txHash": { "type": [ "string", "null" ] }, "blockNumber": { "type": "integer" }, "logIndex": { "type": [ "integer", "null" ] }, "blockTime": { "type": [ "string", "null" ] } }, "required": [ "eventId", "chainId", "collection", "tokenId", "type", "txHash", "blockNumber", "logIndex", "blockTime" ] }, "Stat": { "type": "object", "properties": { "chainId": { "type": "integer", "const": 56 }, "cpuId": { "type": "string", "description": "" }, "collection": { "type": "string", "description": "" }, "indexedCircuits": { "type": "integer" }, "indexedHolders": { "type": "integer" }, "indexedMiners": { "type": "integer" }, "indexedHashrate": { "type": [ "string", "null" ] } }, "required": [ "chainId", "cpuId", "collection", "indexedCircuits", "indexedHolders", "indexedMiners", "indexedHashrate" ] }, "Health": { "type": "object", "properties": { "status": { "type": "string", "description": "", "enum": [ "ok", "degraded" ] }, "readOnly": { "type": "boolean" }, "version": { "type": "string", "description": "" } }, "required": [ "status", "readOnly", "version" ] }, "Points": { "type": "object", "properties": { "cost": { "type": "integer" }, "remaining": { "type": "integer" }, "unlimited": { "type": "boolean" }, "dailyUsageRemaining": { "type": [ "integer", "null" ] }, "resetsAt": { "type": "integer" } }, "required": [ "cost", "remaining", "unlimited", "dailyUsageRemaining", "resetsAt" ] }, "Pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": [ "integer", "null" ] } }, "required": [ "limit", "offset", "hasMore", "nextOffset" ] }, "Scope": { "type": "object", "properties": { "chainId": { "type": "integer", "const": 56 }, "cpuIds": { "type": "array", "items": { "type": "string", "description": "" } }, "coverage": { "type": "string", "description": "", "const": "indexed_subset" }, "allProcessors": { "type": "boolean" }, "liveListings": { "type": "boolean" }, "purchasePreparation": { "type": "boolean" }, "ownership": { "type": "string", "description": "" }, "history": { "type": "string", "description": "" } }, "required": [ "chainId", "cpuIds", "coverage", "allProcessors", "liveListings", "purchasePreparation", "ownership", "history" ] }, "Checkpoint": { "type": "object", "properties": { "stream": { "type": "string", "description": "" }, "scanned_block": { "type": "integer" }, "confirmed_block": { "type": "integer" }, "updated_at": { "type": "string", "description": "" } }, "required": [ "stream", "scanned_block", "confirmed_block", "updated_at" ] }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "" } }, "required": [ "code" ] }, "requestId": { "type": "string", "description": "" } }, "required": [ "error", "requestId" ] }, "Meta": { "type": "object", "properties": { "scope": { "$ref": "#/components/schemas/Scope" }, "indexedBlock": { "type": [ "integer", "null" ] }, "updatedAt": { "type": [ "string", "null" ] }, "ageSeconds": { "type": [ "integer", "null" ] }, "stale": { "type": "boolean" }, "checkpoints": { "type": "array", "items": { "$ref": "#/components/schemas/Checkpoint" } }, "paginationConsistency": { "type": "string", "description": "" }, "points": { "$ref": "#/components/schemas/Points" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "required": [ "scope", "indexedBlock", "updatedAt", "ageSeconds", "stale", "checkpoints", "paginationConsistency", "points" ] } } } }