{ "openapi": "3.1.0", "info": { "title": "PearlStack Public API", "version": "1.0.0", "description": "Public Pearl blockchain explorer API for blocks, transactions, addresses, miners, pools, mempool, market data, and analytics." }, "servers": [ { "url": "http://127.0.0.1:8000", "description": "Configured API server" } ], "tags": [ { "name": "API Access" }, { "name": "Status" }, { "name": "Blocks" }, { "name": "Transactions" }, { "name": "Addresses" }, { "name": "Miners" }, { "name": "Pools" }, { "name": "Analytics" }, { "name": "Market" }, { "name": "Search" }, { "name": "Mempool" }, { "name": "Labels" } ], "paths": { "/v1/docs": { "get": { "tags": [ "API Access" ], "summary": "OpenAPI document", "description": "Returns this OpenAPI JSON document.", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/openapi.json": { "get": { "tags": [ "API Access" ], "summary": "OpenAPI document", "description": "Returns this OpenAPI JSON document.", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/api/me": { "get": { "tags": [ "API Access" ], "summary": "Inspect current API identity and rate limit", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/status": { "get": { "tags": [ "Status" ], "summary": "API, database, node, and indexer status", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/blocks": { "get": { "tags": [ "Blocks" ], "summary": "List recent blocks", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/blocks/{heightOrHash}": { "get": { "tags": [ "Blocks" ], "summary": "Get a block by height or hash", "parameters": [ { "name": "heightOrHash", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block height or block hash." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/blocks/{heightOrHash}/certificate": { "get": { "tags": [ "Blocks" ], "summary": "Get Pearl block certificate metadata", "parameters": [ { "name": "heightOrHash", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block height or block hash." }, { "name": "includeProof", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Include certificate proof data hex when available." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/blocks/{heightOrHash}/coinbase-outputs": { "get": { "tags": [ "Blocks" ], "summary": "List coinbase payout outputs for a block", "parameters": [ { "name": "heightOrHash", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block height or block hash." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/blocks/{heightOrHash}/outputs": { "get": { "tags": [ "Blocks" ], "summary": "List outputs created in a block", "parameters": [ { "name": "heightOrHash", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block height or block hash." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/blocks/{heightOrHash}/raw": { "get": { "tags": [ "Blocks" ], "summary": "Get stored raw block JSON", "parameters": [ { "name": "heightOrHash", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block height or block hash." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/blocks/{heightOrHash}/txs": { "get": { "tags": [ "Blocks", "Transactions" ], "summary": "List transactions in a block", "parameters": [ { "name": "heightOrHash", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block height or block hash." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/txs": { "get": { "tags": [ "Transactions" ], "summary": "List recent transaction flows", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/txs/{txid}": { "get": { "tags": [ "Transactions" ], "summary": "Get transaction summary", "parameters": [ { "name": "txid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/txs/{txid}/flow": { "get": { "tags": [ "Transactions" ], "summary": "Get transaction flow with counterparties", "parameters": [ { "name": "txid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/txs/{txid}/inputs": { "get": { "tags": [ "Transactions" ], "summary": "List transaction inputs", "parameters": [ { "name": "txid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/txs/{txid}/outputs": { "get": { "tags": [ "Transactions" ], "summary": "List transaction outputs", "parameters": [ { "name": "txid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/txs/{txid}/raw": { "get": { "tags": [ "Transactions" ], "summary": "Get stored raw transaction JSON", "parameters": [ { "name": "txid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/addresses/{address}": { "get": { "tags": [ "Addresses" ], "summary": "Get address summary", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/addresses/{address}/balance-history": { "get": { "tags": [ "Addresses" ], "summary": "Get address balance history", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/addresses/{address}/flow-summary": { "get": { "tags": [ "Addresses" ], "summary": "Get address inflow/outflow summary", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/addresses/{address}/flows": { "get": { "tags": [ "Addresses" ], "summary": "List address flows", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/addresses/{address}/txs": { "get": { "tags": [ "Addresses", "Transactions" ], "summary": "List address transactions", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/addresses/{address}/utxos": { "get": { "tags": [ "Addresses" ], "summary": "List address UTXOs", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/miners/top": { "get": { "tags": [ "Miners" ], "summary": "List top miners", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/miners/{address}": { "get": { "tags": [ "Miners" ], "summary": "Get miner summary and mined blocks", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/miners/{address}/blocks-over-time": { "get": { "tags": [ "Miners" ], "summary": "List miner blocks over time", "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/pools/top": { "get": { "tags": [ "Pools" ], "summary": "List top pools", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/pools/{poolId}": { "get": { "tags": [ "Pools" ], "summary": "Get pool summary, addresses, and payout outputs", "parameters": [ { "name": "poolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "addressLimit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "addressOffset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "payoutLimit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "payoutOffset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/pools/{poolId}/blocks-over-time": { "get": { "tags": [ "Pools" ], "summary": "List pool blocks over time", "parameters": [ { "name": "poolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/pools/{poolId}/payout-outputs": { "get": { "tags": [ "Pools" ], "summary": "List pool payout outputs", "parameters": [ { "name": "poolId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/mempool": { "get": { "tags": [ "Mempool" ], "summary": "Get mempool summary from the Pearl node", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/search": { "get": { "tags": [ "Search" ], "summary": "Search blocks, transactions, addresses, miners, and pool labels", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/search/suggest": { "get": { "tags": [ "Search" ], "summary": "Get search suggestions", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/known-addresses": { "get": { "tags": [ "Labels" ], "summary": "List known addresses and labels", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor returned as pagination.nextCursor. Preferred over offset for public clients." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/market": { "get": { "tags": [ "Market" ], "summary": "Get cached Pearl market data", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/market/chart": { "get": { "tags": [ "Market" ], "summary": "Get cached Pearl price chart", "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "enum": [ 1, 7, 30, 90, 365 ], "default": 7 } } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/analytics/market": { "get": { "tags": [ "Analytics", "Market" ], "summary": "Get market snapshot analytics", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/analytics/network": { "get": { "tags": [ "Analytics" ], "summary": "Get network, difficulty, hashrate, and indexer analytics", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/analytics/pools": { "get": { "tags": [ "Analytics", "Pools" ], "summary": "Get pool share analytics", "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "24h", "7d", "30d", "90d", "all" ], "default": "30d" }, "description": "Window for the difficulty/hashrate overlay." } ], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/analytics/pouw": { "get": { "tags": [ "Analytics" ], "summary": "Get PoUW analytics", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } }, "/v1/analytics/supply": { "get": { "tags": [ "Analytics" ], "summary": "Get supply analytics", "parameters": [], "responses": { "200": { "description": "JSON response", "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "Unix timestamp when the current rate-limit window resets." } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, {} ] } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key" }, "BearerAuth": { "type": "http", "scheme": "bearer" } }, "responses": { "BadRequest": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "Unauthorized": { "description": "Invalid or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "RateLimited": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the next request should be attempted." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "ServerError": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "schemas": { "Pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "nextCursor": { "type": [ "string", "null" ] } } }, "ResponseMeta": { "type": "object", "properties": { "requestId": { "type": "string" }, "cached": { "type": "boolean" }, "indexedTip": { "type": [ "integer", "null" ] }, "indexedTipHash": { "type": [ "string", "null" ] }, "txIndexedTip": { "type": [ "integer", "null" ] }, "nodeHeight": { "type": [ "integer", "null" ] }, "servedAt": { "type": "string", "format": "date-time" } } }, "ErrorResponse": { "type": "object", "required": [ "ok", "error" ], "properties": { "ok": { "type": "boolean", "const": false }, "error": { "type": "string" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } } } } } }