{ "openapi": "3.1.0", "info": { "title": "Helius API Catalog", "version": "1.0.0", "summary": "Machine-readable discovery document for every Helius API surface on Solana.", "description": "This document is a discovery catalog — not an operational spec. It exists so\nAI agents, codegen tools, and SDK generators can locate the canonical\nOpenAPI document for every Helius API in one request instead of crawling\nthe docs site.\n\nStart with the `x-apis` array: each entry links a Helius API surface to its\ncanonical OpenAPI spec (`specUrl`) and human-readable docs (`docsUrl`).\nFollow `externalDocs` for the full developer documentation site.\n\n## A note on JSON-RPC APIs\n\nSeveral Helius APIs (Solana RPC, DAS, Sender, Mint, Priority Fee,\nZK Compression) follow the JSON-RPC 2.0 convention where every method POSTs\nto `/` with a `method` field in the request body. For each such API the\nrepository ships both per-method fragment YAMLs (used to render the\nMintlify reference pages) and an auto-generated `_combined.yaml` that\nmerges every method into a single OpenAPI document. In the combined\ndocuments, colliding paths are disambiguated with a URL-fragment suffix\n(e.g. `/#getAccountInfo`) and each operation carries an `x-actual-path`\nextension that records the real request path (`/`). The fragment syntax is\nschema-only — real calls still go to the `url` in `servers`.\n\nAll `specUrl` values below point to raw GitHub files on the `main` branch\nof `helius-labs/docs`. They are stable URLs suitable for downstream tools\nto pin or fetch.\n", "contact": { "name": "Helius Support", "url": "https://www.helius.dev/contact", "email": "support@helius.dev" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "servers": [ { "url": "https://mainnet.helius-rpc.com", "description": "Solana mainnet RPC endpoint (Solana RPC, DAS, Priority Fee, ZK Compression)" }, { "url": "https://devnet.helius-rpc.com", "description": "Solana devnet RPC endpoint" }, { "url": "https://sender.helius-rpc.com", "description": "Helius Sender — global transaction submission" }, { "url": "https://api.helius.xyz", "description": "Helius REST APIs (Wallet API, Enhanced API, Webhooks)" }, { "url": "https://admin-api.helius.xyz", "description": "Helius Admin API — project usage and billing" }, { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" }, { "url": "http://slc-sender.helius-rpc.com", "description": "Salt Lake City" }, { "url": "http://ewr-sender.helius-rpc.com", "description": "Newark" }, { "url": "http://lon-sender.helius-rpc.com", "description": "London" }, { "url": "http://fra-sender.helius-rpc.com", "description": "Frankfurt" }, { "url": "http://ams-sender.helius-rpc.com", "description": "Amsterdam" }, { "url": "http://sg-sender.helius-rpc.com", "description": "Singapore" }, { "url": "http://tyo-sender.helius-rpc.com", "description": "Tokyo" } ], "externalDocs": { "description": "Helius Documentation (canonical)", "url": "https://www.helius.dev/docs" }, "paths": { "/v0/addresses/{address}/nft-events": { "get": { "tags": [ "NFTs" ], "summary": "Returns all NFT related events associated with the given address.", "operationId": "enhancedApi_getNftEvents", "description": "Retrieve comprehensive NFT events data for any Solana address. Filter by event types, \ntransaction sources, and time ranges to get precise NFT activity including mints, \nsales, listings, and transfers.\n", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_beforeParam" }, { "$ref": "#/components/parameters/EnhancedApi_untilParam" }, { "$ref": "#/components/parameters/EnhancedApi_commitmentParam" }, { "$ref": "#/components/parameters/EnhancedApi_addressParam" }, { "$ref": "#/components/parameters/EnhancedApi_transactionSourceParam" }, { "$ref": "#/components/parameters/EnhancedApi_transactionTypeParam" } ], "responses": { "200": { "description": "Returns an array of NFTEvents.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NFTEvent" } } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/addresses/{address}/nft-events", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.address": "method.request.path.address" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/addresses/{address}/transactions": { "get": { "tags": [ "Transactions" ], "summary": "Returns an enhanced transaction history for a given address", "operationId": "enhancedApi_getEnhancedTransactions", "description": "Access comprehensive transaction history for any Solana address with human-readable \ndecoded data. Filter by transaction types, sources, and time ranges to get detailed\ninsights into wallet activity with context and decoded instructions.\n", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_beforeSigParam" }, { "$ref": "#/components/parameters/EnhancedApi_afterSigParam" }, { "$ref": "#/components/parameters/EnhancedApi_commitmentParam" }, { "$ref": "#/components/parameters/EnhancedApi_tokenAccountsParam" }, { "$ref": "#/components/parameters/EnhancedApi_sortOrderParam" }, { "$ref": "#/components/parameters/EnhancedApi_gtSlotParam" }, { "$ref": "#/components/parameters/EnhancedApi_gteSlotParam" }, { "$ref": "#/components/parameters/EnhancedApi_ltSlotParam" }, { "$ref": "#/components/parameters/EnhancedApi_lteSlotParam" }, { "$ref": "#/components/parameters/EnhancedApi_gtTimeParam" }, { "$ref": "#/components/parameters/EnhancedApi_gteTimeParam" }, { "$ref": "#/components/parameters/EnhancedApi_ltTimeParam" }, { "$ref": "#/components/parameters/EnhancedApi_lteTimeParam" }, { "$ref": "#/components/parameters/EnhancedApi_addressParam" }, { "$ref": "#/components/parameters/EnhancedApi_transactionSourceParam" }, { "$ref": "#/components/parameters/EnhancedApi_transactionTypeParam" }, { "$ref": "#/components/parameters/EnhancedApi_limitNewParam" } ], "responses": { "200": { "description": "Returns an array of enhanced transactions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_EnhancedTransaction" } } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/addresses/{address}/transactions", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.address": "method.request.path.address" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/addresses/{address}/raw-transactions": { "get": { "tags": [ "Transactions" ], "summary": "Returns raw transaction history for a given address", "operationId": "enhancedApi_getRawTransactionHistory", "description": "Retrieve complete raw transaction data for any Solana address with full\ntransaction details in their original format. Access historical transaction \ndata with precise time filtering options.\n", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_beforeParam" }, { "$ref": "#/components/parameters/EnhancedApi_untilParam" }, { "$ref": "#/components/parameters/EnhancedApi_commitmentParam" }, { "$ref": "#/components/parameters/EnhancedApi_addressParam" } ], "responses": { "200": { "description": "Returns an array of raw transactions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_RawTransaction" } } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/addresses/{address}/raw-transactions", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.address": "method.request.path.address" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/transactions": { "post": { "tags": [ "Transactions" ], "summary": "Returns an array of enhanced, human-readable versions of the given transactions.", "description": "Convert raw Solana transactions into enhanced, human-readable formats with\ndecoded instruction data and contextual information. Process multiple transactions\nin a single request for efficient data analysis and display.\n", "operationId": "enhancedApi_getEnhancedTransaction", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_commitmentParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ParseTransactionsRequest" } } } }, "responses": { "200": { "description": "Returns an array of enhanced transactions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_EnhancedTransaction" } } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/transactions", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/raw-transactions": { "post": { "tags": [ "Transactions" ], "summary": "Returns an array of raw (directly from RPC) transactions.", "operationId": "enhancedApi_getRawTransactions", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_commitmentParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ParseTransactionsRequest" } } } }, "responses": { "200": { "description": "Returns an array of raw transactions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_RawTransaction" } } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/raw-transactions", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/tokens/metadata": { "post": { "tags": [ "Tokens", "NFTs" ], "summary": "Returns token metadata (whether NFT or Fungible) for a given token address.", "operationId": "enhancedApi_getTokenMetadata", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_TokensMetadataRequest" } } } }, "responses": { "200": { "description": "Returns the token metadata.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenMetadataResponse" } } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/tokens/metadata", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/addresses/{address}/names": { "get": { "tags": [ "Addresses" ], "summary": "Returns the Solana Naming Service name for a given address.", "operationId": "enhancedApi_getAddressName", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_addressParam" } ], "responses": { "200": { "description": "Returns the Solana Naming Service name if exists. Otherwise returns null.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_NamesResponse" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/addresses/{address}/names", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.address": "method.request.path.address" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/addresses/{address}/balances": { "get": { "tags": [ "Addresses" ], "summary": "Returns the native balance and token balances for a given address.", "operationId": "enhancedApi_getBalances", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_addressParam" } ], "responses": { "200": { "description": "Returns the native balance and the token balances for a given account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_BalancesResponse" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/addresses/{address}/balances", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.address": "method.request.path.address" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/addresses/{address}/nfts": { "get": { "tags": [ "NFTs" ], "summary": "Returns the NFTs held for a given address.", "operationId": "enhancedApi_getNFTs", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" }, { "$ref": "#/components/parameters/EnhancedApi_addressParam" }, { "$ref": "#/components/parameters/EnhancedApi_pageNumberParam" } ], "responses": { "200": { "description": "Returns the current NFTs that this address owns.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_NFTsResponse" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/addresses/{address}/nfts", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.address": "method.request.path.address" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v1/nft-events": { "post": { "tags": [ "NFTs" ], "summary": "Queries for NFT events.", "operationId": "enhancedApi_queryNftEvents", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_QueryNftEventsRequest" } } } }, "responses": { "200": { "description": "Query result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_QueryNftEventsResponse" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/nft-events", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v1/nfts": { "post": { "tags": [ "NFTs" ], "summary": "Describes the provided NFTs.", "operationId": "enhancedApi_describeNfts", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_DescribeNftsRequest" } } } }, "responses": { "200": { "description": "Query result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_DescribeNftsResponse" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/nfts", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v1/mintlist": { "post": { "tags": [ "NFTs" ], "summary": "Returns a list of mint accounts for a given NFT collection.", "operationId": "enhancedApi_mintlist", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_MintlistRequest" } } } }, "responses": { "200": { "description": "Query result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_MintlistResponse" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/mintlist", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v1/active-listings": { "post": { "tags": [ "NFTs" ], "summary": "Query for active NFT listings.", "operationId": "enhancedApi_queryActiveListings", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ActiveListingsRequest" } } } }, "responses": { "200": { "description": "Query result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ActiveListingsResponse" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/active-listings", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v1/raw-transactions": { "post": { "tags": [ "Transactions" ], "summary": "Returns an array of raw transactions for the given accounts.", "operationId": "enhancedApi_queryRawTxns", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_RawTransactionsV1Request" } } } }, "responses": { "200": { "description": "Query result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_RawTransactionsV1Response" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/raw-transactions-v1", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/token-metadata": { "post": { "tags": [ "Tokens", "NFTs" ], "summary": "Returns all metadata associated with an account, including data from the old token list.", "operationId": "enhancedApi_queryMetadataV1", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_TokensMetadataRequestV1" } } } }, "responses": { "200": { "description": "Query result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_TokensMetadataResponseV1" } } } }, "400": { "$ref": "#/components/responses/EnhancedApi_400-BadRequest" }, "401": { "$ref": "#/components/responses/EnhancedApi_401-Unauthorized" }, "403": { "$ref": "#/components/responses/EnhancedApi_403-Forbidden" }, "404": { "$ref": "#/components/responses/EnhancedApi_404-NotFound" }, "429": { "$ref": "#/components/responses/EnhancedApi_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/EnhancedApi_500-InternalServerError" }, "503": { "$ref": "#/components/responses/EnhancedApi_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/EnhancedApi_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/tokens/metadata-v1", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://api-devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Returns all webhooks.", "operationId": "webhooks_getWebhooks", "description": "Retrieve a complete list of all configured webhooks for your API key with detailed\nconfiguration information including trigger conditions, delivery endpoints, and status.\n", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "responses": { "200": { "description": "Webhooks for the given API key.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_Webhook" } } } } }, "400": { "$ref": "#/components/responses/Webhooks_400-BadRequest" }, "401": { "$ref": "#/components/responses/Webhooks_401-Unauthorized" }, "403": { "$ref": "#/components/responses/Webhooks_403-Forbidden" }, "404": { "$ref": "#/components/responses/Webhooks_404-NotFound" }, "429": { "$ref": "#/components/responses/Webhooks_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/Webhooks_500-InternalServerError" }, "503": { "$ref": "#/components/responses/Webhooks_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/Webhooks_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/webhooks", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com" } ] }, "post": { "tags": [ "Webhooks" ], "summary": "Creates a webhook.", "operationId": "webhooks_createWebhook", "description": "Create a new webhook for real-time Solana blockchain notifications. Configure triggers \nbased on addresses, transaction types, or specific on-chain events. Customize delivery \noptions and notification formatting for seamless integration with your application.\n", "parameters": [ { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_CreateWebhookRequest" } } } }, "responses": { "200": { "description": "The created webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_Webhook" } } } }, "400": { "$ref": "#/components/responses/Webhooks_400-BadRequest" }, "401": { "$ref": "#/components/responses/Webhooks_401-Unauthorized" }, "429": { "$ref": "#/components/responses/Webhooks_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/Webhooks_500-InternalServerError" }, "503": { "$ref": "#/components/responses/Webhooks_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/Webhooks_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "POST", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/webhooks", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID" }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com" } ] } }, "/v0/webhooks/{webhookID}": { "get": { "tags": [ "Webhooks" ], "summary": "Returns given Webhook.", "operationId": "webhooks_getWebhook", "description": "Retrieve detailed information about a specific webhook configuration by its unique ID.\nAccess complete webhook settings including trigger conditions, delivery endpoints, and status metrics.\n", "parameters": [ { "$ref": "#/components/parameters/Webhooks_webhookIDParam" }, { "$ref": "#/components/parameters/apiKeyParam" } ], "responses": { "200": { "description": "Returns details about the given webhook ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_Webhook" } } } }, "400": { "$ref": "#/components/responses/Webhooks_400-BadRequest" }, "401": { "$ref": "#/components/responses/Webhooks_401-Unauthorized" }, "403": { "$ref": "#/components/responses/Webhooks_403-Forbidden" }, "404": { "$ref": "#/components/responses/Webhooks_404-NotFound" }, "429": { "$ref": "#/components/responses/Webhooks_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/Webhooks_500-InternalServerError" }, "503": { "$ref": "#/components/responses/Webhooks_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/Webhooks_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "GET", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/webhooks/{webhookID}", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.webhookID": "method.request.path.webhookID" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com" } ] }, "put": { "tags": [ "Webhooks" ], "summary": "Edits a webhook.", "operationId": "webhooks_editWebhook", "description": "Update an existing webhook configuration with new trigger conditions, delivery endpoints,\nor notification formatting. Modify your real-time blockchain notification settings to adapt\nto changing application requirements without service interruption.\n", "parameters": [ { "$ref": "#/components/parameters/Webhooks_webhookIDParam" }, { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_CreateWebhookRequest" } } } }, "responses": { "200": { "description": "The edited webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_Webhook" } } } }, "400": { "$ref": "#/components/responses/Webhooks_400-BadRequest" }, "401": { "$ref": "#/components/responses/Webhooks_401-Unauthorized" }, "403": { "$ref": "#/components/responses/Webhooks_403-Forbidden" }, "404": { "$ref": "#/components/responses/Webhooks_404-NotFound" }, "429": { "$ref": "#/components/responses/Webhooks_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/Webhooks_500-InternalServerError" }, "503": { "$ref": "#/components/responses/Webhooks_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/Webhooks_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "PUT", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/webhooks/{webhookID}", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.webhookID": "method.request.path.webhookID" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com" } ] }, "delete": { "tags": [ "Webhooks" ], "summary": "Deletes a webhook.", "operationId": "webhooks_deleteWebhook", "description": "Permanently remove a webhook configuration from your account. Immediately stop\nreceiving notifications for the specified webhook trigger conditions and free up\nresources for other webhook configurations.\n", "parameters": [ { "$ref": "#/components/parameters/Webhooks_webhookIDParam" }, { "$ref": "#/components/parameters/apiKeyParam" } ], "responses": { "200": { "$ref": "#/components/responses/Webhooks_200-NoContent" }, "400": { "$ref": "#/components/responses/Webhooks_400-BadRequest" }, "401": { "$ref": "#/components/responses/Webhooks_401-Unauthorized" }, "403": { "$ref": "#/components/responses/Webhooks_403-Forbidden" }, "404": { "$ref": "#/components/responses/Webhooks_404-NotFound" }, "429": { "$ref": "#/components/responses/Webhooks_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/Webhooks_500-InternalServerError" }, "503": { "$ref": "#/components/responses/Webhooks_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/Webhooks_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "DELETE", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/webhooks/{webhookID}", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.webhookID": "method.request.path.webhookID" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com" } ] }, "patch": { "tags": [ "Webhooks" ], "summary": "Toggle a webhook on or off.", "operationId": "webhooks_toggleWebhook", "description": "Enable or disable a webhook without deleting it. Use this to re-enable a webhook that\nwas automatically disabled due to a high endpoint failure rate, or to temporarily pause\ndeliveries. After re-enabling, the webhook enters a 24-hour grace period during which it\nwill not be automatically disabled again.\n", "parameters": [ { "$ref": "#/components/parameters/Webhooks_webhookIDParam" }, { "$ref": "#/components/parameters/apiKeyParam" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ToggleWebhookRequest" } } } }, "responses": { "200": { "description": "The updated webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_Webhook" } } } }, "400": { "$ref": "#/components/responses/Webhooks_400-BadRequest" }, "401": { "$ref": "#/components/responses/Webhooks_401-Unauthorized" }, "403": { "$ref": "#/components/responses/Webhooks_403-Forbidden" }, "404": { "$ref": "#/components/responses/Webhooks_404-NotFound" }, "429": { "$ref": "#/components/responses/Webhooks_429-TooManyRequests" }, "500": { "$ref": "#/components/responses/Webhooks_500-InternalServerError" }, "503": { "$ref": "#/components/responses/Webhooks_503-ServiceUnavailable" }, "504": { "$ref": "#/components/responses/Webhooks_504-GatewayTimeout" } }, "x-amazon-apigateway-integration": { "httpMethod": "PATCH", "type": "http_proxy", "uri": "http://PLACEHOLDER_VIEW_LAYER_DNS_NAME/webhooks/{webhookID}", "connectionType": "VPC_LINK", "connectionId": "PLACEHOLDER_VPC_LINK_ID", "requestParameters": { "integration.request.path.webhookID": "method.request.path.webhookID" } }, "servers": [ { "url": "https://api-mainnet.helius-rpc.com" } ] } }, "/v1/wallet/{wallet}/identity": { "get": { "tags": [ "Identity" ], "summary": "Get wallet identity", "description": "Retrieve identity information for a known wallet (exchanges, protocols, etc.). Accepts\neither a Solana wallet address or an SNS (`.sol`) / ANS custom TLD domain name\n(e.g. `toly.sol`, `miester.bonk`). Domain resolution is mainnet-only.\n\nThe response is the standard identity object for the **resolved address**. No domain\nmarker (`inputDomain`) is attached on this endpoint — use `POST /v1/wallet/batch-identity`\nif you need to correlate inputs with outputs.\n\nReturns `404` if the wallet has no identity entry, or if a domain input cannot be resolved.\nReturns `400` if the input is neither a valid address nor a valid domain name, or if a\ndomain input is sent on a non-mainnet deployment.\n", "operationId": "walletApi_getWalletIdentity", "parameters": [ { "$ref": "#/components/parameters/WalletApi_WalletOrDomain" } ], "responses": { "200": { "description": "Identity information found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_Identity" } } } }, "400": { "$ref": "#/components/responses/WalletApi_BadRequest" }, "401": { "$ref": "#/components/responses/WalletApi_Unauthorized" }, "404": { "description": "No identity information available, or domain could not be resolved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_Error" } } } }, "429": { "$ref": "#/components/responses/WalletApi_RateLimited" }, "500": { "$ref": "#/components/responses/WalletApi_InternalError" } }, "servers": [ { "url": "https://api.helius.xyz", "description": "Production server" } ] } }, "/v1/wallet/batch-identity": { "post": { "tags": [ "Identity" ], "summary": "Batch identity lookup", "description": "Retrieve identity information for multiple entries in a single request. Each entry may be\neither a Solana wallet address or an SNS (`.sol`) / ANS custom TLD domain name. Domain\nresolution is mainnet-only.\n\nUnresolvable domain entries do not fail the batch — they come back as\n`{ \"address\": null, \"type\": \"unknown\", \"inputDomain\": \"...\", \"unresolved\": true }`\nin request order. Resolved domain entries carry an `inputDomain` field so callers can\ncorrelate responses with the original input.\n", "operationId": "walletApi_batchIdentityLookup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "addresses" ], "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 100, "description": "Array of Solana wallet addresses and/or SNS/ANS domain names to look up (up to 100 per request).", "example": [ "HXsKP7wrBWaQ8T2Vtjry3Nj3oUgwYcqq9vrHDM12G664", "toly.sol", "miester.bonk" ] } } } } } }, "responses": { "200": { "description": "Identity information for requested entries, in request order", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WalletApi_BatchIdentityEntry" } } } } }, "400": { "$ref": "#/components/responses/WalletApi_BadRequest" }, "401": { "$ref": "#/components/responses/WalletApi_Unauthorized" }, "429": { "$ref": "#/components/responses/WalletApi_RateLimited" }, "500": { "$ref": "#/components/responses/WalletApi_InternalError" } }, "servers": [ { "url": "https://api.helius.xyz", "description": "Production server" } ] } }, "/v1/wallet/{wallet}/balances": { "get": { "tags": [ "Balances" ], "summary": "Get wallet balances", "description": "Retrieve token and NFT balances for a wallet. **Pagination is manual** - the API returns up to 100 tokens per request.\n\nResults are sorted by USD value in descending order. Tokens with pricing data appear first, followed by tokens without prices.\n\n**Pagination:** Use the `page` parameter to fetch additional pages. The response includes `pagination.hasMore`\nto indicate if more results are available. Each request makes a single API call and costs 100 credits.\n", "operationId": "walletApi_getWalletBalances", "parameters": [ { "$ref": "#/components/parameters/WalletApi_WalletAddress" }, { "name": "page", "in": "query", "description": "Page number for pagination (1-indexed)", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "limit", "in": "query", "description": "Maximum number of tokens per page", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "showZeroBalance", "in": "query", "description": "Include tokens with zero balance", "schema": { "type": "boolean", "default": false } }, { "name": "showNative", "in": "query", "description": "Include native SOL in results", "schema": { "type": "boolean", "default": true } }, { "name": "showNfts", "in": "query", "description": "Include NFTs in results (max 100, first page only)", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Wallet balances retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_BalancesResponse" } } } }, "400": { "$ref": "#/components/responses/WalletApi_BadRequest" }, "401": { "$ref": "#/components/responses/WalletApi_Unauthorized" }, "429": { "$ref": "#/components/responses/WalletApi_RateLimited" }, "500": { "$ref": "#/components/responses/WalletApi_InternalError" } }, "servers": [ { "url": "https://api.helius.xyz", "description": "Production server" } ] } }, "/v1/wallet/{wallet}/history": { "get": { "tags": [ "History" ], "summary": "Get transaction history", "description": "Retrieve transaction history for a wallet using the Enhanced Transactions API.\nReturns human-readable, parsed transactions with balance changes for each transaction.\n**Pagination is manual** - the API returns up to 100 transactions per request.\n\nReturns transactions in reverse chronological order (newest first).\n\n**Associated Token Accounts (ATAs):** The `tokenAccounts` parameter controls whether transactions\ninvolving token accounts owned by the wallet are included:\n- `balanceChanged` (recommended): Includes transactions that changed token account balances, filtering spam\n- `none`: Only direct wallet interactions\n- `all`: All token account transactions including spam\n\n**Pagination:** Use the `before` parameter with `pagination.nextCursor` to fetch the next page.\nThe response includes `pagination.hasMore` to indicate if more results are available.\nEach request makes a single API call and costs 100 credits.\n", "operationId": "walletApi_getWalletHistory", "parameters": [ { "$ref": "#/components/parameters/WalletApi_WalletAddress" }, { "name": "limit", "in": "query", "description": "Maximum number of transactions per request", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "before", "in": "query", "description": "Fetch transactions before this signature (use `pagination.nextCursor` from previous response)", "schema": { "type": "string" }, "example": "5wHu1qwD7Jsj3xqWjdSEJmYr3Q5f5RjXqjqQJ7jqEj7jqEj7jqEj7jqEj7jqEj7jqE" }, { "name": "after", "in": "query", "description": "Fetch transactions after this signature (for ascending order pagination)", "schema": { "type": "string" }, "example": "5wHu1qwD7Jsj3xqWjdSEJmYr3Q5f5RjXqjqQJ7jqEj7jqEj7jqEj7jqEj7jqEj7jqE" }, { "name": "type", "in": "query", "description": "Filter by transaction type. Available types: SWAP, TRANSFER, NFT_SALE, NFT_BID, NFT_LISTING,\nNFT_MINT, NFT_CANCEL_LISTING, TOKEN_MINT, BURN, COMPRESSED_NFT_MINT, COMPRESSED_NFT_TRANSFER,\nCOMPRESSED_NFT_BURN, CREATE_STORE, WHITELIST_CREATOR, ADD_TO_WHITELIST, REMOVE_FROM_WHITELIST,\nAUCTION_MANAGER_CLAIM_BID, EMPTY_PAYMENT_ACCOUNT, UPDATE_PRIMARY_SALE_METADATA, ADD_TOKEN_TO_VAULT,\nACTIVATE_VAULT, INIT_VAULT, INIT_BANK, INIT_STAKE, MERGE_STAKE, SPLIT_STAKE, CREATE_AUCTION_MANAGER,\nSTART_AUCTION, CREATE_AUCTION_MANAGER_V2, UPDATE_EXTERNAL_PRICE_ACCOUNT, EXECUTE_TRANSACTION\n", "schema": { "type": "string", "enum": [ "SWAP", "TRANSFER", "NFT_SALE", "NFT_BID", "NFT_LISTING", "NFT_MINT", "NFT_CANCEL_LISTING", "TOKEN_MINT", "BURN", "COMPRESSED_NFT_MINT", "COMPRESSED_NFT_TRANSFER", "COMPRESSED_NFT_BURN", "CREATE_STORE", "WHITELIST_CREATOR", "ADD_TO_WHITELIST", "REMOVE_FROM_WHITELIST", "AUCTION_MANAGER_CLAIM_BID", "EMPTY_PAYMENT_ACCOUNT", "UPDATE_PRIMARY_SALE_METADATA", "ADD_TOKEN_TO_VAULT", "ACTIVATE_VAULT", "INIT_VAULT", "INIT_BANK", "INIT_STAKE", "MERGE_STAKE", "SPLIT_STAKE", "CREATE_AUCTION_MANAGER", "START_AUCTION", "CREATE_AUCTION_MANAGER_V2", "UPDATE_EXTERNAL_PRICE_ACCOUNT", "EXECUTE_TRANSACTION" ] }, "example": "SWAP" }, { "name": "tokenAccounts", "in": "query", "description": "Filter transactions involving token accounts owned by the wallet.\n- `balanceChanged` (recommended): Includes transactions that changed token balances, filters spam\n- `none`: Only transactions directly referencing the wallet\n- `all`: All transactions including token accounts (may include spam)\n", "schema": { "type": "string", "enum": [ "none", "balanceChanged", "all" ], "default": "balanceChanged" }, "example": "balanceChanged" } ], "responses": { "200": { "description": "Transaction history retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_HistoryResponse" } } } }, "400": { "$ref": "#/components/responses/WalletApi_BadRequest" }, "401": { "$ref": "#/components/responses/WalletApi_Unauthorized" }, "429": { "$ref": "#/components/responses/WalletApi_RateLimited" }, "500": { "$ref": "#/components/responses/WalletApi_InternalError" } }, "servers": [ { "url": "https://api.helius.xyz", "description": "Production server" } ] } }, "/v1/wallet/{wallet}/transfers": { "get": { "tags": [ "Transfers" ], "summary": "Get token transfers", "description": "Retrieve all token transfer activity for a wallet including sender/recipient information.\nReturns transfers in reverse chronological order (newest first).\n", "operationId": "walletApi_getWalletTransfers", "parameters": [ { "$ref": "#/components/parameters/WalletApi_WalletAddress" }, { "name": "limit", "in": "query", "description": "Maximum number of transfers to return", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "description": "Pagination cursor from previous response", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transfer history retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_TransfersResponse" } } } }, "400": { "$ref": "#/components/responses/WalletApi_BadRequest" }, "401": { "$ref": "#/components/responses/WalletApi_Unauthorized" }, "429": { "$ref": "#/components/responses/WalletApi_RateLimited" }, "500": { "$ref": "#/components/responses/WalletApi_InternalError" } }, "servers": [ { "url": "https://api.helius.xyz", "description": "Production server" } ] } }, "/v1/wallet/{wallet}/funded-by": { "get": { "tags": [ "Funding" ], "summary": "Get wallet funding source", "description": "Discover the original funding source of a wallet by analyzing its first incoming SOL transfer.\nUseful for identifying if a wallet was funded by an exchange, another wallet, etc.\n", "operationId": "walletApi_getWalletFundingSource", "parameters": [ { "$ref": "#/components/parameters/WalletApi_WalletAddress" } ], "responses": { "200": { "description": "Funding source identified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_FundingSource" } } } }, "400": { "$ref": "#/components/responses/WalletApi_BadRequest" }, "401": { "$ref": "#/components/responses/WalletApi_Unauthorized" }, "404": { "description": "No funding transaction found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_Error" } } } }, "429": { "$ref": "#/components/responses/WalletApi_RateLimited" }, "500": { "$ref": "#/components/responses/WalletApi_InternalError" } }, "servers": [ { "url": "https://api.helius.xyz", "description": "Production server" } ] } }, "/fast": { "post": { "tags": [ "Sender" ], "summary": "sendTransaction", "operationId": "senderApi_sendTransaction", "description": "Submit transactions via Helius Sender for ultra-low latency transaction submission with dual routing to both Solana validators and Jito infrastructure.\n", "parameters": [ { "name": "api-key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Standard users do not require an API key. Only users with custom TPS limits need to provide an API key." }, { "name": "swqos_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "When true, routes exclusively through SWQOS infrastructure, but has a lower minimal tip requirement." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "The JSON-RPC protocol version.", "example": "2.0", "default": "2.0" }, "id": { "type": "string", "description": "A unique identifier for the request.", "example": "1", "default": "1" }, "method": { "type": "string", "enum": [ "sendTransaction" ], "description": "The name of the RPC method to invoke.", "example": "sendTransaction", "default": "sendTransaction" }, "params": { "type": "array", "description": "Parameters for sending a transaction via Sender.", "items": { "oneOf": [ { "type": "string", "description": "The transaction encoded in base64." }, { "type": "object", "description": "Configuration options for transaction submission.", "required": [ "skipPreflight" ], "properties": { "encoding": { "type": "string", "description": "Data encoding format used for the Solana transaction payload.", "enum": [ "base58", "base64" ], "example": "base64" }, "skipPreflight": { "type": "boolean", "description": "When true, bypasses Solana's preflight transaction validation for faster submission. Must be set to true for Sender.", "example": false }, "maxRetries": { "type": "integer", "description": "Maximum number of automatic retry attempts. Should be set to 0.", "example": 0 } } } ] } } } }, "example": { "jsonrpc": "2.0", "id": "1", "method": "sendTransaction", "params": [ "Ab/WBgJxCprwWlK2fCxSwm9KrWlJQW8TdnYqXMvg5KropeLqHaa5yJeoWUb+LsGi6zlfs1Z/jA/RgJW++tBhPAKAAQACBGuePYZrXq9Jj+DwkquiMvsrNU5rlcAbmRfuAYui/CwAQr437DqfrFoSt1BSgM/2/0Iqja1QMefnu1hTYX96AA0DBkZv5SEXMv/srbpyw5vnvIzlu8X3EmssQ5s6QAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAhWHa4WfUT12o+cyi2WGwfBvngyurXf5VQd4Ukn+5ZSIDAgAFAqCGAQACAAkDQA0DAAAAAAADAgABDAIAAABAQg8AAAAAAAA=", { "encoding": "base64", "skipPreflight": true, "maxRetries": 0 } ] } } } }, "responses": { "200": { "description": "Transaction submitted successfully. Since we're skipping preflight checks, a 200 response does not guarantee that the transaction is valid or that it will land onchain.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "The JSON-RPC protocol version.", "example": "2.0" }, "id": { "type": "string", "description": "Identifier matching the request.", "example": "1" }, "result": { "type": "string", "description": "The transaction signature for tracking confirmation status.", "example": "4qTLpN1sBrp5SzZUKfrSH2897FmxA7AB4EbN4ccgSgEjG9RG2686pSKWhEbz65q4bvaRsdpKRJKZ3dkdGZA78u5s" } } }, "example": { "jsonrpc": "2.0", "id": "1", "result": "4qTLpN1sBrp5SzZUKfrSH2897FmxA7AB4EbN4ccgSgEjG9RG2686pSKWhEbz65q4bvaRsdpKRJKZ3dkdGZA78u5s" } } } }, "400": { "description": "Bad Request - Missing tip, priority fee, or invalid submission parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32602, "message": "Invalid request" }, "id": "1" } } } }, "429": { "description": "Too Many Requests - Rate limit exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32005, "message": "Too many requests" }, "id": "1" } } } }, "500": { "description": "Internal Server Error - An error occurred on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32603, "message": "Internal error" }, "id": "1" } } } }, "503": { "description": "Service Unavailable - The service is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32002, "message": "Service unavailable" }, "id": "1" } } } }, "504": { "description": "Gateway Timeout - The request timed out.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32003, "message": "Gateway timeout" }, "id": "1" } } } } }, "servers": [ { "url": "https://sender.helius-rpc.com", "description": "Global HTTPS endpoint (for frontend applications)" }, { "url": "http://slc-sender.helius-rpc.com", "description": "Salt Lake City" }, { "url": "http://ewr-sender.helius-rpc.com", "description": "Newark" }, { "url": "http://lon-sender.helius-rpc.com", "description": "London" }, { "url": "http://fra-sender.helius-rpc.com", "description": "Frankfurt" }, { "url": "http://ams-sender.helius-rpc.com", "description": "Amsterdam" }, { "url": "http://sg-sender.helius-rpc.com", "description": "Singapore" }, { "url": "http://tyo-sender.helius-rpc.com", "description": "Tokyo" } ] } }, "/ping": { "get": { "tags": [ "Sender" ], "summary": "ping", "operationId": "senderApi_ping", "description": "Ping request to Helius Sender to maintain a warm connection\n", "security": [], "responses": { "200": { "description": "Connection is alive.", "content": { "text/plain": { "schema": { "type": "string", "example": "ok" } } } }, "503": { "description": "Service Unavailable - The service is temporarily unavailable.", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "servers": [ { "url": "https://sender.helius-rpc.com", "description": "Global HTTPS endpoint (for frontend applications)" }, { "url": "http://slc-sender.helius-rpc.com", "description": "Salt Lake City" }, { "url": "http://ewr-sender.helius-rpc.com", "description": "Newark" }, { "url": "http://lon-sender.helius-rpc.com", "description": "London" }, { "url": "http://fra-sender.helius-rpc.com", "description": "Frankfurt" }, { "url": "http://ams-sender.helius-rpc.com", "description": "Amsterdam" }, { "url": "http://sg-sender.helius-rpc.com", "description": "Singapore" }, { "url": "http://tyo-sender.helius-rpc.com", "description": "Tokyo" } ] } }, "/": { "post": { "summary": "Get Solana priority fee estimates", "description": "Calculate optimal priority fee recommendations for Solana transactions based on real-time \nnetwork conditions. This advanced API analyzes historical fee data and current congestion \nlevels to provide precise fee estimates for different priority levels.\n", "operationId": "priorityFeeApi_getPriorityFeeEstimate", "security": [ { "ApiKeyQuery": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityFeeApi_PriorityFeeEstimateRequest" }, "examples": { "transactionExample": { "value": { "jsonrpc": "2.0", "id": "1", "method": "getPriorityFeeEstimate", "params": [ { "transaction": "LxzhDW7TapzziJVHEGPh1QjmZB6kjNqmvuJ9gmihBGEkzw2N8ospDq32UZdVmKWzRZqKuyvhp7xmLvsmmHa3MfxVKpYoLV9cPkw5isHnHgDUwLSMsDaZ4dLEULexXAvuV9k6fLD2LMhFKM6gqH6j69GQLAm1g4e3z5ZVZN6pmJdSmZ4PqKcwNn4sS7E3Abp1hV59uBJB9i4jEdEAh28rZ8WCeNizzEmrJZFhatFFFGSDsk23jDPEjbkMcoRWXKf1WthFScC2S6Wz284Dtjqp7kW8eybV3DpmN9DtBbcfFNQPtUwmiBZCKszdYym5AjJvRHiUKUdMwFpC3toPnMvTmKZ9iHQtzZRkg5xBufRtUN5eVYJfdw2DxzH6RfqhC2rAjfSbfJA4wmaq9f5eUe2iEjmqvne6r85PPcHBJzyqkVtAyUFtTc9DfU8UiM9rFhQ2UB71M6m5UCsC6EwowMw5k8iF8rL7iPCLdubVdy8S58DPLNG4E4rdosev1T63YdRWSgEwBZh7iX4zGBA9AKAm3B9itCSxLSL46Y6uZgVku9UXsMcWWz3URoa6hRbo55CYPLhrVeqjqX5DsXpaG6QkngbEaESQUnkakE1AFkYXmNXEd2m3sLRTYB2o5UTkwkJS2u5sJHyYqAvXr3vFZr7qAYFLD3LwS5tsdb45ZQVQwsbnNddMHgkpmSqLHS6Fv1epxqHbzpRCU1tgMsriApVWC3pj2LLD41HxkV8aKvkVyHgJFACUtbvRBZAasHf1F71Gz3qZNTdh3efWsZJRXnfxKPbATU7NTMaMUL8JjknfoVwp3/SsAUIMHFzjQMQmoiQMSL1q+S+r9dLR55BgaWAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG3fbh12Whk9nL4UbO63msHLSF7V9bN5E6jPWFfv8AqQECAwABDAIAAAAEAAAAAAAA" } ] } }, "accountKeysExample": { "value": { "jsonrpc": "2.0", "id": "1", "method": "getPriorityFeeEstimate", "params": [ { "accountKeys": [ "2CiBfRKcERi2GgYn83UaGo1wFaYHHrXGGfnDaa2hxdEA" ], "options": { "includeAllPriorityFeeLevels": true } } ] } } } } } }, "responses": { "200": { "description": "Successfully retrieved Solana priority fee estimates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityFeeApi_PriorityFeeEstimateResponse" }, "examples": { "singleEstimateResponse": { "value": { "jsonrpc": "2.0", "result": { "priorityFeeEstimate": 120000 }, "id": "1" } }, "allLevelsResponse": { "value": { "jsonrpc": "2.0", "result": { "priorityFeeLevels": { "min": 0, "low": 2, "medium": 10082, "high": 100000, "veryHigh": 1000000, "unsafeMax": 50000000 } }, "id": "1" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC version identifier" }, "error": { "type": "object", "description": "Error information", "properties": { "code": { "type": "integer", "example": -32602, "description": "Error code" }, "message": { "type": "string", "example": "Invalid params", "description": "Error message" } } }, "id": { "type": "string", "description": "Client-generated identifier matching the request" } } } } } }, "401": { "description": "Unauthorized — missing or invalid API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "error": { "type": "object", "properties": { "code": { "type": "integer", "example": -32001 }, "message": { "type": "string", "example": "Unauthorized" } } }, "id": { "type": "string" } } } } } }, "429": { "description": "Too Many Requests — rate limit exceeded.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "error": { "type": "object", "properties": { "code": { "type": "integer", "example": -32005 }, "message": { "type": "string", "example": "Too many requests" } } }, "id": { "type": "string" } } } } } }, "500": { "description": "Internal server error. Retryable with exponential backoff.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "error": { "type": "object", "properties": { "code": { "type": "integer", "example": -32603 }, "message": { "type": "string", "example": "Internal error" } } }, "id": { "type": "string" } } } } } } }, "servers": [ { "url": "https://mainnet.helius-rpc.com", "description": "Mainnet RPC endpoint" }, { "url": "https://devnet.helius-rpc.com", "description": "Devnet RPC endpoint" } ] } }, "/v0/admin/projects/{id}/usage": { "get": { "tags": [ "Admin" ], "summary": "Get Project Usage", "operationId": "adminApi_getProjectUsage", "description": "Retrieve credit usage, subscription details, and per-service request counts for a project within the current billing cycle.\n\nThe API key used for authentication must belong to the project specified in the path. Requests where the API key's project does not match the `id` parameter will return a `400` error.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The project ID to retrieve usage for. Must match the project associated with the API key.", "schema": { "type": "string", "format": "uuid", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } } ], "responses": { "200": { "description": "Project usage retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApi_ProjectUsageResponse" }, "example": { "creditsRemaining": 487500, "creditsUsed": 12500, "prepaidCreditsRemaining": 50000, "prepaidCreditsUsed": 0, "subscriptionDetails": { "billingCycle": { "start": "2026-04-01", "end": "2026-05-01" }, "creditsLimit": 500000, "plan": "business" }, "usage": { "api": 1200, "archival": 0, "das": 5000, "grpc": 300, "grpcGeyser": 0, "photon": 0, "rpc": 4500, "stream": 100, "webhook": 800, "websocket": 600 } } } } }, "400": { "description": "Bad Request — the project ID in the path does not match the project associated with the API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApi_ErrorResponse" }, "example": { "statusCode": 400, "message": "Invalid project id", "error": "Bad Request" } } } }, "401": { "description": "Unauthorized — API key is missing, malformed, or not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApi_ErrorResponse" }, "example": { "statusCode": 401, "message": "Missing or invalid API key", "error": "Unauthorized" } } } }, "403": { "description": "Forbidden — the Admin API is not enabled for this project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApi_ErrorResponse" }, "example": { "statusCode": 403, "message": "Admin API not enabled for this project", "error": "Forbidden" } } } }, "429": { "description": "Too Many Requests — rate limit of 5 requests per second exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApi_ErrorResponse" }, "example": { "statusCode": 429, "message": "ThrottlerException: Too Many Requests", "error": "Too Many Requests" } } } }, "500": { "description": "Internal Server Error — a server-side error occurred (e.g., missing billing data).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApi_ErrorResponse" }, "example": { "statusCode": 500, "message": "Internal server error", "error": "Internal Server Error" } } } } }, "servers": [ { "url": "https://admin-api.helius.xyz", "description": "Production server" } ] } } }, "x-apis": [ { "id": "rpc-http", "name": "Solana RPC (HTTP)", "description": "JSON-RPC 2.0 methods for Solana mainnet and devnet, plus Helius extensions such as `getTransactionsForAddress` with server-side filtering and token account helpers (`getTokenAccountsByOwnerV2`, `getProgramAccountsV2`).", "specUrl": "https://www.helius.dev/openapi/rpc-http.json", "docsUrl": "https://www.helius.dev/docs/rpc/overview", "tags": [ "rpc", "json-rpc", "solana", "accounts", "transactions" ], "status": "stable", "x-specFragments": "https://github.com/helius-labs/docs/tree/main/openapi/rpc-http" }, { "id": "das-api", "name": "Digital Asset Standard (DAS) API", "description": "Unified NFT and token queries for Solana — regular NFTs, compressed NFTs, and fungible tokens — indexed for fast lookups by owner, creator, authority, collection, or search.", "specUrl": "https://www.helius.dev/openapi/das-api.json", "docsUrl": "https://www.helius.dev/docs/das-api", "tags": [ "nft", "tokens", "compressed-nft", "digital-assets", "json-rpc" ], "status": "stable", "x-specFragments": "https://github.com/helius-labs/docs/tree/main/openapi/das-api" }, { "id": "sender-api", "name": "Helius Sender", "description": "Ultra-low-latency transaction submission with dual routing to validators and Jito infrastructure. Regional endpoints for Salt Lake City, Newark, London, Frankfurt, Amsterdam, Singapore, and Tokyo.", "specUrl": "https://www.helius.dev/openapi/sender-api.json", "docsUrl": "https://www.helius.dev/docs/sending-transactions/sender", "tags": [ "transactions", "sender", "low-latency", "jito" ], "status": "stable", "x-specFragments": "https://github.com/helius-labs/docs/tree/main/openapi/sender-api" }, { "id": "wallet-api", "name": "Wallet API", "description": "High-performance REST API for Solana wallet data — identity, balances, transaction history, transfers, and funding lineage. Returns pre-indexed results suitable for wallet and portfolio UIs.", "specUrl": "https://www.helius.dev/openapi/wallet-api.json", "docsUrl": "https://www.helius.dev/docs/wallet-api/overview", "tags": [ "wallet", "portfolio", "history", "rest" ], "status": "beta" }, { "id": "priority-fee-api", "name": "Priority Fee API", "description": "Real-time priority fee recommendations across multiple priority levels, derived from recent network activity. Accepts either account keys or a serialized transaction.", "specUrl": "https://www.helius.dev/openapi/priority-fee-api.json", "docsUrl": "https://www.helius.dev/docs/priority-fee-api", "tags": [ "priority-fee", "transactions", "fees", "json-rpc" ], "status": "stable", "x-specFragments": "https://github.com/helius-labs/docs/tree/main/openapi/priority-fee-api" }, { "id": "zk-compression", "name": "ZK Compression Indexer", "description": "Indexer API for Solana state compression — compressed accounts, compressed token balances, Merkle proofs, and validity proofs. Enables up to 1000x lower storage costs relative to regular accounts.", "specUrl": "https://www.helius.dev/openapi/zk-compression.json", "docsUrl": "https://www.helius.dev/docs/zk-compression/introduction", "tags": [ "zk-compression", "state-compression", "accounts", "proofs", "json-rpc" ], "status": "stable", "x-specFragments": "https://github.com/helius-labs/docs/tree/main/openapi/zk-compression" }, { "id": "admin-api", "name": "Admin API", "description": "Programmatic access to Helius project usage and billing data — credits consumed, credits remaining, prepaid balances, and subscription details for the current billing cycle.", "specUrl": "https://www.helius.dev/openapi/admin-api.json", "docsUrl": "https://www.helius.dev/docs/api-reference/admin", "tags": [ "admin", "billing", "usage", "rest" ], "status": "stable", "x-specFragments": "https://github.com/helius-labs/docs/tree/main/openapi/admin-api" }, { "id": "enhanced-api", "name": "Enhanced API", "description": "Decoded, human-readable transaction history, NFT events, and address activity on Solana. Returns typed, parsed data instead of raw instruction bytes.", "specUrl": "https://www.helius.dev/openapi/enhanced-api.json", "docsUrl": "https://www.helius.dev/docs/enhanced-transactions/overview", "tags": [ "enhanced", "parsed-transactions", "nft-events", "history", "rest" ], "status": "stable" }, { "id": "webhooks", "name": "Helius Webhooks", "description": "Real-time HTTP notifications for Solana on-chain events — configure account, transaction, or NFT event subscriptions and receive parsed payloads via HTTPS POST.", "specUrl": "https://www.helius.dev/openapi/webhooks.json", "docsUrl": "https://www.helius.dev/docs/webhooks", "tags": [ "webhooks", "events", "notifications", "rest" ], "status": "stable" } ], "components": { "schemas": { "EnhancedApi_ErrorResponse": { "type": "object", "description": "JSON-RPC error response format", "properties": { "jsonrpc": { "type": "string", "example": "2.0", "description": "JSON-RPC version" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "description": "Error code", "example": -32602 }, "message": { "type": "string", "description": "Error message", "example": "Invalid params" } } }, "id": { "type": "string", "description": "Request identifier", "example": "1" } }, "required": [ "jsonrpc", "error", "id" ] }, "EnhancedApi_Webhook": { "type": "object", "properties": { "webhookID": { "type": "string" }, "wallet": { "type": "string" }, "webhookURL": { "type": "string" }, "transactionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TransactionType" } }, "accountAddresses": { "type": "array", "items": { "type": "string" } }, "webhookType": { "$ref": "#/components/schemas/EnhancedApi_WebhookType" }, "authHeader": { "type": "string" } } }, "EnhancedApi_WebhookType": { "type": "string", "enum": [ "enhanced", "raw", "discord", "enhancedDevnet", "rawDevnet", "discordDevnet" ] }, "EnhancedApi_TransactionType": { "type": "string", "enum": [ "ACCEPT_ESCROW_ARTIST", "ACCEPT_ESCROW_USER", "ACCEPT_PROPOSAL", "ACCEPT_REQUEST_ARTIST", "ACTIVATE_PROPOSAL", "ACTIVATE_TRANSACTION", "ACTIVATE_VAULT", "ADD_AUTHORITY", "ADD_BALANCE_LIQUIDITY", "ADD_BATCH_TRANSACTION", "ADD_IMBALANCE_LIQUIDITY", "ADD_INSTRUCTION", "ADD_ITEM", "ADD_LIQUIDITY", "ADD_LIQUIDITY_BY_STRATEGY", "ADD_LIQUIDITY_BY_STRATEGY_ONE_SIDE", "ADD_LIQUIDITY_BY_WEIGHT", "ADD_LIQUIDITY_ONE_SIDE", "ADD_LIQUIDITY_ONE_SIDE_PRECISE", "ADD_MEMBER", "ADD_MEMBER_AND_CHANGE_THRESHOLD", "ADD_METADATA", "ADD_PAYMENT_MINT_PAYMENT_METHOD", "ADD_RARITIES_TO_BANK", "ADD_REWARDS", "ADD_SPENDING_LIMIT", "ADD_TO_POOL", "ADD_TO_WHITELIST", "ADD_TOKEN_TO_VAULT", "ADD_TRAIT_CONFLICTS", "ADMIN_SYNC_LIQUIDITY", "APPROVE", "APPROVE_PROPOSAL", "APPROVE_TRANSACTION", "ATTACH_METADATA", "AUCTION_HOUSE_CREATE", "AUCTION_MANAGER_CLAIM_BID", "AUTHORIZE_FUNDER", "BACKFILL_TOTAL_BLOCKS", "BEGIN_TRAIT_UPDATE", "BEGIN_VARIANT_UPDATE", "BOOTSTRAP_LIQUIDITY", "BORROW_CNFT_PERPETUAL", "BORROW_FOX", "BORROW_OBLIGATION_LIQUIDITY", "BORROW_PERPETUAL", "BORROW_SOL_FOR_NFT", "BORROW_STAKED_BANX_PERPETUAL", "BOT_CLAIM_SALE", "BOT_DELIST", "BOT_LIQUIDATE", "BOT_LIQUIDATE_SELL", "BOT_UNFREEZE", "BOUND_HADO_MARKET_TO_FRAKT_MARKET", "BURN", "BURN_NFT", "BURN_PAYMENT", "BURN_PAYMENT_TREE", "BUY_ITEM", "BUY_LOAN", "BUY_SUBSCRIPTION", "BUY_TICKETS", "CANCEL", "CANCEL_ALL_AND_PLACE_ORDERS", "CANCEL_ALL_ORDERS", "CANCEL_ESCROW", "CANCEL_LOAN_REQUEST", "CANCEL_MULTIPLE_ORDERS", "CANCEL_OFFER", "CANCEL_ORDER", "CANCEL_ORDER_BY_CLIENT_ORDER_ID", "CANCEL_PROPOSAL", "CANCEL_REWARD", "CANCEL_SWAP", "CANCEL_TRANSACTION", "CANCEL_UP_TO", "CANCEL_UPDATE", "CANDY_MACHINE_ROUTE", "CANDY_MACHINE_UNWRAP", "CANDY_MACHINE_UPDATE", "CANDY_MACHINE_WRAP", "CHANGE_BLOCK_BUILDER", "CHANGE_COMIC_STATE", "CHANGE_FEE_RECIPIENT", "CHANGE_MARKET_STATUS", "CHANGE_SEAT_STATUS", "CHANGE_THRESHOLD", "CHANGE_TIP_RECEIVER", "CLAIM_AUTHORITY", "CLAIM_CNFT_PERPETUAL_LOAN", "CLAIM_FEE", "CLAIM_NFT", "CLAIM_NFT_BY_LENDER_CNFT", "CLAIM_NFT_BY_LENDER_PNFT", "CLAIM_PERPETUAL_LOAN", "CLAIM_REWARD", "CLAIM_REWARDS", "CLAIM_SALE", "CLAIM_TIPS", "CLEAN", "CLOSE_ACCOUNT", "CLOSE_BATCH_ACCOUNTS", "CLOSE_BUNDLED_POSITION", "CLOSE_CLAIM_STATUS", "CLOSE_CONFIG", "CLOSE_CONFIG_TRANSACTION_ACCOUNTS", "CLOSE_ESCROW_ACCOUNT", "CLOSE_ITEM", "CLOSE_MARKET", "CLOSE_OPEN_ORDERS_ACCOUNT", "CLOSE_OPEN_ORDERS_INDEXER", "CLOSE_ORDER", "CLOSE_POOL", "CLOSE_POSITION", "CLOSE_PRESET_PARAMETER", "CLOSE_TIP_DISTRIBUTION_ACCOUNT", "CLOSE_VAULT_BATCH_TRANSACTION_ACCOUNT", "CLOSE_VAULT_TRANSACTION_ACCOUNTS", "COLLECT_FEES", "COLLECT_REWARD", "COMPRESS_NFT", "COMPRESSED_NFT_BURN", "COMPRESSED_NFT_CANCEL_REDEEM", "COMPRESSED_NFT_DELEGATE", "COMPRESSED_NFT_MINT", "COMPRESSED_NFT_REDEEM", "COMPRESSED_NFT_SET_VERIFY_COLLECTION", "COMPRESSED_NFT_TRANSFER", "COMPRESSED_NFT_UNVERIFY_COLLECTION", "COMPRESSED_NFT_UNVERIFY_CREATOR", "COMPRESSED_NFT_UPDATE_METADATA", "COMPRESSED_NFT_VERIFY_COLLECTION", "COMPRESSED_NFT_VERIFY_CREATOR", "CONSUME_EVENTS", "CONSUME_GIVEN_EVENTS", "COPY_CLUSTER_INFO", "COPY_GOSSIP_CONTACT_INFO", "COPY_TIP_DISTRIBUTION_ACCOUNT", "COPY_VOTE_ACCOUNT", "CRANK", "CRANK_EVENT_QUEUE", "CREATE", "CREATE_AMM", "CREATE_APPRAISAL", "CREATE_AVATAR", "CREATE_AVATAR_CLASS", "CREATE_BATCH", "CREATE_BET", "CREATE_BOND_AND_SELL_TO_OFFERS", "CREATE_BOND_AND_SELL_TO_OFFERS_CNFT", "CREATE_BOND_AND_SELL_TO_OFFERS_FOR_TEST", "CREATE_BOND_OFFER_STANDARD", "CREATE_COLLECTION", "CREATE_CONFIG", "CREATE_CONFIG_TRANSACTION", "CREATE_ESCROW", "CREATE_LOCK_ESCROW", "CREATE_MARKET", "CREATE_MASTER_EDITION", "CREATE_MERKLE_TREE", "CREATE_MINT_METADATA", "CREATE_MULTISIG", "CREATE_OPEN_ORDERS_ACCOUNT", "CREATE_OPEN_ORDERS_INDEXER", "CREATE_ORDER", "CREATE_PAYMENT_METHOD", "CREATE_PERPETUAL_BOND_OFFER", "CREATE_POOL", "CREATE_PROPOSAL", "CREATE_RAFFLE", "CREATE_STATS", "CREATE_STORE", "CREATE_TOKEN_POOL", "CREATE_TRAIT", "CREATE_TRANSACTION", "CREATE_UNCHECKED", "CREATE_VAULT_TRANSACTION", "DEAUTHORIZE_FUNDER", "DECOMPRESS_NFT", "DECREASE_LIQUIDITY", "DELEGATE_MERKLE_TREE", "DELETE_COLLECTION", "DELETE_POSITION_BUNDLE", "DELETE_REFERRER_STATE_AND_SHORT_URL", "DELETE_TOKEN_BADGE", "DELIST_ITEM", "DELIST_NFT", "DEPOSIT", "DEPOSIT_FRACTIONAL_POOL", "DEPOSIT_GEM", "DEPOSIT_OBLIGATION_COLLATERAL", "DEPOSIT_RESERVE_LIQUIDITY", "DEPOSIT_RESERVE_LIQUIDITY_AND_OBLIGATION_COLLATERAL", "DEPOSIT_SOL_TO_FLASH_LOAN_POOL", "DEPOSIT_TO_BOND_OFFER_STANDARD", "DEPOSIT_TO_FARM_VAULT", "DEPOSIT_TO_REWARDS_VAULT", "DISTRIBUTE_COMPRESSION_REWARDS", "EDIT_ORDER", "EDIT_ORDER_PEGGED", "EMPTY_PAYMENT_ACCOUNT", "ENABLE_OR_DISABLE_POOL", "EQUIP_TRAIT", "EQUIP_TRAIT_AUTHORITY", "EVICT_SEAT", "EXECUTE_BATCH_TRANSACTION", "EXECUTE_CONFIG_TRANSACTION", "EXECUTE_INSTRUCTION", "EXECUTE_LOAN", "EXECUTE_MORTGAGE", "EXECUTE_TRANSACTION", "EXECUTE_VAULT_TRANSACTION", "EXIT_VALIDATE_AND_SELL_TO_BOND_OFFERS_V2", "EXPIRE", "EXTEND_LOAN", "EXTENSION_EXECUTE", "FILL_ORDER", "FINALIZE_PROGRAM_INSTRUCTION", "FINISH_HADO_MARKET", "FIX_POOL", "FLASH_BORROW_RESERVE_LIQUIDITY", "FLASH_REPAY_RESERVE_LIQUIDITY", "FORCE_CANCEL_ORDERS", "FORECLOSE_LOAN", "FRACTIONALIZE", "FREEZE", "FUND_REWARD", "FUSE", "GET_POOL_INFO", "GO_TO_A_BIN", "HARVEST_REWARD", "IDL_MISSING_TYPES", "INCREASE_LIQUIDITY", "INCREASE_ORACLE_LENGTH", "INIT_AUCTION_MANAGER_V2", "INIT_BANK", "INIT_CLUSTER_HISTORY_ACCOUNT", "INIT_CONFIG", "INIT_CONFIG_EXTENSION", "INIT_CUSTOMIZABLE_PERMISSIONLESS_CONSTANT_PRODUCT_POOL", "INIT_FARM", "INIT_FARMER", "INIT_FARMS_FOR_RESERVE", "INIT_FEE_TIER", "INIT_LENDING_MARKET", "INIT_OBLIGATION", "INIT_OBLIGATION_FARMS_FOR_RESERVE", "INIT_PERMISSIONED_POOL", "INIT_PERMISSIONLESS_CONSTANT_PRODUCT_POOL_WITH_CONFIG", "INIT_PERMISSIONLESS_CONSTANT_PRODUCT_POOL_WITH_CONFIG_2", "INIT_PERMISSIONLESS_POOL", "INIT_PERMISSIONLESS_POOL_WITH_FEE_TIER", "INIT_POOL", "INIT_POOL_V2", "INIT_POSITION_BUNDLE", "INIT_POSITION_BUNDLE_WITH_METADATA", "INIT_REFERRER_STATE_AND_SHORT_URL", "INIT_REFERRER_TOKEN_STATE", "INIT_RENT", "INIT_RESERVE", "INIT_REWARD", "INIT_REWARD_V2", "INIT_STAKE", "INIT_SWAP", "INIT_TICK_ARRAY", "INIT_TIP_DISTRIBUTION_ACCOUNT", "INIT_TOKEN_BADGE", "INIT_USER_METADATA", "INIT_VALIDATOR_HISTORY_ACCOUNT", "INIT_VAULT", "INITIALIZE", "INITIALIZE_ACCOUNT", "INITIALIZE_BIN_ARRAY", "INITIALIZE_BIN_ARRAY_BITMAP_EXTENSION", "INITIALIZE_CUSTOMIZABLE_PERMISSIONLESS_LB_PAIR", "INITIALIZE_FARM", "INITIALIZE_FARM_DELEGATED", "INITIALIZE_FLASH_LOAN_POOL", "INITIALIZE_GLOBAL_CONFIG", "INITIALIZE_HADO_MARKET", "INITIALIZE_LB_PAIR", "INITIALIZE_MARKET", "INITIALIZE_PERMISSION_LB_PAIR", "INITIALIZE_POSITION", "INITIALIZE_POSITION_BY_OPERATOR", "INITIALIZE_POSITION_PDA", "INITIALIZE_PRESET_PARAMETER", "INITIALIZE_REWARD", "INITIALIZE_USER", "INSTANT_REFINANCE_PERPETUAL_LOAN", "KICK_ITEM", "LEND_FOR_NFT", "LIMIT_ORDER", "LIQUIDATE", "LIQUIDATE_BOND_ON_AUCTION_CNFT", "LIQUIDATE_BOND_ON_AUCTION_PNFT", "LIQUIDATE_OBLIGATION_AND_REDEEM_RESERVE_COLLATERAL", "LIST_ITEM", "LIST_NFT", "LOAN", "LOAN_FOX", "LOCK", "LOCK_REWARD", "LOG", "MAKE_PERPETUAL_MARKET", "MAP_BANX_TO_POINTS", "MERGE_CONDITIONAL_TOKENS", "MERGE_STAKE", "MIGRATE_BIN_ARRAY", "MIGRATE_POSITION", "MIGRATE_TO_PNFT", "MINT_TO", "NAME_SUCCESSOR", "NFT_AUCTION_CANCELLED", "NFT_AUCTION_CREATED", "NFT_AUCTION_UPDATED", "NFT_BID", "NFT_BID_CANCELLED", "NFT_CANCEL_LISTING", "NFT_GLOBAL_BID", "NFT_GLOBAL_BID_CANCELLED", "NFT_LISTING", "NFT_MINT", "NFT_MINT_REJECTED", "NFT_PARTICIPATION_REWARD", "NFT_RENT_ACTIVATE", "NFT_RENT_CANCEL_LISTING", "NFT_RENT_END", "NFT_RENT_LISTING", "NFT_RENT_UPDATE_LISTING", "NFT_SALE", "OFFER_LOAN", "OPEN_BUNDLED_POSITION", "OPEN_POSITION", "OPEN_POSITION_WITH_METADATA", "OVERRIDE_CURVE_PARAM", "PARTNER_CLAIM_FEE", "PATCH_BROKEN_USER_STAKES", "PAUSE", "PAYOUT", "PLACE_AND_TAKE_PERP_ORDER", "PLACE_BET", "PLACE_MULTIPLE_POST_ONLY_ORDERS", "PLACE_ORDER", "PLACE_ORDER_PEGGED", "PLACE_ORDERS", "PLACE_SOL_BET", "PLACE_TAKE_ORDER", "PLATFORM_FEE", "POOL_CANCEL_PROPOSAL", "POST_MULTI_PYTH", "POST_PYTH", "PROGRAM_CONFIG_INIT", "PROGRAM_CONFIG_SET_AUTH", "PROGRAM_CONFIG_SET_CREATION_FEE", "PROGRAM_CONFIG_SET_TREASURY", "PROPOSE_LOAN", "PRUNE_ORDERS", "REALLOC_CLUSTER_HISTORY_ACCOUNT", "REALLOC_VALIDATOR_HISTORY_ACCOUNT", "REBORROW_SOL_FOR_NFT", "RECORD_RARITY_POINTS", "REDEEM_CONDITIONAL_TOKENS", "REDEEM_FEES", "REDEEM_RESERVE_COLLATERAL", "REDUCE_ORDER", "REFILL", "REFINANCE_FBOND_BY_LENDER", "REFINANCE_PERPETUAL_LOAN", "REFINANCE_TO_BOND_OFFERS_V2", "REFINANCE_TO_BOND_OFFERS_V2_CNFT", "REFRESH_FARM", "REFRESH_FARMER", "REFRESH_OBLIGATION", "REFRESH_OBLIGATION_FARMS_FOR_RESERVE", "REFRESH_RESERVE", "REFRESH_RESERVES_BATCH", "REFRESH_USER_STATE", "REJECT_PROPOSAL", "REJECT_SWAP", "REJECT_TRANSACTION", "REMOVE_ALL_LIQUIDITY", "REMOVE_BALANCE_LIQUIDITY", "REMOVE_BOND_OFFER_V2", "REMOVE_FROM_POOL", "REMOVE_FROM_WHITELIST", "REMOVE_LIQUIDITY", "REMOVE_LIQUIDITY_BY_RANGE", "REMOVE_LIQUIDITY_SINGLE_SIDE", "REMOVE_MEMBER", "REMOVE_MEMBER_AND_CHANGE_THRESHOLD", "REMOVE_PERPETUAL_OFFER", "REMOVE_SPENDING_LIMIT", "REMOVE_TRAIT", "REMOVE_TRAIT_AUTHORITY", "REPAY", "REPAY_CNFT_PERPETUAL_LOAN", "REPAY_COMPRESSED", "REPAY_FBOND_TO_TRADE_TRANSACTIONS", "REPAY_FBOND_TO_TRADE_TRANSACTIONS_CNFT", "REPAY_FLASH_LOAN", "REPAY_LOAN", "REPAY_OBLIGATION_LIQUIDITY", "REPAY_PARTIAL_PERPETUAL_LOAN", "REPAY_PERPETUAL_LOAN", "REPAY_STAKED_BANX", "REPAY_STAKED_BANX_PERPETUAL_LOAN", "REQUEST_ELEVATION_GROUP", "REQUEST_LOAN", "REQUEST_PNFT_MIGRATION", "REQUEST_SEAT", "REQUEST_SEAT_AUTHORIZED", "RESCIND_LOAN", "REVOKE", "REWARD_USER_ONCE", "SELL_LOAN", "SELL_NFT", "SELL_STAKED_BANX_TO_OFFERS", "SET_ACTIVATION_POINT", "SET_AUTHORITY", "SET_BANK_FLAGS", "SET_COLLECT_PROTOCOL_FEES_AUTHORITY", "SET_CONFIG_AUTH", "SET_CONFIG_EXTENSION_AUTHORITY", "SET_DEFAULT_FEE_RATE", "SET_DEFAULT_PROTOCOL_FEE_RATE", "SET_DELEGATE", "SET_FEE_AUTHORITY", "SET_FEE_RATE", "SET_MARKET_EXPIRED", "SET_NEW_ADMIN", "SET_NEW_ORACLE_AUTHORITY", "SET_NEW_TIP_DISTRIBUTION_PROGRAM", "SET_PARAMS", "SET_POOL_FEES", "SET_PRE_ACTIVATION_DURATION", "SET_PRE_ACTIVATION_SWAP_ADDRESS", "SET_PROTOCOL_FEE_RATE", "SET_RENT_COLLECTOR", "SET_REWARD_AUTHORITY", "SET_REWARD_AUTHORITY_BY_SUPER_AUTHORITY", "SET_REWARD_EMISSIONS", "SET_REWARD_EMISSIONS_SUPER_AUTHORITY", "SET_REWARD_EMISSIONS_V2", "SET_STAKE_DELEGATED", "SET_TIME_LOCK", "SET_TOKEN_BADGE_AUTHORITY", "SET_VAULT_LOCK", "SET_WHITELISTED_VAULT", "SETTLE_CONDITIONAL_VAULT", "SETTLE_FUNDS", "SETTLE_FUNDS_EXPIRED", "SETTLE_PNL", "SOCIALIZE_LOSS", "SPLIT_STAKE", "STAKE", "STAKE_BANX", "STAKE_SOL", "STAKE_TOKEN", "START_PNFT_MIGRATION", "STUB_ID_BUILD", "STUB_ORACLE_CLOSE", "STUB_ORACLE_CREATE", "STUB_ORACLE_SET", "SWAP", "SWAP_EXACT_OUT", "SWAP_WITH_PRICE_IMPACT", "SWEEP_FEES", "SWITCH_FOX", "SWITCH_FOX_REQUEST", "SYNC_LIQUIDITY", "TAKE_COMPRESSED_LOAN", "TAKE_FLASH_LOAN", "TAKE_LOAN", "TAKE_MORTGAGE", "TERMINATE_PERPETUAL_LOAN", "THAW", "TOGGLE_PAIR_STATUS", "TOKEN_MINT", "TOPUP", "TRANSFER", "TRANSFER_OWNERSHIP", "TRANSFER_PAYMENT", "TRANSFER_PAYMENT_TREE", "TRANSFER_RECIPIENT", "UNFREEZE", "UNKNOWN", "UNLABELED", "UNPAUSE", "UNSTAKE", "UNSTAKE_BANX", "UNSTAKE_SOL", "UNSTAKE_TOKEN", "UNSUB_OR_HARVEST_WEEKS", "UNSUB_OR_HARVEST_WEEKS_ENHANCED", "UPDATE", "UPDATE_ACTIVATION_POINT", "UPDATE_BANK_MANAGER", "UPDATE_BOND_OFFER_STANDARD", "UPDATE_CLASS_VARIANT_AUTHORITY", "UPDATE_CLASS_VARIANT_METADATA", "UPDATE_COLLECTION", "UPDATE_COLLECTION_OR_CREATOR", "UPDATE_CONFIG", "UPDATE_EXTERNAL_PRICE_ACCOUNT", "UPDATE_FARM", "UPDATE_FARM_ADMIN", "UPDATE_FARM_CONFIG", "UPDATE_FEE_PARAMETERS", "UPDATE_FEES_AND_REWARDS", "UPDATE_FLOOR", "UPDATE_GLOBAL_CONFIG", "UPDATE_GLOBAL_CONFIG_ADMIN", "UPDATE_HADO_MARKET_FEE", "UPDATE_INTEREST_PERPETUAL_MARKET", "UPDATE_ITEM", "UPDATE_LENDING_MARKET", "UPDATE_LENDING_MARKET_OWNER", "UPDATE_OFFER", "UPDATE_ORDER", "UPDATE_PERPETUAL_MARKET", "UPDATE_PERPETUAL_OFFER", "UPDATE_POOL", "UPDATE_POOL_COLLECTIONS", "UPDATE_POOL_MORTGAGE", "UPDATE_POOL_STATUS", "UPDATE_POOL_WHITELIST", "UPDATE_POSITION_OPERATOR", "UPDATE_PRICING_V2", "UPDATE_PRIMARY_SALE_METADATA", "UPDATE_RAFFLE", "UPDATE_RECORD_AUTHORITY_DATA", "UPDATE_RESERVE_CONFIG", "UPDATE_REWARD_DURATION", "UPDATE_REWARD_FUNDER", "UPDATE_STAKE_HISTORY", "UPDATE_STAKING_SETTINGS", "UPDATE_STATS", "UPDATE_TRAIT_VARIANT", "UPDATE_TRAIT_VARIANT_AUTHORITY", "UPDATE_TRAIT_VARIANT_METADATA", "UPDATE_USABLE_AMOUNT", "UPDATE_VARIANT", "UPDATE_VAULT_OWNER", "UPGRADE_FOX", "UPGRADE_FOX_REQUEST", "UPGRADE_PROGRAM_INSTRUCTION", "UPLOAD_MERKLE_ROOT", "USE_SPENDING_LIMIT", "VALIDATE_SAFETY_DEPOSIT_BOX_V2", "VERIFY_PAYMENT_MINT", "VERIFY_PAYMENT_MINT_TEST", "VOTE", "WHITELIST_CREATOR", "WITHDRAW", "WITHDRAW_FROM_BOND_OFFER_STANDARD", "WITHDRAW_FROM_FARM_VAULT", "WITHDRAW_GEM", "WITHDRAW_INELIGIBLE_REWARD", "WITHDRAW_LIQUIDITY", "WITHDRAW_OBLIGATION_COLLATERAL", "WITHDRAW_OBLIGATION_COLLATERAL_AND_REDEEM_RESERVE_COLLATERAL", "WITHDRAW_PROTOCOL_FEE", "WITHDRAW_PROTOCOL_FEES", "WITHDRAW_REFERRER_FEES", "WITHDRAW_REWARD", "WITHDRAW_REWARDS_FROM_VAULT", "WITHDRAW_SLASHED_AMOUNT", "WITHDRAW_SOL_FROM_FLASH_LOAN_POOL", "WITHDRAW_TREASURY", "WITHDRAW_UNSTAKED_DEPOSITS" ] }, "EnhancedApi_NFTEventType": { "type": "string", "enum": [ "NFT_BID", "NFT_BID_CANCELLED", "NFT_GLOBAL_BID", "NFT_GLOBAL_BID_CANCELLED", "NFT_LISTING", "NFT_CANCEL_LISTING", "NFT_SALE", "NFT_MINT", "NFT_MINT_REJECTED", "NFT_AUCTION_CREATED", "NFT_AUCTION_UPDATED", "NFT_AUCTION_CANCELLED", "NFT_PARTICIPATION_REWARD", "BURN_NFT", "NFT_RENT_LISTING", "NFT_RENT_CANCEL_LISTING", "NFT_RENT_UPDATE_LISTING", "NFT_RENT_ACTIVATE", "NFT_RENT_END", "ATTACH_METADATA", "MIGRATE_TO_PNFT", "CREATE_POOL" ] }, "EnhancedApi_CompressedNFTEventType": { "type": "string", "enum": [ "CREATE_MERKLE_TREE", "COMPRESSED_NFT_MINT", "COMPRESSED_NFT_TRANSFER", "COMPRESSED_NFT_REDEEM", "COMPRESSED_NFT_CANCEL_REDEEM", "COMPRESSED_NFT_BURN", "COMPRESSED_NFT_DELEGATE" ] }, "EnhancedApi_TransactionSource": { "type": "string", "enum": [ "FORM_FUNCTION", "EXCHANGE_ART", "CANDY_MACHINE_V3", "CANDY_MACHINE_V2", "CANDY_MACHINE_V1", "UNKNOWN", "SOLANART", "SOLSEA", "MAGIC_EDEN", "HOLAPLEX", "METAPLEX", "OPENSEA", "SOLANA_PROGRAM_LIBRARY", "ANCHOR", "PHANTOM", "SYSTEM_PROGRAM", "STAKE_PROGRAM", "COINBASE", "CORAL_CUBE", "HEDGE", "LAUNCH_MY_NFT", "GEM_BANK", "GEM_FARM", "DEGODS", "BSL", "YAWWW", "ATADIA", "DIGITAL_EYES", "HYPERSPACE", "TENSOR", "BIFROST", "JUPITER", "MERCURIAL", "SABER", "SERUM", "STEP_FINANCE", "CROPPER", "RAYDIUM", "ALDRIN", "CREMA", "LIFINITY", "CYKURA", "ORCA", "MARINADE", "STEPN", "SENCHA", "SAROS", "ENGLISH_AUCTION", "FOXY", "HADESWAP", "FOXY_STAKING", "FOXY_RAFFLE", "FOXY_TOKEN_MARKET", "FOXY_MISSIONS", "FOXY_MARMALADE", "FOXY_COINFLIP", "FOXY_AUCTION", "CITRUS", "ZETA", "ELIXIR", "ELIXIR_LAUNCHPAD", "CARDINAL_RENT", "CARDINAL_STAKING", "BPF_LOADER", "BPF_UPGRADEABLE_LOADER", "SQUADS", "SHARKY_FI", "OPEN_CREATOR_PROTOCOL", "BUBBLEGUM", "NOVA", "D_READER", "RAINDROPS", "W_SOL", "DUST", "SOLI", "USDC", "FLWR", "HDG", "MEAN", "UXD", "SHDW", "POLIS", "ATLAS", "USH", "TRTLS", "RUNNER", "INVICTUS" ] }, "EnhancedApi_SaleType": { "type": "string", "enum": [ "AUCTION", "INSTANT_SALE", "OFFER", "GLOBAL_OFFER", "MINT", "UNKNOWN" ] }, "EnhancedApi_Token": { "type": "object", "properties": { "mint": { "type": "string", "example": "DsfCsbbPH77p6yeLS1i4ag9UA5gP9xWSvdCx72FJjLsx", "description": "The mint account of the token." }, "tokenStandard": { "$ref": "#/components/schemas/EnhancedApi_TokenStandard" } } }, "EnhancedApi_TokenStandard": { "type": "string", "enum": [ "NonFungible", "FungibleAsset", "Fungible", "NonFungibleEdition" ] }, "EnhancedApi_TokenTransfer": { "type": "object", "properties": { "fromUserAccount": { "type": "string", "description": "The user account the tokens are sent from." }, "toUserAccount": { "type": "string", "description": "The user account the tokens are sent to." }, "fromTokenAccount": { "type": "string", "description": "The token account the tokens are sent from." }, "toTokenAccount": { "type": "string", "description": "The token account the tokens are sent to." }, "tokenAmount": { "type": "number", "description": "The number of tokens sent." }, "mint": { "type": "string", "description": "The mint account of the token.", "example": "DsfCsbbPH77p6yeLS1i4ag9UA5gP9xWSvdCx72FJjLsx" } } }, "EnhancedApi_NativeTransfer": { "type": "object", "properties": { "fromUserAccount": { "type": "string", "description": "The user account the sol is sent from." }, "toUserAccount": { "type": "string", "description": "The user account the sol is sent to." }, "amount": { "type": "integer", "description": "The amount of sol sent (in lamports)." } } }, "EnhancedApi_TokenMetadataResponse": { "type": "object", "description": "Metaplex metadata stored both on-chain and off-chain.", "properties": { "mint": { "type": "string" }, "onChainData": { "$ref": "#/components/schemas/EnhancedApi_OnChainMetadata" }, "offChainData": { "$ref": "#/components/schemas/EnhancedApi_OffChainMetadata" } } }, "EnhancedApi_OnChainMetadata": { "type": "object", "description": "Metaplex metadata that is stored on-chain.", "properties": { "key": { "type": "string" }, "mint": { "type": "string" }, "updateAuthority": { "type": "string" }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "uri": { "type": "string" }, "sellerFeeBasisPoints": { "type": "integer" }, "creators": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "share": { "type": "string" }, "verified": { "type": "boolean" } } } } } }, "tokenStandard": { "type": "string" }, "primarySaleHappened": { "type": "boolean" }, "isMutable": { "type": "boolean" }, "editionNonce": { "type": "integer" }, "collection": { "type": "object", "properties": { "key": { "type": "string" }, "verified": { "type": "boolean" } } }, "collectionDetails": { "type": "object", "properties": { "size": { "type": "integer" } } }, "uses": { "type": "object", "properties": { "useMethod": { "type": "string" }, "remaining": { "type": "integer" }, "total": { "type": "integer" } } } } }, "EnhancedApi_OffChainMetadata": { "type": "object", "description": "Metaplex metadata that is stored off-chain.", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "attributes": { "type": "array", "items": { "properties": { "traitType": { "type": "string" }, "value": { "type": "string" } } } }, "sellerFeeBasisPoints": { "type": "integer" }, "image": { "type": "string" }, "properties": { "type": "object", "properties": { "category": { "type": "string" }, "files": { "type": "array", "items": { "properties": { "uri": { "type": "string" }, "type": { "type": "string" } } } }, "creators": { "type": "array", "items": { "properties": { "address": { "type": "string" }, "share": { "type": "string" } } } } } } } }, "EnhancedApi_RawTransaction": { "type": "object", "properties": { "slot": { "type": "integer" }, "blocktime": { "type": "integer" }, "transaction": { "$ref": "#/components/schemas/EnhancedApi_InnerTransaction" }, "meta": { "$ref": "#/components/schemas/EnhancedApi_Meta" } } }, "EnhancedApi_InnerTransaction": { "type": "object", "properties": { "signatures": { "type": "array", "items": { "type": "string" } }, "message": { "type": "object", "properties": { "accountKeys": { "type": "array", "items": { "type": "string" } }, "header": { "type": "object" }, "recentBlockhash": { "type": "string" }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "programIdIndex": { "type": "integer" }, "accounts": { "type": "array", "items": { "type": "integer" } }, "data": { "type": "string" } } } } } } } }, "EnhancedApi_Meta": { "type": "object", "properties": { "err": { "type": "object" }, "fee": { "type": "integer" }, "preBalances": { "type": "array", "items": { "type": "integer" } }, "postBalances": { "type": "array", "items": { "type": "integer" } }, "preTokenBalances": { "type": "array", "items": { "type": "integer" } }, "postTokenBalances": { "type": "array", "items": { "type": "integer" } }, "logMessages": { "type": "array", "items": { "type": "string" } }, "rewards": { "type": "array", "items": { "type": "object" } }, "loadedAddresses": { "type": "object" } } }, "EnhancedApi_EnhancedTransaction": { "type": "object", "properties": { "description": { "type": "string", "example": "Human readable interpretation of the transaction" }, "type": { "$ref": "#/components/schemas/EnhancedApi_TransactionType" }, "source": { "$ref": "#/components/schemas/EnhancedApi_TransactionSource" }, "fee": { "type": "integer", "example": 5000 }, "feePayer": { "type": "string", "example": "8cRrU1NzNpjL3k2BwjW3VixAcX6VFc29KHr4KZg8cs2Y" }, "signature": { "type": "string", "example": "yy5BT9benHhx8fGCvhcAfTtLEHAtRJ3hRTzVL16bdrTCWm63t2vapfrZQZLJC3RcuagekaXjSs2zUGQvbcto8DK" }, "slot": { "type": "integer", "example": 148277128 }, "timestamp": { "type": "integer", "example": 1656442333 }, "nativeTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NativeTransfer" } }, "tokenTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenTransfer" } }, "accountData": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_AccountData" } }, "transactionError": { "type": "object", "properties": { "error": { "type": "string" } } }, "instructions": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_Instruction" } }, "events": { "type": "object", "properties": { "nft": { "$ref": "#/components/schemas/EnhancedApi_NFTEvent" }, "swap": { "$ref": "#/components/schemas/EnhancedApi_SwapEvent" }, "compressed": { "$ref": "#/components/schemas/EnhancedApi_CompressedNFTEvent" }, "distributeCompressionRewards": { "$ref": "#/components/schemas/EnhancedApi_DistributeCompressionRewardsEvent" }, "setAuthority": { "$ref": "#/components/schemas/EnhancedApi_SetAuthorityEvent" } }, "description": "Events associated with this transaction. These provide fine-grained information about the transaction. They match the types returned from the event APIs." } } }, "EnhancedApi_Instruction": { "type": "object", "description": "Individual instruction data in a transaction.", "properties": { "accounts": { "type": "array", "description": "The accounts used in instruction.", "items": { "type": "string", "example": "8uX6yiUuH4UjUb1gMGJAdkXorSuKshqsFGDCFShcK88B" } }, "data": { "type": "string", "description": "Data passed into the instruction", "example": "kdL8HQJrbbvQRGXmoadaja1Qvs" }, "programId": { "type": "string", "description": "Program used in instruction", "example": "MEisE1HzehtrDpAAT8PnLHjpSSkRYakotTuJRPjTpo8" }, "innerInstructions": { "type": "array", "description": "Inner instructions used in instruction", "items": { "$ref": "#/components/schemas/EnhancedApi_InnerInstruction" } } } }, "EnhancedApi_InnerInstruction": { "type": "object", "description": "Inner instructions for each instruction", "properties": { "accounts": { "type": "array", "items": { "type": "string" } }, "data": { "type": "string" }, "programId": { "type": "string" } } }, "EnhancedApi_AccountData": { "type": "object", "description": "Sol and token transfers involving the account are referenced in this object.", "properties": { "account": { "type": "string", "description": "The account that this data is provided for." }, "nativeBalanceChange": { "type": "number", "description": "Native (SOL) balance change of the account." }, "tokenBalanceChanges": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenBalanceChange" }, "description": "Token balance changes of the account." } } }, "EnhancedApi_NFTEvent": { "type": "object", "properties": { "description": { "type": "string", "description": "Human readable interpretation of the transaction" }, "type": { "$ref": "#/components/schemas/EnhancedApi_NFTEventType" }, "source": { "$ref": "#/components/schemas/EnhancedApi_TransactionSource" }, "amount": { "type": "integer", "example": 1000000, "description": "The amount of the NFT transaction (in lamports)." }, "fee": { "type": "integer", "example": 5000 }, "feePayer": { "type": "string", "example": "8cRrU1NzNpjL3k2BwjW3VixAcX6VFc29KHr4KZg8cs2Y" }, "signature": { "type": "string", "example": "4jzQxVTaJ4Fe4Fct9y1aaT9hmVyEjpCqE2bL8JMnuLZbzHZwaL4kZZvNEZ6bEj6fGmiAdCPjmNQHCf8v994PAgDf" }, "slot": { "type": "integer", "example": 148277128 }, "timestamp": { "type": "integer", "example": 1656442333 }, "saleType": { "$ref": "#/components/schemas/EnhancedApi_SaleType" }, "buyer": { "type": "string", "description": "The buyer of the NFT." }, "seller": { "type": "string", "description": "The seller of the NFT." }, "staker": { "type": "string", "description": "The staker of the NFT." }, "nfts": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_Token" }, "description": "NFTs that are a part of this NFT event." } } }, "EnhancedApi_CompressedNFTEvent": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/EnhancedApi_CompressedNFTEventType" }, "treeId": { "type": "string", "description": "The address of the related merkle tree." }, "assetId": { "type": "string", "description": "The id of the compressed nft." }, "leafIndex": { "type": "integer", "description": "The index of the leaf being appended or modified." }, "instructionIndex": { "type": "integer", "description": "The index of the parsed instruction in the transaction." }, "innerInstructionIndex": { "type": "integer", "description": "The index of the parsed inner instruction in the transaction." }, "newLeafOwner": { "type": "string", "description": "The new owner of the leaf." }, "oldLeafOwner": { "type": "string", "description": "The previous owner of the leaf." } } }, "EnhancedApi_DistributeCompressionRewardsEvent": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Amount transfered in the DistributeCompressionRewardsV0 instruction." } } }, "EnhancedApi_SetAuthorityEvent": { "type": "object", "properties": { "account": { "type": "string", "description": "Tthe account whose authority is changing." }, "from": { "type": "string", "description": "Current authority." }, "to": { "type": "string", "description": "New authority." }, "instructionIndex": { "type": "integer", "description": "The index of the parsed instruction in the transaction." }, "innerInstructionIndex": { "type": "integer", "description": "The index of the parsed inner instruction in the transaction." } } }, "EnhancedApi_SwapEvent": { "type": "object", "properties": { "nativeInput": { "$ref": "#/components/schemas/EnhancedApi_NativeBalanceChange", "description": "The native input to the swap in Lamports." }, "nativeOutput": { "$ref": "#/components/schemas/EnhancedApi_NativeBalanceChange", "description": "The native output of the swap in Lamports." }, "tokenInputs": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenBalanceChange" }, "description": "The token inputs to the swap." }, "tokenOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenBalanceChange" }, "description": "The token outputs of the swap." }, "tokenFees": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenBalanceChange" }, "description": "The token fees paid by an account." }, "nativeFees": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NativeBalanceChange" }, "description": "The native fees paid by an account." }, "innerSwaps": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenSwap" }, "description": "The inner swaps occurring to make this swap happen. Eg. a swap of wSOL <-> USDC may be make of multiple swaps from wSOL <-> DUST, DUST <-> USDC" } } }, "EnhancedApi_TokenSwap": { "type": "object", "properties": { "tokenInputs": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenTransfer" }, "description": "The token inputs of this swap." }, "tokenOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenTransfer" }, "description": "The token outputs of this swap." }, "tokenFees": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenTransfer" }, "description": "Fees charged with tokens for this swap." }, "nativeFees": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NativeTransfer" }, "description": "Fees charged in SOL for this swap." }, "programInfo": { "$ref": "#/components/schemas/EnhancedApi_ProgramInfo", "description": "Information about the program creating this swap." } } }, "EnhancedApi_ProgramInfo": { "type": "object", "properties": { "source": { "type": "string", "example": "ORCA" }, "account": { "type": "string", "description": "The account of the program", "example": "whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc" }, "programName": { "type": "string", "description": "The name of the program", "example": "ORCA_WHIRLPOOLS" }, "instructionName": { "type": "string", "description": "The name of the instruction creating this swap. It is the value of instruction name from the Anchor IDL, if it is available.", "example": "whirlpoolSwap" } } }, "EnhancedApi_NativeBalanceChange": { "type": "object", "properties": { "account": { "type": "string", "description": "The account the native balance change is for", "example": "2uySTNgvGT2kwqpfgLiSgeBLR3wQyye1i1A2iQWoPiFr" }, "amount": { "type": "string", "description": "The amount of the balance change as a string", "example": "100000000" } } }, "EnhancedApi_TokenBalanceChange": { "type": "object", "properties": { "userAccount": { "type": "string", "example": "F54ZGuxyb2gA7vRjzWKLWEMQqCfJxDY1whtqtjdq4CJ" }, "tokenAccount": { "type": "string", "example": "2kvmbRybhrcptDnwyNv6oiFGFEnRVv7MvVyqsxkirgdn" }, "mint": { "type": "string", "example": "DUSTawucrTsGU8hcqRdHDCbuYhCPADMLM2VcCb8VnFnQ" }, "rawTokenAmount": { "$ref": "#/components/schemas/EnhancedApi_RawTokenAmount" } } }, "EnhancedApi_RawTokenAmount": { "type": "object", "properties": { "tokenAmount": { "type": "string" }, "decimals": { "type": "integer" } } }, "EnhancedApi_NamesResponse": { "type": "object", "properties": { "domainNames": { "type": "array", "items": { "type": "string" } } } }, "EnhancedApi_BalancesResponse": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_Balance" } }, "nativeBalance": { "type": "number", "description": "In Lamports" } } }, "EnhancedApi_Balance": { "type": "object", "properties": { "mint": { "type": "string" }, "amount": { "type": "number" }, "decimals": { "type": "number" }, "tokenAccount": { "type": "string" } } }, "EnhancedApi_NFTsResponse": { "type": "object", "properties": { "numberOfPages": { "type": "number" }, "nfts": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_Asset" } } } }, "EnhancedApi_Asset": { "type": "object", "properties": { "name": { "type": "string" }, "tokenAddress": { "type": "string" }, "collectionAddress": { "type": "string" }, "collectionName": { "type": "string" }, "imageURL": { "type": "string" }, "traits": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } } } }, "EnhancedApi_Commitment": { "type": "string", "enum": [ "finalized", "confirmed" ] }, "EnhancedApi_TokensMetadataRequest": { "type": "object", "properties": { "mintAccounts": { "type": "array", "items": { "type": "string", "description": "The mint account of the token to retrieve metadata for." }, "maxItems": 100 } } }, "EnhancedApi_ParseTransactionsRequest": { "type": "object", "properties": { "transactions": { "type": "array", "default": [ "4jzQxVTaJ4Fe4Fct9y1aaT9hmVyEjpCqE2bL8JMnuLZbzHZwaL4kZZvNEZ6bEj6fGmiAdCPjmNQHCf8v994PAgDf" ], "items": { "type": "string", "description": "The transaction IDs/signatures to parse for." }, "maxItems": 100 } } }, "EnhancedApi_CreateWebhookRequest": { "type": "object", "properties": { "webhookURL": { "type": "string" }, "transactionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TransactionType" } }, "accountAddresses": { "type": "array", "items": { "type": "string" }, "maxItems": "100_000" }, "webhookType": { "$ref": "#/components/schemas/EnhancedApi_WebhookType" }, "authHeader": { "type": "string" }, "encoding": { "type": "string" }, "txnStatus": { "type": "string" } } }, "EnhancedApi_RpcProxyRequest": { "type": "object", "properties": { "method": { "type": "string", "description": "Name of the method to be invoked", "example": "getBlock" }, "params": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array", "items": {} }, { "type": "object" } ] }, "description": "Params to be passed. Please see Solana JSON-RPC docs." } } }, "EnhancedApi_QueryNftEventsRequest": { "type": "object", "properties": { "query": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "string", "example": "79FjnnXFpSajugwpx3FfQbV7hJJTe7QXAusF7R4CMf6c", "maxItems": 100 } }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NFTEventType" } }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TransactionSource" } }, "startSlot": { "type": "integer", "example": 162368570, "description": "Earliest slot to include in the query (inclusive). Cannot be combined with \"startTime\"." }, "endSlot": { "type": "integer", "example": 162368580, "description": "Latest slot to include in the query (inclusive). Cannot be combined with \"endTime\"." }, "startTime": { "type": "integer", "example": 1669055189, "description": "Earliest event time (unix seconds). Cannot be combined with \"startSlot\"." }, "endTime": { "type": "integer", "example": 1669070189, "description": "Latest event time (unix seconds). Cannot be combined with \"endSlot\"." }, "nftCollectionFilters": { "type": "object", "properties": { "firstVerifiedCreator": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_FirstVerifiedCreator" } }, "verifiedCollectionAddress": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_VerifiedCollectionAddress" } } } } } }, "options": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of items to return. Must be between 1 and 1000. Default is 100.", "minimum": 1, "maximum": 1000, "default": 100 }, "sortOrder": { "$ref": "#/components/schemas/EnhancedApi_SortOrder" }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } } } }, "EnhancedApi_QueryNftEventsResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NftEventV2" } }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } }, "EnhancedApi_DescribeNftsRequest": { "type": "object", "properties": { "mints": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NftMintAccount" } } } }, "EnhancedApi_DescribeNftsResponse": { "type": "array", "items": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/EnhancedApi_NftMintAccount" }, "name": { "$ref": "#/components/schemas/EnhancedApi_NftName" }, "burned": { "$ref": "#/components/schemas/EnhancedApi_NftBurned" }, "firstVerifiedCreator": { "$ref": "#/components/schemas/EnhancedApi_FirstVerifiedCreator" }, "verifiedCollectionAddress": { "$ref": "#/components/schemas/EnhancedApi_VerifiedCollectionAddress" }, "activeListings": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_ActiveListing" } } } } }, "EnhancedApi_MintlistRequest": { "type": "object", "properties": { "query": { "type": "object", "properties": { "firstVerifiedCreators": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_FirstVerifiedCreator" } }, "verifiedCollectionAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_VerifiedCollectionAddress" } } } }, "options": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of items to return. Must be between 1 and 10,000. Default is 1000.", "minimum": 1, "maximum": "10_000", "default": 1000 }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } } } }, "EnhancedApi_MintlistResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/EnhancedApi_NftMintAccount" }, "name": { "$ref": "#/components/schemas/EnhancedApi_NftName" } } } }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } }, "EnhancedApi_ActiveListingsRequest": { "type": "object", "properties": { "query": { "type": "object", "properties": { "marketplaces": { "items": { "$ref": "#/components/schemas/EnhancedApi_Marketplace" } }, "firstVerifiedCreators": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_FirstVerifiedCreator" } }, "verifiedCollectionAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_VerifiedCollectionAddress" } } } }, "options": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of items to return. Must be between 1 and 1000. Default is 100.", "minimum": 1, "maximum": 1000, "default": 100 }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } } } }, "EnhancedApi_ActiveListingsResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/EnhancedApi_NftMintAccount" }, "name": { "$ref": "#/components/schemas/EnhancedApi_NftName" }, "firstVerifiedCreator": { "$ref": "#/components/schemas/EnhancedApi_FirstVerifiedCreator" }, "verifiedCollectionAddress": { "$ref": "#/components/schemas/EnhancedApi_VerifiedCollectionAddress" }, "activeListings": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_ActiveListing" } } } } }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } }, "EnhancedApi_SortOrder": { "type": "string", "description": "Order of the returned results. Must be 'ASC' or 'DESC'. Results are descending by default.", "enum": [ "ASC", "DESC" ], "default": "DESC" }, "EnhancedApi_NftEventV2": { "type": "object", "properties": { "description": { "type": "string", "description": "Human readable interpretation of the transaction" }, "type": { "$ref": "#/components/schemas/EnhancedApi_NFTEventType" }, "source": { "$ref": "#/components/schemas/EnhancedApi_TransactionSource" }, "amount": { "type": "integer", "example": 1000000, "description": "The amount of the NFT transaction (in lamports)." }, "fee": { "type": "integer", "example": 5000 }, "feePayer": { "type": "string", "example": "8cRrU1NzNpjL3k2BwjW3VixAcX6VFc29KHr4KZg8cs2Y" }, "signature": { "type": "string", "example": "4jzQxVTaJ4Fe4Fct9y1aaT9hmVyEjpCqE2bL8JMnuLZbzHZwaL4kZZvNEZ6bEj6fGmiAdCPjmNQHCf8v994PAgDf" }, "slot": { "type": "integer", "example": 148277128 }, "timestamp": { "type": "integer", "example": 1656442333 }, "saleType": { "$ref": "#/components/schemas/EnhancedApi_SaleType" }, "buyer": { "type": "string", "description": "The buyer of the NFT." }, "seller": { "type": "string", "description": "The seller of the NFT." }, "staker": { "type": "string", "description": "The staker of the NFT." }, "nfts": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NftV2" }, "description": "Associated NFTs" }, "nativeTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_NativeTransfer" } }, "tokenTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_TokenTransfer" } } } }, "EnhancedApi_NftV2": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/EnhancedApi_NftMintAccount" }, "name": { "$ref": "#/components/schemas/EnhancedApi_NftName" }, "burned": { "$ref": "#/components/schemas/EnhancedApi_NftBurned" }, "firstVerifiedCreator": { "$ref": "#/components/schemas/EnhancedApi_FirstVerifiedCreator" }, "verifiedCollectionAddress": { "$ref": "#/components/schemas/EnhancedApi_VerifiedCollectionAddress" } } }, "EnhancedApi_NftMintAccount": { "type": "string", "description": "NFT mint account address.", "example": "KG6f4Fa6YxAW8cG2Dhb18DiMn3rQ3rSLa1Eo2FYM4gi" }, "EnhancedApi_NftName": { "type": "string", "description": "The name of the NFT.", "example": "y00t #2940" }, "EnhancedApi_NftBurned": { "type": "boolean", "description": "If the NFT was was burned. Burned NFTs have no name, firstVerifiedCreator, or verifiedCollectionAddress.", "example": false }, "EnhancedApi_FirstVerifiedCreator": { "type": "string", "description": "First verified creator of the NFT. Used to reference NFT collections.", "example": "A4FM6h8T5Fmh9z2g3fKUrKfZn6BNFEgByR8QGpdbQhk1" }, "EnhancedApi_VerifiedCollectionAddress": { "type": "string", "description": "Verified Metaplex collection address. Does not exist for all NFT collections.", "example": "4mKSoDDqApmF1DqXvVTSL6tu2zixrSSNjqMxUnwvVzy2" }, "EnhancedApi_ActiveListing": { "type": "object", "properties": { "transactionSignature": { "type": "string", "description": "Signature of the listing transaction.", "example": "27W41DrnxGFJGX7yEGuKBtRb7oMwFdGdPwffBTTeakV8nTQTgWR2hzFKmrt8QnxaMEbw4pS2NoiLmiuB2VfqxVn7" }, "marketplace": { "$ref": "#/components/schemas/EnhancedApi_Marketplace" }, "amount": { "type": "integer", "example": 1000000, "description": "Listed price of the NFT (in lamports)." }, "seller": { "type": "string", "description": "Address of the NFT seller.", "example": "3ngLS7Y64DoMAHJ6k6XYh8vo5nSiG66AP1yLvbckfKrc" } } }, "EnhancedApi_Marketplace": { "type": "string", "description": "Marketplace where the NFT is being listed.", "example": "MAGIC_EDEN", "enum": [ "MAGIC_EDEN", "OPENSEA", "FORM_FUNCTION", "EXCHANGE_ART", "SOLANART", "SOLSEA", "HOLAPLEX", "CORAL_CUBE", "YAWWW", "SOLPORT", "HYPERSPACE", "DIGITAL_EYES", "CORAL_CUBE", "UNKNOWN" ] }, "EnhancedApi_PaginationToken": { "type": "string", "description": "Token used for pagination. Provide the token to the API to retrieve the results from the next page. If no token exists, the query has no results remaining.", "example": "V1_162262948_99" }, "EnhancedApi_RawTransactionsV1Request": { "type": "object", "properties": { "query": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "string", "example": "CyFyz1xR4YTG9CrY9jg5jG6GZfm2e8k97qscs2GFpjX1", "description": "Array of accounts to find transactions for. Limit of 1000 accounts\"." } }, "startSlot": { "type": "integer", "example": 162368570, "description": "Earliest slot to include in the query (inclusive). Cannot be combined with \"startTime\"." }, "endSlot": { "type": "integer", "example": 162368580, "description": "Latest slot to include in the query (inclusive). Cannot be combined with \"endTime\"." }, "startTime": { "type": "integer", "example": 1669055189, "description": "Earliest event time (unix seconds). Cannot be combined with \"startSlot\"." }, "endTime": { "type": "integer", "example": 1669070189, "description": "Latest event time (unix seconds). Cannot be combined with \"endSlot\"." } } }, "options": { "type": "object", "properties": { "limit": { "description": "Maximum number of items to return. Must be between 1 and 500. Default is 100.", "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "sortOrder": { "$ref": "#/components/schemas/EnhancedApi_SortOrder" }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } } } }, "EnhancedApi_RawTransactionsV1Response": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedApi_RawTransaction" } }, "paginationToken": { "$ref": "#/components/schemas/EnhancedApi_PaginationToken" } } }, "EnhancedApi_TokensMetadataRequestV1": { "type": "object", "properties": { "mintAccounts": { "type": "array", "items": { "type": "string", "description": "The mint account of the token to retrieve metadata for." }, "maxItems": 100 }, "includeOffChain": { "type": "boolean", "default": false, "description": "Include offchain data referenced in the uri of the metadata account. Omitting defaults to false." }, "disableCache": { "type": "boolean", "default": false, "description": "Disable usage of cache, useful for monitoring metadata changes." } } }, "EnhancedApi_TokensMetadataResponseV1": { "type": "array", "items": { "type": "object", "description": "Token metadata stored both on-chain and in the old token list.", "properties": { "account": { "type": "string" }, "onChainAccountInfo": { "$ref": "#/components/schemas/EnhancedApi_OnChainAccountInfoResult" }, "onChainMetadata": { "$ref": "#/components/schemas/EnhancedApi_OnChainMetadataResult" }, "offChainMetadata": { "$ref": "#/components/schemas/EnhancedApi_OffChainMetadataResult" }, "legacyMetadata": { "$ref": "#/components/schemas/EnhancedApi_LegacyMetadata" } } } }, "EnhancedApi_OnChainAccountInfoResult": { "type": "object", "properties": { "accountInfo": { "$ref": "#/components/schemas/EnhancedApi_OnChainAccountInfo" }, "error": { "$ref": "#/components/schemas/EnhancedApi_AccountErrorType" } } }, "EnhancedApi_OnChainMetadataResult": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/EnhancedApi_OnChainMetadata" }, "error": { "$ref": "#/components/schemas/EnhancedApi_AccountErrorType" } } }, "EnhancedApi_OffChainMetadataResult": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/EnhancedApi_OffChainMetadata" }, "uri": { "type": "string" }, "error": { "$ref": "#/components/schemas/EnhancedApi_AccountErrorType" } } }, "EnhancedApi_OnChainAccountInfo": { "type": "object", "description": "Account data that is stored on-chain.", "properties": { "key": { "type": "string" }, "isSigner": { "type": "boolean" }, "isWritable": { "type": "boolean" }, "lamports": { "type": "integer" }, "data": { "type": "object", "properties": { "parsed": { "type": "object", "properties": { "info": { "type": "object", "properties": { "decimals": { "type": "integer" }, "freezeAuthority": { "type": "string" }, "isInitialized": { "type": "boolean" }, "mintAuthority": { "type": "string" }, "supply": { "type": "string" } } }, "type": { "type": "string" } } }, "program": { "type": "string" }, "space": { "type": "integer" } } }, "owner": { "type": "string" }, "executable": { "type": "boolean" }, "rentEpoch": { "type": "integer" } } }, "EnhancedApi_LegacyMetadata": { "type": "object", "description": "Data from the old SPL token list.", "properties": { "chainId": { "type": "integer" }, "address": { "type": "string" }, "symbol": { "type": "string" }, "name": { "type": "string" }, "decimals": { "type": "integer" }, "logoURI": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "extensions": { "type": "object" } } }, "EnhancedApi_AccountErrorType": { "type": "string", "example": "", "enum": [ "UNKNOWN", "EMPTY_ACCOUNT", "TIMEOUT", "INVALID_ACCOUNT", "INVALID_PUBKEY" ] }, "Webhooks_Webhook": { "type": "object", "properties": { "webhookID": { "type": "string", "description": "Unique identifier for the webhook." }, "wallet": { "type": "string", "description": "The wallet address (API key owner) that created this webhook." }, "webhookURL": { "type": "string", "description": "The URL that receives webhook POST deliveries." }, "transactionTypes": { "type": "array", "description": "Transaction types that trigger this webhook. Only applies to enhanced webhooks.", "items": { "$ref": "#/components/schemas/Webhooks_TransactionType" } }, "accountAddresses": { "type": "array", "description": "Solana account addresses monitored by this webhook. Transactions involving any of these addresses trigger a delivery.", "items": { "type": "string" } }, "webhookType": { "$ref": "#/components/schemas/Webhooks_WebhookType" }, "authHeader": { "type": "string", "description": "Optional authorization header value included in webhook deliveries for verifying the sender." }, "active": { "type": "boolean", "description": "Whether the webhook is actively receiving deliveries. Defaults to true. Webhooks may be automatically disabled if the endpoint has a high failure rate." } } }, "Webhooks_ToggleWebhookRequest": { "type": "object", "required": [ "active" ], "properties": { "active": { "type": "boolean", "description": "Set to true to enable the webhook or false to disable it." } } }, "Webhooks_WebhookType": { "type": "string", "enum": [ "enhanced", "raw", "discord", "enhancedDevnet", "rawDevnet", "discordDevnet" ] }, "Webhooks_TransactionType": { "type": "string", "enum": [ "ANY", "ACCEPT_ESCROW_ARTIST", "ACCEPT_ESCROW_USER", "ACCEPT_PROPOSAL", "ACCEPT_REQUEST_ARTIST", "ACTIVATE_PROPOSAL", "ACTIVATE_TRANSACTION", "ACTIVATE_VAULT", "ADD_AUTHORITY", "ADD_BALANCE_LIQUIDITY", "ADD_BATCH_TRANSACTION", "ADD_IMBALANCE_LIQUIDITY", "ADD_INSTRUCTION", "ADD_ITEM", "ADD_LIQUIDITY", "ADD_LIQUIDITY_BY_STRATEGY", "ADD_LIQUIDITY_BY_STRATEGY_ONE_SIDE", "ADD_LIQUIDITY_BY_WEIGHT", "ADD_LIQUIDITY_ONE_SIDE", "ADD_LIQUIDITY_ONE_SIDE_PRECISE", "ADD_MEMBER", "ADD_MEMBER_AND_CHANGE_THRESHOLD", "ADD_METADATA", "ADD_PAYMENT_MINT_PAYMENT_METHOD", "ADD_RARITIES_TO_BANK", "ADD_REWARDS", "ADD_SPENDING_LIMIT", "ADD_TO_POOL", "ADD_TO_WHITELIST", "ADD_TOKEN_TO_VAULT", "ADD_TRAIT_CONFLICTS", "ADMIN_SYNC_LIQUIDITY", "APPROVE", "APPROVE_PROPOSAL", "APPROVE_TRANSACTION", "ATTACH_METADATA", "AUCTION_HOUSE_CREATE", "AUCTION_MANAGER_CLAIM_BID", "AUTHORIZE_FUNDER", "BACKFILL_TOTAL_BLOCKS", "BEGIN_TRAIT_UPDATE", "BEGIN_VARIANT_UPDATE", "BOOTSTRAP_LIQUIDITY", "BORROW_CNFT_PERPETUAL", "BORROW_FOX", "BORROW_OBLIGATION_LIQUIDITY", "BORROW_PERPETUAL", "BORROW_SOL_FOR_NFT", "BORROW_STAKED_BANX_PERPETUAL", "BOT_CLAIM_SALE", "BOT_DELIST", "BOT_LIQUIDATE", "BOT_LIQUIDATE_SELL", "BOT_UNFREEZE", "BOUND_HADO_MARKET_TO_FRAKT_MARKET", "BURN", "BURN_NFT", "BURN_PAYMENT", "BURN_PAYMENT_TREE", "BUY_ITEM", "BUY_LOAN", "BUY_SUBSCRIPTION", "BUY_TICKETS", "CANCEL", "CANCEL_ALL_AND_PLACE_ORDERS", "CANCEL_ALL_ORDERS", "CANCEL_ESCROW", "CANCEL_LOAN_REQUEST", "CANCEL_MULTIPLE_ORDERS", "CANCEL_OFFER", "CANCEL_ORDER", "CANCEL_ORDER_BY_CLIENT_ORDER_ID", "CANCEL_PROPOSAL", "CANCEL_REWARD", "CANCEL_SWAP", "CANCEL_TRANSACTION", "CANCEL_UP_TO", "CANCEL_UPDATE", "CANDY_MACHINE_ROUTE", "CANDY_MACHINE_UNWRAP", "CANDY_MACHINE_UPDATE", "CANDY_MACHINE_WRAP", "CHANGE_BLOCK_BUILDER", "CHANGE_COMIC_STATE", "CHANGE_FEE_RECIPIENT", "CHANGE_MARKET_STATUS", "CHANGE_SEAT_STATUS", "CHANGE_THRESHOLD", "CHANGE_TIP_RECEIVER", "CLAIM_AUTHORITY", "CLAIM_CNFT_PERPETUAL_LOAN", "CLAIM_FEE", "CLAIM_NFT", "CLAIM_NFT_BY_LENDER_CNFT", "CLAIM_NFT_BY_LENDER_PNFT", "CLAIM_PERPETUAL_LOAN", "CLAIM_REWARD", "CLAIM_REWARDS", "CLAIM_SALE", "CLAIM_TIPS", "CLEAN", "CLOSE_ACCOUNT", "CLOSE_BATCH_ACCOUNTS", "CLOSE_BUNDLED_POSITION", "CLOSE_CLAIM_STATUS", "CLOSE_CONFIG", "CLOSE_CONFIG_TRANSACTION_ACCOUNTS", "CLOSE_ESCROW_ACCOUNT", "CLOSE_ITEM", "CLOSE_MARKET", "CLOSE_OPEN_ORDERS_ACCOUNT", "CLOSE_OPEN_ORDERS_INDEXER", "CLOSE_ORDER", "CLOSE_POOL", "CLOSE_POSITION", "CLOSE_PRESET_PARAMETER", "CLOSE_TIP_DISTRIBUTION_ACCOUNT", "CLOSE_VAULT_BATCH_TRANSACTION_ACCOUNT", "CLOSE_VAULT_TRANSACTION_ACCOUNTS", "COLLECT_FEES", "COLLECT_REWARD", "COMPRESS_NFT", "COMPRESSED_NFT_BURN", "COMPRESSED_NFT_CANCEL_REDEEM", "COMPRESSED_NFT_DELEGATE", "COMPRESSED_NFT_MINT", "COMPRESSED_NFT_REDEEM", "COMPRESSED_NFT_SET_VERIFY_COLLECTION", "COMPRESSED_NFT_TRANSFER", "COMPRESSED_NFT_UNVERIFY_COLLECTION", "COMPRESSED_NFT_UNVERIFY_CREATOR", "COMPRESSED_NFT_UPDATE_METADATA", "COMPRESSED_NFT_VERIFY_COLLECTION", "COMPRESSED_NFT_VERIFY_CREATOR", "CONSUME_EVENTS", "CONSUME_GIVEN_EVENTS", "COPY_CLUSTER_INFO", "COPY_GOSSIP_CONTACT_INFO", "COPY_TIP_DISTRIBUTION_ACCOUNT", "COPY_VOTE_ACCOUNT", "CRANK", "CRANK_EVENT_QUEUE", "CREATE", "CREATE_AMM", "CREATE_APPRAISAL", "CREATE_AVATAR", "CREATE_AVATAR_CLASS", "CREATE_BATCH", "CREATE_BET", "CREATE_BOND_AND_SELL_TO_OFFERS", "CREATE_BOND_AND_SELL_TO_OFFERS_CNFT", "CREATE_BOND_AND_SELL_TO_OFFERS_FOR_TEST", "CREATE_BOND_OFFER_STANDARD", "CREATE_COLLECTION", "CREATE_CONFIG", "CREATE_CONFIG_TRANSACTION", "CREATE_ESCROW", "CREATE_LOCK_ESCROW", "CREATE_MARKET", "CREATE_MASTER_EDITION", "CREATE_MERKLE_TREE", "CREATE_MINT_METADATA", "CREATE_MULTISIG", "CREATE_OPEN_ORDERS_ACCOUNT", "CREATE_OPEN_ORDERS_INDEXER", "CREATE_ORDER", "CREATE_PAYMENT_METHOD", "CREATE_PERPETUAL_BOND_OFFER", "CREATE_POOL", "CREATE_PROPOSAL", "CREATE_RAFFLE", "CREATE_STATS", "CREATE_STORE", "CREATE_TOKEN_POOL", "CREATE_TRAIT", "CREATE_TRANSACTION", "CREATE_UNCHECKED", "CREATE_VAULT_TRANSACTION", "DEAUTHORIZE_FUNDER", "DECOMPRESS_NFT", "DECREASE_LIQUIDITY", "DELEGATE_MERKLE_TREE", "DELETE_COLLECTION", "DELETE_POSITION_BUNDLE", "DELETE_REFERRER_STATE_AND_SHORT_URL", "DELETE_TOKEN_BADGE", "DELIST_ITEM", "DELIST_NFT", "DEPOSIT", "DEPOSIT_FRACTIONAL_POOL", "DEPOSIT_GEM", "DEPOSIT_OBLIGATION_COLLATERAL", "DEPOSIT_RESERVE_LIQUIDITY", "DEPOSIT_RESERVE_LIQUIDITY_AND_OBLIGATION_COLLATERAL", "DEPOSIT_SOL_TO_FLASH_LOAN_POOL", "DEPOSIT_TO_BOND_OFFER_STANDARD", "DEPOSIT_TO_FARM_VAULT", "DEPOSIT_TO_REWARDS_VAULT", "DISTRIBUTE_COMPRESSION_REWARDS", "EDIT_ORDER", "EDIT_ORDER_PEGGED", "EMPTY_PAYMENT_ACCOUNT", "ENABLE_OR_DISABLE_POOL", "EQUIP_TRAIT", "EQUIP_TRAIT_AUTHORITY", "EVICT_SEAT", "EXECUTE_BATCH_TRANSACTION", "EXECUTE_CONFIG_TRANSACTION", "EXECUTE_INSTRUCTION", "EXECUTE_LOAN", "EXECUTE_MORTGAGE", "EXECUTE_TRANSACTION", "EXECUTE_VAULT_TRANSACTION", "EXIT_VALIDATE_AND_SELL_TO_BOND_OFFERS_V2", "EXPIRE", "EXTEND_LOAN", "EXTENSION_EXECUTE", "FILL_ORDER", "FINALIZE_PROGRAM_INSTRUCTION", "FINISH_HADO_MARKET", "FIX_POOL", "FLASH_BORROW_RESERVE_LIQUIDITY", "FLASH_REPAY_RESERVE_LIQUIDITY", "FORCE_CANCEL_ORDERS", "FORECLOSE_LOAN", "FRACTIONALIZE", "FREEZE", "FUND_REWARD", "FUSE", "GET_POOL_INFO", "GO_TO_A_BIN", "HARVEST_REWARD", "IDL_MISSING_TYPES", "INCREASE_LIQUIDITY", "INCREASE_ORACLE_LENGTH", "INIT_AUCTION_MANAGER_V2", "INIT_BANK", "INIT_CLUSTER_HISTORY_ACCOUNT", "INIT_CONFIG", "INIT_CONFIG_EXTENSION", "INIT_CUSTOMIZABLE_PERMISSIONLESS_CONSTANT_PRODUCT_POOL", "INIT_FARM", "INIT_FARMER", "INIT_FARMS_FOR_RESERVE", "INIT_FEE_TIER", "INIT_LENDING_MARKET", "INIT_OBLIGATION", "INIT_OBLIGATION_FARMS_FOR_RESERVE", "INIT_PERMISSIONED_POOL", "INIT_PERMISSIONLESS_CONSTANT_PRODUCT_POOL_WITH_CONFIG", "INIT_PERMISSIONLESS_CONSTANT_PRODUCT_POOL_WITH_CONFIG_2", "INIT_PERMISSIONLESS_POOL", "INIT_PERMISSIONLESS_POOL_WITH_FEE_TIER", "INIT_POOL", "INIT_POOL_V2", "INIT_POSITION_BUNDLE", "INIT_POSITION_BUNDLE_WITH_METADATA", "INIT_REFERRER_STATE_AND_SHORT_URL", "INIT_REFERRER_TOKEN_STATE", "INIT_RENT", "INIT_RESERVE", "INIT_REWARD", "INIT_REWARD_V2", "INIT_STAKE", "INIT_SWAP", "INIT_TICK_ARRAY", "INIT_TIP_DISTRIBUTION_ACCOUNT", "INIT_TOKEN_BADGE", "INIT_USER_METADATA", "INIT_VALIDATOR_HISTORY_ACCOUNT", "INIT_VAULT", "INITIALIZE", "INITIALIZE_ACCOUNT", "INITIALIZE_BIN_ARRAY", "INITIALIZE_BIN_ARRAY_BITMAP_EXTENSION", "INITIALIZE_CUSTOMIZABLE_PERMISSIONLESS_LB_PAIR", "INITIALIZE_FARM", "INITIALIZE_FARM_DELEGATED", "INITIALIZE_FLASH_LOAN_POOL", "INITIALIZE_GLOBAL_CONFIG", "INITIALIZE_HADO_MARKET", "INITIALIZE_LB_PAIR", "INITIALIZE_MARKET", "INITIALIZE_PERMISSION_LB_PAIR", "INITIALIZE_POSITION", "INITIALIZE_POSITION_BY_OPERATOR", "INITIALIZE_POSITION_PDA", "INITIALIZE_PRESET_PARAMETER", "INITIALIZE_REWARD", "INITIALIZE_USER", "INSTANT_REFINANCE_PERPETUAL_LOAN", "KICK_ITEM", "LEND_FOR_NFT", "LIMIT_ORDER", "LIQUIDATE", "LIQUIDATE_BOND_ON_AUCTION_CNFT", "LIQUIDATE_BOND_ON_AUCTION_PNFT", "LIQUIDATE_OBLIGATION_AND_REDEEM_RESERVE_COLLATERAL", "LIST_ITEM", "LIST_NFT", "LOAN", "LOAN_FOX", "LOCK", "LOCK_REWARD", "LOG", "MAKE_PERPETUAL_MARKET", "MAP_BANX_TO_POINTS", "MERGE_CONDITIONAL_TOKENS", "MERGE_STAKE", "MIGRATE_BIN_ARRAY", "MIGRATE_POSITION", "MIGRATE_TO_PNFT", "MINT_TO", "NAME_SUCCESSOR", "NFT_AUCTION_CANCELLED", "NFT_AUCTION_CREATED", "NFT_AUCTION_UPDATED", "NFT_BID", "NFT_BID_CANCELLED", "NFT_CANCEL_LISTING", "NFT_GLOBAL_BID", "NFT_GLOBAL_BID_CANCELLED", "NFT_LISTING", "NFT_MINT", "NFT_MINT_REJECTED", "NFT_PARTICIPATION_REWARD", "NFT_RENT_ACTIVATE", "NFT_RENT_CANCEL_LISTING", "NFT_RENT_END", "NFT_RENT_LISTING", "NFT_RENT_UPDATE_LISTING", "NFT_SALE", "OFFER_LOAN", "OPEN_BUNDLED_POSITION", "OPEN_POSITION", "OPEN_POSITION_WITH_METADATA", "OVERRIDE_CURVE_PARAM", "PARTNER_CLAIM_FEE", "PATCH_BROKEN_USER_STAKES", "PAUSE", "PAYOUT", "PLACE_AND_TAKE_PERP_ORDER", "PLACE_BET", "PLACE_MULTIPLE_POST_ONLY_ORDERS", "PLACE_ORDER", "PLACE_ORDER_PEGGED", "PLACE_ORDERS", "PLACE_SOL_BET", "PLACE_TAKE_ORDER", "PLATFORM_FEE", "POOL_CANCEL_PROPOSAL", "POST_MULTI_PYTH", "POST_PYTH", "PROGRAM_CONFIG_INIT", "PROGRAM_CONFIG_SET_AUTH", "PROGRAM_CONFIG_SET_CREATION_FEE", "PROGRAM_CONFIG_SET_TREASURY", "PROPOSE_LOAN", "PRUNE_ORDERS", "REALLOC_CLUSTER_HISTORY_ACCOUNT", "REALLOC_VALIDATOR_HISTORY_ACCOUNT", "REBORROW_SOL_FOR_NFT", "RECORD_RARITY_POINTS", "REDEEM_CONDITIONAL_TOKENS", "REDEEM_FEES", "REDEEM_RESERVE_COLLATERAL", "REDUCE_ORDER", "REFILL", "REFINANCE_FBOND_BY_LENDER", "REFINANCE_PERPETUAL_LOAN", "REFINANCE_TO_BOND_OFFERS_V2", "REFINANCE_TO_BOND_OFFERS_V2_CNFT", "REFRESH_FARM", "REFRESH_FARMER", "REFRESH_OBLIGATION", "REFRESH_OBLIGATION_FARMS_FOR_RESERVE", "REFRESH_RESERVE", "REFRESH_RESERVES_BATCH", "REFRESH_USER_STATE", "REJECT_PROPOSAL", "REJECT_SWAP", "REJECT_TRANSACTION", "REMOVE_ALL_LIQUIDITY", "REMOVE_BALANCE_LIQUIDITY", "REMOVE_BOND_OFFER_V2", "REMOVE_FROM_POOL", "REMOVE_FROM_WHITELIST", "REMOVE_LIQUIDITY", "REMOVE_LIQUIDITY_BY_RANGE", "REMOVE_LIQUIDITY_SINGLE_SIDE", "REMOVE_MEMBER", "REMOVE_MEMBER_AND_CHANGE_THRESHOLD", "REMOVE_PERPETUAL_OFFER", "REMOVE_SPENDING_LIMIT", "REMOVE_TRAIT", "REMOVE_TRAIT_AUTHORITY", "REPAY", "REPAY_CNFT_PERPETUAL_LOAN", "REPAY_COMPRESSED", "REPAY_FBOND_TO_TRADE_TRANSACTIONS", "REPAY_FBOND_TO_TRADE_TRANSACTIONS_CNFT", "REPAY_FLASH_LOAN", "REPAY_LOAN", "REPAY_OBLIGATION_LIQUIDITY", "REPAY_PARTIAL_PERPETUAL_LOAN", "REPAY_PERPETUAL_LOAN", "REPAY_STAKED_BANX", "REPAY_STAKED_BANX_PERPETUAL_LOAN", "REQUEST_ELEVATION_GROUP", "REQUEST_LOAN", "REQUEST_PNFT_MIGRATION", "REQUEST_SEAT", "REQUEST_SEAT_AUTHORIZED", "RESCIND_LOAN", "REVOKE", "REWARD_USER_ONCE", "SELL_LOAN", "SELL_NFT", "SELL_STAKED_BANX_TO_OFFERS", "SET_ACTIVATION_POINT", "SET_AUTHORITY", "SET_BANK_FLAGS", "SET_COLLECT_PROTOCOL_FEES_AUTHORITY", "SET_CONFIG_AUTH", "SET_CONFIG_EXTENSION_AUTHORITY", "SET_DEFAULT_FEE_RATE", "SET_DEFAULT_PROTOCOL_FEE_RATE", "SET_DELEGATE", "SET_FEE_AUTHORITY", "SET_FEE_RATE", "SET_MARKET_EXPIRED", "SET_NEW_ADMIN", "SET_NEW_ORACLE_AUTHORITY", "SET_NEW_TIP_DISTRIBUTION_PROGRAM", "SET_PARAMS", "SET_POOL_FEES", "SET_PRE_ACTIVATION_DURATION", "SET_PRE_ACTIVATION_SWAP_ADDRESS", "SET_PROTOCOL_FEE_RATE", "SET_RENT_COLLECTOR", "SET_REWARD_AUTHORITY", "SET_REWARD_AUTHORITY_BY_SUPER_AUTHORITY", "SET_REWARD_EMISSIONS", "SET_REWARD_EMISSIONS_SUPER_AUTHORITY", "SET_REWARD_EMISSIONS_V2", "SET_STAKE_DELEGATED", "SET_TIME_LOCK", "SET_TOKEN_BADGE_AUTHORITY", "SET_VAULT_LOCK", "SET_WHITELISTED_VAULT", "SETTLE_CONDITIONAL_VAULT", "SETTLE_FUNDS", "SETTLE_FUNDS_EXPIRED", "SETTLE_PNL", "SOCIALIZE_LOSS", "SPLIT_STAKE", "STAKE", "STAKE_BANX", "STAKE_SOL", "STAKE_TOKEN", "START_PNFT_MIGRATION", "STUB_ID_BUILD", "STUB_ORACLE_CLOSE", "STUB_ORACLE_CREATE", "STUB_ORACLE_SET", "SWAP", "SWAP_EXACT_OUT", "SWAP_WITH_PRICE_IMPACT", "SWEEP_FEES", "SWITCH_FOX", "SWITCH_FOX_REQUEST", "SYNC_LIQUIDITY", "TAKE_COMPRESSED_LOAN", "TAKE_FLASH_LOAN", "TAKE_LOAN", "TAKE_MORTGAGE", "TERMINATE_PERPETUAL_LOAN", "THAW", "TOGGLE_PAIR_STATUS", "TOKEN_MINT", "TOPUP", "TRANSFER", "TRANSFER_OWNERSHIP", "TRANSFER_PAYMENT", "TRANSFER_PAYMENT_TREE", "TRANSFER_RECIPIENT", "UNFREEZE", "UNKNOWN", "UNLABELED", "UNPAUSE", "UNSTAKE", "UNSTAKE_BANX", "UNSTAKE_SOL", "UNSTAKE_TOKEN", "UNSUB_OR_HARVEST_WEEKS", "UNSUB_OR_HARVEST_WEEKS_ENHANCED", "UPDATE", "UPDATE_ACTIVATION_POINT", "UPDATE_BANK_MANAGER", "UPDATE_BOND_OFFER_STANDARD", "UPDATE_CLASS_VARIANT_AUTHORITY", "UPDATE_CLASS_VARIANT_METADATA", "UPDATE_COLLECTION", "UPDATE_COLLECTION_OR_CREATOR", "UPDATE_CONFIG", "UPDATE_EXTERNAL_PRICE_ACCOUNT", "UPDATE_FARM", "UPDATE_FARM_ADMIN", "UPDATE_FARM_CONFIG", "UPDATE_FEE_PARAMETERS", "UPDATE_FEES_AND_REWARDS", "UPDATE_FLOOR", "UPDATE_GLOBAL_CONFIG", "UPDATE_GLOBAL_CONFIG_ADMIN", "UPDATE_HADO_MARKET_FEE", "UPDATE_INTEREST_PERPETUAL_MARKET", "UPDATE_ITEM", "UPDATE_LENDING_MARKET", "UPDATE_LENDING_MARKET_OWNER", "UPDATE_OFFER", "UPDATE_ORDER", "UPDATE_PERPETUAL_MARKET", "UPDATE_PERPETUAL_OFFER", "UPDATE_POOL", "UPDATE_POOL_COLLECTIONS", "UPDATE_POOL_MORTGAGE", "UPDATE_POOL_STATUS", "UPDATE_POOL_WHITELIST", "UPDATE_POSITION_OPERATOR", "UPDATE_PRICING_V2", "UPDATE_PRIMARY_SALE_METADATA", "UPDATE_RAFFLE", "UPDATE_RECORD_AUTHORITY_DATA", "UPDATE_RESERVE_CONFIG", "UPDATE_REWARD_DURATION", "UPDATE_REWARD_FUNDER", "UPDATE_STAKE_HISTORY", "UPDATE_STAKING_SETTINGS", "UPDATE_STATS", "UPDATE_TRAIT_VARIANT", "UPDATE_TRAIT_VARIANT_AUTHORITY", "UPDATE_TRAIT_VARIANT_METADATA", "UPDATE_USABLE_AMOUNT", "UPDATE_VARIANT", "UPDATE_VAULT_OWNER", "UPGRADE_FOX", "UPGRADE_FOX_REQUEST", "UPGRADE_PROGRAM_INSTRUCTION", "UPLOAD_MERKLE_ROOT", "USE_SPENDING_LIMIT", "VALIDATE_SAFETY_DEPOSIT_BOX_V2", "VERIFY_PAYMENT_MINT", "VERIFY_PAYMENT_MINT_TEST", "VOTE", "WHITELIST_CREATOR", "WITHDRAW", "WITHDRAW_FROM_BOND_OFFER_STANDARD", "WITHDRAW_FROM_FARM_VAULT", "WITHDRAW_GEM", "WITHDRAW_INELIGIBLE_REWARD", "WITHDRAW_LIQUIDITY", "WITHDRAW_OBLIGATION_COLLATERAL", "WITHDRAW_OBLIGATION_COLLATERAL_AND_REDEEM_RESERVE_COLLATERAL", "WITHDRAW_PROTOCOL_FEE", "WITHDRAW_PROTOCOL_FEES", "WITHDRAW_REFERRER_FEES", "WITHDRAW_REWARD", "WITHDRAW_REWARDS_FROM_VAULT", "WITHDRAW_SLASHED_AMOUNT", "WITHDRAW_SOL_FROM_FLASH_LOAN_POOL", "WITHDRAW_TREASURY", "WITHDRAW_UNSTAKED_DEPOSITS" ] }, "Webhooks_NFTEventType": { "type": "string", "enum": [ "NFT_BID", "NFT_BID_CANCELLED", "NFT_GLOBAL_BID", "NFT_GLOBAL_BID_CANCELLED", "NFT_LISTING", "NFT_CANCEL_LISTING", "NFT_SALE", "NFT_MINT", "NFT_MINT_REJECTED", "NFT_AUCTION_CREATED", "NFT_AUCTION_UPDATED", "NFT_AUCTION_CANCELLED", "NFT_PARTICIPATION_REWARD", "BURN_NFT", "NFT_RENT_LISTING", "NFT_RENT_CANCEL_LISTING", "NFT_RENT_UPDATE_LISTING", "NFT_RENT_ACTIVATE", "NFT_RENT_END", "ATTACH_METADATA", "MIGRATE_TO_PNFT", "CREATE_POOL" ] }, "Webhooks_CompressedNFTEventType": { "type": "string", "enum": [ "CREATE_MERKLE_TREE", "COMPRESSED_NFT_MINT", "COMPRESSED_NFT_TRANSFER", "COMPRESSED_NFT_REDEEM", "COMPRESSED_NFT_CANCEL_REDEEM", "COMPRESSED_NFT_BURN", "COMPRESSED_NFT_DELEGATE" ] }, "Webhooks_TransactionSource": { "type": "string", "enum": [ "FORM_FUNCTION", "EXCHANGE_ART", "CANDY_MACHINE_V3", "CANDY_MACHINE_V2", "CANDY_MACHINE_V1", "UNKNOWN", "SOLANART", "SOLSEA", "MAGIC_EDEN", "HOLAPLEX", "METAPLEX", "OPENSEA", "SOLANA_PROGRAM_LIBRARY", "ANCHOR", "PHANTOM", "SYSTEM_PROGRAM", "STAKE_PROGRAM", "COINBASE", "CORAL_CUBE", "HEDGE", "LAUNCH_MY_NFT", "GEM_BANK", "GEM_FARM", "DEGODS", "BSL", "YAWWW", "ATADIA", "DIGITAL_EYES", "HYPERSPACE", "TENSOR", "BIFROST", "JUPITER", "MERCURIAL", "SABER", "SERUM", "STEP_FINANCE", "CROPPER", "RAYDIUM", "ALDRIN", "CREMA", "LIFINITY", "CYKURA", "ORCA", "MARINADE", "STEPN", "SENCHA", "SAROS", "ENGLISH_AUCTION", "FOXY", "HADESWAP", "FOXY_STAKING", "FOXY_RAFFLE", "FOXY_TOKEN_MARKET", "FOXY_MISSIONS", "FOXY_MARMALADE", "FOXY_COINFLIP", "FOXY_AUCTION", "CITRUS", "ZETA", "ELIXIR", "ELIXIR_LAUNCHPAD", "CARDINAL_RENT", "CARDINAL_STAKING", "BPF_LOADER", "BPF_UPGRADEABLE_LOADER", "SQUADS", "SHARKY_FI", "OPEN_CREATOR_PROTOCOL", "BUBBLEGUM", "NOVA", "D_READER", "RAINDROPS", "W_SOL", "DUST", "SOLI", "USDC", "FLWR", "HDG", "MEAN", "UXD", "SHDW", "POLIS", "ATLAS", "USH", "TRTLS", "RUNNER", "INVICTUS" ] }, "Webhooks_SaleType": { "type": "string", "enum": [ "AUCTION", "INSTANT_SALE", "OFFER", "GLOBAL_OFFER", "MINT", "UNKNOWN" ] }, "Webhooks_Token": { "type": "object", "properties": { "mint": { "type": "string", "example": "DsfCsbbPH77p6yeLS1i4ag9UA5gP9xWSvdCx72FJjLsx", "description": "The mint account of the token." }, "tokenStandard": { "$ref": "#/components/schemas/Webhooks_TokenStandard" } } }, "Webhooks_TokenStandard": { "type": "string", "enum": [ "NonFungible", "FungibleAsset", "Fungible", "NonFungibleEdition" ] }, "Webhooks_TokenTransfer": { "type": "object", "properties": { "fromUserAccount": { "type": "string", "description": "The user account the tokens are sent from." }, "toUserAccount": { "type": "string", "description": "The user account the tokens are sent to." }, "fromTokenAccount": { "type": "string", "description": "The token account the tokens are sent from." }, "toTokenAccount": { "type": "string", "description": "The token account the tokens are sent to." }, "tokenAmount": { "type": "number", "description": "The number of tokens sent." }, "mint": { "type": "string", "description": "The mint account of the token.", "example": "DsfCsbbPH77p6yeLS1i4ag9UA5gP9xWSvdCx72FJjLsx" } } }, "Webhooks_NativeTransfer": { "type": "object", "properties": { "fromUserAccount": { "type": "string", "description": "The user account the sol is sent from." }, "toUserAccount": { "type": "string", "description": "The user account the sol is sent to." }, "amount": { "type": "integer", "description": "The amount of sol sent (in lamports)." } } }, "Webhooks_TokenMetadataResponse": { "type": "object", "description": "Metaplex metadata stored both on-chain and off-chain.", "properties": { "mint": { "type": "string" }, "onChainData": { "$ref": "#/components/schemas/Webhooks_OnChainMetadata" }, "offChainData": { "$ref": "#/components/schemas/Webhooks_OffChainMetadata" } } }, "Webhooks_OnChainMetadata": { "type": "object", "description": "Metaplex metadata that is stored on-chain.", "properties": { "key": { "type": "string" }, "mint": { "type": "string" }, "updateAuthority": { "type": "string" }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "uri": { "type": "string" }, "sellerFeeBasisPoints": { "type": "integer" }, "creators": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "share": { "type": "string" }, "verified": { "type": "boolean" } } } } } }, "tokenStandard": { "type": "string" }, "primarySaleHappened": { "type": "boolean" }, "isMutable": { "type": "boolean" }, "editionNonce": { "type": "integer" }, "collection": { "type": "object", "properties": { "key": { "type": "string" }, "verified": { "type": "boolean" } } }, "collectionDetails": { "type": "object", "properties": { "size": { "type": "integer" } } }, "uses": { "type": "object", "properties": { "useMethod": { "type": "string" }, "remaining": { "type": "integer" }, "total": { "type": "integer" } } } } }, "Webhooks_OffChainMetadata": { "type": "object", "description": "Metaplex metadata that is stored off-chain.", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "attributes": { "type": "array", "items": { "properties": { "traitType": { "type": "string" }, "value": { "type": "string" } } } }, "sellerFeeBasisPoints": { "type": "integer" }, "image": { "type": "string" }, "properties": { "type": "object", "properties": { "category": { "type": "string" }, "files": { "type": "array", "items": { "properties": { "uri": { "type": "string" }, "type": { "type": "string" } } } }, "creators": { "type": "array", "items": { "properties": { "address": { "type": "string" }, "share": { "type": "string" } } } } } } } }, "Webhooks_RawTransaction": { "type": "object", "properties": { "slot": { "type": "integer" }, "blocktime": { "type": "integer" }, "transaction": { "$ref": "#/components/schemas/Webhooks_InnerTransaction" }, "meta": { "$ref": "#/components/schemas/Webhooks_Meta" } } }, "Webhooks_InnerTransaction": { "type": "object", "properties": { "signatures": { "type": "array", "items": { "type": "string" } }, "message": { "type": "object", "properties": { "accountKeys": { "type": "array", "items": { "type": "string" } }, "header": { "type": "object" }, "recentBlockhash": { "type": "string" }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "programIdIndex": { "type": "integer" }, "accounts": { "type": "array", "items": { "type": "integer" } }, "data": { "type": "string" } } } } } } } }, "Webhooks_Meta": { "type": "object", "properties": { "err": { "type": "object" }, "fee": { "type": "integer" }, "preBalances": { "type": "array", "items": { "type": "integer" } }, "postBalances": { "type": "array", "items": { "type": "integer" } }, "preTokenBalances": { "type": "array", "items": { "type": "integer" } }, "postTokenBalances": { "type": "array", "items": { "type": "integer" } }, "logMessages": { "type": "array", "items": { "type": "string" } }, "rewards": { "type": "array", "items": { "type": "object" } }, "loadedAddresses": { "type": "object" } } }, "Webhooks_EnhancedTransaction": { "type": "object", "properties": { "description": { "type": "string", "example": "Human readable interpretation of the transaction" }, "type": { "$ref": "#/components/schemas/Webhooks_TransactionType" }, "source": { "$ref": "#/components/schemas/Webhooks_TransactionSource" }, "fee": { "type": "integer", "example": 5000 }, "feePayer": { "type": "string", "example": "8cRrU1NzNpjL3k2BwjW3VixAcX6VFc29KHr4KZg8cs2Y" }, "signature": { "type": "string", "example": "yy5BT9benHhx8fGCvhcAfTtLEHAtRJ3hRTzVL16bdrTCWm63t2vapfrZQZLJC3RcuagekaXjSs2zUGQvbcto8DK" }, "slot": { "type": "integer", "example": 148277128 }, "timestamp": { "type": "integer", "example": 1656442333 }, "nativeTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NativeTransfer" } }, "tokenTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenTransfer" } }, "accountData": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_AccountData" } }, "transactionError": { "type": "object", "properties": { "error": { "type": "string" } } }, "instructions": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_Instruction" } }, "events": { "type": "object", "properties": { "nft": { "$ref": "#/components/schemas/Webhooks_NFTEvent" }, "swap": { "$ref": "#/components/schemas/Webhooks_SwapEvent" }, "compressed": { "$ref": "#/components/schemas/Webhooks_CompressedNFTEvent" }, "distributeCompressionRewards": { "$ref": "#/components/schemas/Webhooks_DistributeCompressionRewardsEvent" }, "setAuthority": { "$ref": "#/components/schemas/Webhooks_SetAuthorityEvent" } }, "description": "Events associated with this transaction. These provide fine-grained information about the transaction. They match the types returned from the event APIs." } } }, "Webhooks_Instruction": { "type": "object", "description": "Individual instruction data in a transaction.", "properties": { "accounts": { "type": "array", "description": "The accounts used in instruction.", "items": { "type": "string", "example": "8uX6yiUuH4UjUb1gMGJAdkXorSuKshqsFGDCFShcK88B" } }, "data": { "type": "string", "description": "Data passed into the instruction", "example": "kdL8HQJrbbvQRGXmoadaja1Qvs" }, "programId": { "type": "string", "description": "Program used in instruction", "example": "MEisE1HzehtrDpAAT8PnLHjpSSkRYakotTuJRPjTpo8" }, "innerInstructions": { "type": "array", "description": "Inner instructions used in instruction", "items": { "$ref": "#/components/schemas/Webhooks_InnerInstruction" } } } }, "Webhooks_InnerInstruction": { "type": "object", "description": "Inner instructions for each instruction", "properties": { "accounts": { "type": "array", "items": { "type": "string" } }, "data": { "type": "string" }, "programId": { "type": "string" } } }, "Webhooks_AccountData": { "type": "object", "description": "Sol and token transfers involving the account are referenced in this object.", "properties": { "account": { "type": "string", "description": "The account that this data is provided for." }, "nativeBalanceChange": { "type": "number", "description": "Native (SOL) balance change of the account." }, "tokenBalanceChanges": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenBalanceChange" }, "description": "Token balance changes of the account." } } }, "Webhooks_NFTEvent": { "type": "object", "properties": { "description": { "type": "string", "description": "Human readable interpretation of the transaction" }, "type": { "$ref": "#/components/schemas/Webhooks_NFTEventType" }, "source": { "$ref": "#/components/schemas/Webhooks_TransactionSource" }, "amount": { "type": "integer", "example": 1000000, "description": "The amount of the NFT transaction (in lamports)." }, "fee": { "type": "integer", "example": 5000 }, "feePayer": { "type": "string", "example": "8cRrU1NzNpjL3k2BwjW3VixAcX6VFc29KHr4KZg8cs2Y" }, "signature": { "type": "string", "example": "4jzQxVTaJ4Fe4Fct9y1aaT9hmVyEjpCqE2bL8JMnuLZbzHZwaL4kZZvNEZ6bEj6fGmiAdCPjmNQHCf8v994PAgDf" }, "slot": { "type": "integer", "example": 148277128 }, "timestamp": { "type": "integer", "example": 1656442333 }, "saleType": { "$ref": "#/components/schemas/Webhooks_SaleType" }, "buyer": { "type": "string", "description": "The buyer of the NFT." }, "seller": { "type": "string", "description": "The seller of the NFT." }, "staker": { "type": "string", "description": "The staker of the NFT." }, "nfts": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_Token" }, "description": "NFTs that are a part of this NFT event." } } }, "Webhooks_CompressedNFTEvent": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Webhooks_CompressedNFTEventType" }, "treeId": { "type": "string", "description": "The address of the related merkle tree." }, "assetId": { "type": "string", "description": "The id of the compressed nft." }, "leafIndex": { "type": "integer", "description": "The index of the leaf being appended or modified." }, "instructionIndex": { "type": "integer", "description": "The index of the parsed instruction in the transaction." }, "innerInstructionIndex": { "type": "integer", "description": "The index of the parsed inner instruction in the transaction." }, "newLeafOwner": { "type": "string", "description": "The new owner of the leaf." }, "oldLeafOwner": { "type": "string", "description": "The previous owner of the leaf." } } }, "Webhooks_DistributeCompressionRewardsEvent": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Amount transfered in the DistributeCompressionRewardsV0 instruction." } } }, "Webhooks_SetAuthorityEvent": { "type": "object", "properties": { "account": { "type": "string", "description": "Tthe account whose authority is changing." }, "from": { "type": "string", "description": "Current authority." }, "to": { "type": "string", "description": "New authority." }, "instructionIndex": { "type": "integer", "description": "The index of the parsed instruction in the transaction." }, "innerInstructionIndex": { "type": "integer", "description": "The index of the parsed inner instruction in the transaction." } } }, "Webhooks_SwapEvent": { "type": "object", "properties": { "nativeInput": { "$ref": "#/components/schemas/Webhooks_NativeBalanceChange", "description": "The native input to the swap in Lamports." }, "nativeOutput": { "$ref": "#/components/schemas/Webhooks_NativeBalanceChange", "description": "The native output of the swap in Lamports." }, "tokenInputs": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenBalanceChange" }, "description": "The token inputs to the swap." }, "tokenOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenBalanceChange" }, "description": "The token outputs of the swap." }, "tokenFees": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenBalanceChange" }, "description": "The token fees paid by an account." }, "nativeFees": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NativeBalanceChange" }, "description": "The native fees paid by an account." }, "innerSwaps": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenSwap" }, "description": "The inner swaps occurring to make this swap happen. Eg. a swap of wSOL <-> USDC may be make of multiple swaps from wSOL <-> DUST, DUST <-> USDC" } } }, "Webhooks_TokenSwap": { "type": "object", "properties": { "tokenInputs": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenTransfer" }, "description": "The token inputs of this swap." }, "tokenOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenTransfer" }, "description": "The token outputs of this swap." }, "tokenFees": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenTransfer" }, "description": "Fees charged with tokens for this swap." }, "nativeFees": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NativeTransfer" }, "description": "Fees charged in SOL for this swap." }, "programInfo": { "$ref": "#/components/schemas/Webhooks_ProgramInfo", "description": "Information about the program creating this swap." } } }, "Webhooks_ProgramInfo": { "type": "object", "properties": { "source": { "type": "string", "example": "ORCA" }, "account": { "type": "string", "description": "The account of the program", "example": "whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc" }, "programName": { "type": "string", "description": "The name of the program", "example": "ORCA_WHIRLPOOLS" }, "instructionName": { "type": "string", "description": "The name of the instruction creating this swap. It is the value of instruction name from the Anchor IDL, if it is available.", "example": "whirlpoolSwap" } } }, "Webhooks_NativeBalanceChange": { "type": "object", "properties": { "account": { "type": "string", "description": "The account the native balance change is for", "example": "2uySTNgvGT2kwqpfgLiSgeBLR3wQyye1i1A2iQWoPiFr" }, "amount": { "type": "string", "description": "The amount of the balance change as a string", "example": "100000000" } } }, "Webhooks_TokenBalanceChange": { "type": "object", "properties": { "userAccount": { "type": "string", "example": "F54ZGuxyb2gA7vRjzWKLWEMQqCfJxDY1whtqtjdq4CJ" }, "tokenAccount": { "type": "string", "example": "2kvmbRybhrcptDnwyNv6oiFGFEnRVv7MvVyqsxkirgdn" }, "mint": { "type": "string", "example": "DUSTawucrTsGU8hcqRdHDCbuYhCPADMLM2VcCb8VnFnQ" }, "rawTokenAmount": { "$ref": "#/components/schemas/Webhooks_RawTokenAmount" } } }, "Webhooks_RawTokenAmount": { "type": "object", "properties": { "tokenAmount": { "type": "string" }, "decimals": { "type": "integer" } } }, "Webhooks_NamesResponse": { "type": "object", "properties": { "domainNames": { "type": "array", "items": { "type": "string" } } } }, "Webhooks_BalancesResponse": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_Balance" } }, "nativeBalance": { "type": "number", "description": "In Lamports" } } }, "Webhooks_Balance": { "type": "object", "properties": { "mint": { "type": "string" }, "amount": { "type": "number" }, "decimals": { "type": "number" }, "tokenAccount": { "type": "string" } } }, "Webhooks_NFTsResponse": { "type": "object", "properties": { "numberOfPages": { "type": "number" }, "nfts": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_Asset" } } } }, "Webhooks_Asset": { "type": "object", "properties": { "name": { "type": "string" }, "tokenAddress": { "type": "string" }, "collectionAddress": { "type": "string" }, "collectionName": { "type": "string" }, "imageURL": { "type": "string" }, "traits": { "type": "array", "items": { "type": "object", "properties": { "trait_type": { "type": "string" }, "value": { "type": "string" } } } } } }, "Webhooks_Commitment": { "type": "string", "enum": [ "finalized", "confirmed" ] }, "Webhooks_TokensMetadataRequest": { "type": "object", "properties": { "mintAccounts": { "type": "array", "items": { "type": "string", "description": "The mint account of the token to retrieve metadata for." }, "maxItems": 100 } } }, "Webhooks_ParseTransactionsRequest": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "type": "string", "description": "The transaction IDs/signatures to parse for." }, "maxItems": 100 } } }, "Webhooks_CreateWebhookRequest": { "type": "object", "properties": { "webhookURL": { "type": "string" }, "transactionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TransactionType" } }, "accountAddresses": { "type": "array", "items": { "type": "string" }, "maxItems": "100_000" }, "webhookType": { "$ref": "#/components/schemas/Webhooks_WebhookType" }, "authHeader": { "type": "string" }, "encoding": { "type": "string" }, "txnStatus": { "type": "string" } } }, "Webhooks_RpcProxyRequest": { "type": "object", "properties": { "method": { "type": "string", "description": "Name of the method to be invoked", "example": "getBlock" }, "params": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array", "items": {} }, { "type": "object" } ] }, "description": "Params to be passed. Please see Solana JSON-RPC docs." } } }, "Webhooks_QueryNftEventsRequest": { "type": "object", "properties": { "query": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "string", "example": "79FjnnXFpSajugwpx3FfQbV7hJJTe7QXAusF7R4CMf6c", "maxItems": 100 } }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NFTEventType" } }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TransactionSource" } }, "startSlot": { "type": "integer", "example": 162368570, "description": "Earliest slot to include in the query (inclusive). Cannot be combined with \"startTime\"." }, "endSlot": { "type": "integer", "example": 162368580, "description": "Latest slot to include in the query (inclusive). Cannot be combined with \"endTime\"." }, "startTime": { "type": "integer", "example": 1669055189, "description": "Earliest event time (unix seconds). Cannot be combined with \"startSlot\"." }, "endTime": { "type": "integer", "example": 1669070189, "description": "Latest event time (unix seconds). Cannot be combined with \"endSlot\"." }, "nftCollectionFilters": { "type": "object", "properties": { "firstVerifiedCreator": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_FirstVerifiedCreator" } }, "verifiedCollectionAddress": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_VerifiedCollectionAddress" } } } } } }, "options": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of items to return. Must be between 1 and 1000. Default is 100.", "minimum": 1, "maximum": 1000, "default": 100 }, "sortOrder": { "$ref": "#/components/schemas/Webhooks_SortOrder" }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } } } }, "Webhooks_QueryNftEventsResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NftEventV2" } }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } }, "Webhooks_DescribeNftsRequest": { "type": "object", "properties": { "mints": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NftMintAccount" } } } }, "Webhooks_DescribeNftsResponse": { "type": "array", "items": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/Webhooks_NftMintAccount" }, "name": { "$ref": "#/components/schemas/Webhooks_NftName" }, "burned": { "$ref": "#/components/schemas/Webhooks_NftBurned" }, "firstVerifiedCreator": { "$ref": "#/components/schemas/Webhooks_FirstVerifiedCreator" }, "verifiedCollectionAddress": { "$ref": "#/components/schemas/Webhooks_VerifiedCollectionAddress" }, "activeListings": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_ActiveListing" } } } } }, "Webhooks_MintlistRequest": { "type": "object", "properties": { "query": { "type": "object", "properties": { "firstVerifiedCreators": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_FirstVerifiedCreator" } }, "verifiedCollectionAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_VerifiedCollectionAddress" } } } }, "options": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of items to return. Must be between 1 and 10,000. Default is 1000.", "minimum": 1, "maximum": "10_000", "default": 1000 }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } } } }, "Webhooks_MintlistResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/Webhooks_NftMintAccount" }, "name": { "$ref": "#/components/schemas/Webhooks_NftName" } } } }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } }, "Webhooks_ActiveListingsRequest": { "type": "object", "properties": { "query": { "type": "object", "properties": { "marketplaces": { "items": { "$ref": "#/components/schemas/Webhooks_Marketplace" } }, "firstVerifiedCreators": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_FirstVerifiedCreator" } }, "verifiedCollectionAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_VerifiedCollectionAddress" } } } }, "options": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of items to return. Must be between 1 and 1000. Default is 100.", "minimum": 1, "maximum": 1000, "default": 100 }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } } } }, "Webhooks_ActiveListingsResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/Webhooks_NftMintAccount" }, "name": { "$ref": "#/components/schemas/Webhooks_NftName" }, "firstVerifiedCreator": { "$ref": "#/components/schemas/Webhooks_FirstVerifiedCreator" }, "verifiedCollectionAddress": { "$ref": "#/components/schemas/Webhooks_VerifiedCollectionAddress" }, "activeListings": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_ActiveListing" } } } } }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } }, "Webhooks_SortOrder": { "type": "string", "description": "Order of the returned results. Must be 'ASC' or 'DESC'. Results are descending by default.", "enum": [ "ASC", "DESC" ], "default": "DESC" }, "Webhooks_NftEventV2": { "type": "object", "properties": { "description": { "type": "string", "description": "Human readable interpretation of the transaction" }, "type": { "$ref": "#/components/schemas/Webhooks_NFTEventType" }, "source": { "$ref": "#/components/schemas/Webhooks_TransactionSource" }, "amount": { "type": "integer", "example": 1000000, "description": "The amount of the NFT transaction (in lamports)." }, "fee": { "type": "integer", "example": 5000 }, "feePayer": { "type": "string", "example": "8cRrU1NzNpjL3k2BwjW3VixAcX6VFc29KHr4KZg8cs2Y" }, "signature": { "type": "string", "example": "4jzQxVTaJ4Fe4Fct9y1aaT9hmVyEjpCqE2bL8JMnuLZbzHZwaL4kZZvNEZ6bEj6fGmiAdCPjmNQHCf8v994PAgDf" }, "slot": { "type": "integer", "example": 148277128 }, "timestamp": { "type": "integer", "example": 1656442333 }, "saleType": { "$ref": "#/components/schemas/Webhooks_SaleType" }, "buyer": { "type": "string", "description": "The buyer of the NFT." }, "seller": { "type": "string", "description": "The seller of the NFT." }, "staker": { "type": "string", "description": "The staker of the NFT." }, "nfts": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NftV2" }, "description": "Associated NFTs" }, "nativeTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_NativeTransfer" } }, "tokenTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_TokenTransfer" } } } }, "Webhooks_NftV2": { "type": "object", "properties": { "mint": { "$ref": "#/components/schemas/Webhooks_NftMintAccount" }, "name": { "$ref": "#/components/schemas/Webhooks_NftName" }, "burned": { "$ref": "#/components/schemas/Webhooks_NftBurned" }, "firstVerifiedCreator": { "$ref": "#/components/schemas/Webhooks_FirstVerifiedCreator" }, "verifiedCollectionAddress": { "$ref": "#/components/schemas/Webhooks_VerifiedCollectionAddress" } } }, "Webhooks_NftMintAccount": { "type": "string", "description": "NFT mint account address.", "example": "KG6f4Fa6YxAW8cG2Dhb18DiMn3rQ3rSLa1Eo2FYM4gi" }, "Webhooks_NftName": { "type": "string", "description": "The name of the NFT.", "example": "y00t #2940" }, "Webhooks_NftBurned": { "type": "boolean", "description": "If the NFT was was burned. Burned NFTs have no name, firstVerifiedCreator, or verifiedCollectionAddress.", "example": false }, "Webhooks_FirstVerifiedCreator": { "type": "string", "description": "First verified creator of the NFT. Used to reference NFT collections.", "example": "A4FM6h8T5Fmh9z2g3fKUrKfZn6BNFEgByR8QGpdbQhk1" }, "Webhooks_VerifiedCollectionAddress": { "type": "string", "description": "Verified Metaplex collection address. Does not exist for all NFT collections.", "example": "4mKSoDDqApmF1DqXvVTSL6tu2zixrSSNjqMxUnwvVzy2" }, "Webhooks_ActiveListing": { "type": "object", "properties": { "transactionSignature": { "type": "string", "description": "Signature of the listing transaction.", "example": "27W41DrnxGFJGX7yEGuKBtRb7oMwFdGdPwffBTTeakV8nTQTgWR2hzFKmrt8QnxaMEbw4pS2NoiLmiuB2VfqxVn7" }, "marketplace": { "$ref": "#/components/schemas/Webhooks_Marketplace" }, "amount": { "type": "integer", "example": 1000000, "description": "Listed price of the NFT (in lamports)." }, "seller": { "type": "string", "description": "Address of the NFT seller.", "example": "3ngLS7Y64DoMAHJ6k6XYh8vo5nSiG66AP1yLvbckfKrc" } } }, "Webhooks_Marketplace": { "type": "string", "description": "Marketplace where the NFT is being listed.", "example": "MAGIC_EDEN", "enum": [ "MAGIC_EDEN", "OPENSEA", "FORM_FUNCTION", "EXCHANGE_ART", "SOLANART", "SOLSEA", "HOLAPLEX", "CORAL_CUBE", "YAWWW", "SOLPORT", "HYPERSPACE", "DIGITAL_EYES", "CORAL_CUBE", "UNKNOWN" ] }, "Webhooks_PaginationToken": { "type": "string", "description": "Token used for pagination. Provide the token to the API to retrieve the results from the next page. If no token exists, the query has no results remaining.", "example": "V1_162262948_99" }, "Webhooks_RawTransactionsV1Request": { "type": "object", "properties": { "query": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "string", "example": "CyFyz1xR4YTG9CrY9jg5jG6GZfm2e8k97qscs2GFpjX1", "description": "Array of accounts to find transactions for. Limit of 1000 accounts\"." } }, "startSlot": { "type": "integer", "example": 162368570, "description": "Earliest slot to include in the query (inclusive). Cannot be combined with \"startTime\"." }, "endSlot": { "type": "integer", "example": 162368580, "description": "Latest slot to include in the query (inclusive). Cannot be combined with \"endTime\"." }, "startTime": { "type": "integer", "example": 1669055189, "description": "Earliest event time (unix seconds). Cannot be combined with \"startSlot\"." }, "endTime": { "type": "integer", "example": 1669070189, "description": "Latest event time (unix seconds). Cannot be combined with \"endSlot\"." } } }, "options": { "type": "object", "properties": { "limit": { "description": "Maximum number of items to return. Must be between 1 and 500. Default is 100.", "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "sortOrder": { "$ref": "#/components/schemas/Webhooks_SortOrder" }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } } } }, "Webhooks_RawTransactionsV1Response": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks_RawTransaction" } }, "paginationToken": { "$ref": "#/components/schemas/Webhooks_PaginationToken" } } }, "Webhooks_TokensMetadataRequestV1": { "type": "object", "properties": { "mintAccounts": { "type": "array", "items": { "type": "string", "description": "The mint account of the token to retrieve metadata for." }, "maxItems": 100 }, "includeOffChain": { "type": "boolean", "default": false, "description": "Include offchain data referenced in the uri of the metadata account. Omitting defaults to false." }, "disableCache": { "type": "boolean", "default": false, "description": "Disable usage of cache, useful for monitoring metadata changes." } } }, "Webhooks_TokensMetadataResponseV1": { "type": "array", "items": { "type": "object", "description": "Token metadata stored both on-chain and in the old token list.", "properties": { "account": { "type": "string" }, "onChainAccountInfo": { "$ref": "#/components/schemas/Webhooks_OnChainAccountInfoResult" }, "onChainMetadata": { "$ref": "#/components/schemas/Webhooks_OnChainMetadataResult" }, "offChainMetadata": { "$ref": "#/components/schemas/Webhooks_OffChainMetadataResult" }, "legacyMetadata": { "$ref": "#/components/schemas/Webhooks_LegacyMetadata" } } } }, "Webhooks_OnChainAccountInfoResult": { "type": "object", "properties": { "accountInfo": { "$ref": "#/components/schemas/Webhooks_OnChainAccountInfo" }, "error": { "$ref": "#/components/schemas/Webhooks_AccountErrorType" } } }, "Webhooks_OnChainMetadataResult": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Webhooks_OnChainMetadata" }, "error": { "$ref": "#/components/schemas/Webhooks_AccountErrorType" } } }, "Webhooks_OffChainMetadataResult": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Webhooks_OffChainMetadata" }, "uri": { "type": "string" }, "error": { "$ref": "#/components/schemas/Webhooks_AccountErrorType" } } }, "Webhooks_OnChainAccountInfo": { "type": "object", "description": "Account data that is stored on-chain.", "properties": { "key": { "type": "string" }, "isSigner": { "type": "boolean" }, "isWritable": { "type": "boolean" }, "lamports": { "type": "integer" }, "data": { "type": "object", "properties": { "parsed": { "type": "object", "properties": { "info": { "type": "object", "properties": { "decimals": { "type": "integer" }, "freezeAuthority": { "type": "string" }, "isInitialized": { "type": "boolean" }, "mintAuthority": { "type": "string" }, "supply": { "type": "string" } } }, "type": { "type": "string" } } }, "program": { "type": "string" }, "space": { "type": "integer" } } }, "owner": { "type": "string" }, "executable": { "type": "boolean" }, "rentEpoch": { "type": "integer" } } }, "Webhooks_LegacyMetadata": { "type": "object", "description": "Data from the old SPL token list.", "properties": { "chainId": { "type": "integer" }, "address": { "type": "string" }, "symbol": { "type": "string" }, "name": { "type": "string" }, "decimals": { "type": "integer" }, "logoURI": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "extensions": { "type": "object" } } }, "Webhooks_AccountErrorType": { "type": "string", "example": "", "enum": [ "UNKNOWN", "EMPTY_ACCOUNT", "TIMEOUT", "INVALID_ACCOUNT", "INVALID_PUBKEY" ] }, "Webhooks_ErrorResponse": { "type": "object", "properties": { "jsonrpc": { "type": "string", "description": "The JSON-RPC protocol version.", "enum": [ "2.0" ], "example": "2.0" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "description": "The error code.", "example": -32602 }, "message": { "type": "string", "description": "The error message." }, "data": { "type": "object", "description": "Additional data about the error." } } }, "id": { "type": "string", "description": "Identifier matching the request.", "example": "1" } } }, "WalletApi_Identity": { "type": "object", "properties": { "address": { "type": "string", "description": "Solana wallet address", "example": "HXsKP7wrBWaQ8T2Vtjry3Nj3oUgwYcqq9vrHDM12G664" }, "type": { "type": "string", "description": "Type of entity", "example": "exchange" }, "name": { "type": "string", "description": "Display name", "example": "Binance 1" }, "category": { "type": "string", "description": "Category classification", "example": "Centralized Exchange" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Additional classification tags", "example": [ "Centralized Exchange" ] }, "domainNames": { "type": "array", "items": { "type": "string" }, "description": "All on-chain domain names owned by this address, including SNS (.sol) and ANS custom TLDs (.bonk, .wen, etc.). The favorite .sol domain is first if set; remaining domains are sorted alphabetically. Omitted if the wallet owns no domains.", "example": [ "toly.sol", "kash.superteam" ] } }, "required": [ "address", "type", "name", "category", "tags" ] }, "WalletApi_BatchResolvedIdentity": { "description": "A resolved entry in a batch identity response. Extends `Identity` with an optional\n`inputDomain` field that is present when the original batch input for this entry was a\ndomain name. Returned only from `POST /v1/wallet/batch-identity`.\n", "allOf": [ { "$ref": "#/components/schemas/WalletApi_Identity" }, { "type": "object", "properties": { "inputDomain": { "type": "string", "description": "The domain name the caller queried. Present only when a domain (not an address) was provided as input for this batch entry.", "example": "toly.sol" } } } ] }, "WalletApi_UnresolvedDomainEntry": { "description": "A batch entry returned when a domain name could not be resolved. Only appears as an\nelement of the array returned by `POST /v1/wallet/batch-identity` — the single-endpoint\nreturns `404` instead of this shape.\n", "type": "object", "properties": { "address": { "type": "string", "nullable": true, "enum": [ null ], "description": "Always `null` for unresolved entries." }, "type": { "type": "string", "enum": [ "unknown" ], "description": "Always the literal string `\"unknown\"` for unresolved entries." }, "inputDomain": { "type": "string", "description": "The domain name the caller queried that could not be resolved.", "example": "nonexistent-xyz.sol" }, "unresolved": { "type": "boolean", "enum": [ true ], "description": "Always `true` for unresolved entries." } }, "required": [ "address", "type", "inputDomain", "unresolved" ] }, "WalletApi_BatchIdentityEntry": { "description": "One element of the array returned by `POST /v1/wallet/batch-identity`. Resolved entries\nmatch `BatchResolvedIdentity` (possibly with `inputDomain`); unresolvable domain entries\nmatch `UnresolvedDomainEntry`. Distinguish at runtime by checking `unresolved === true`\nor `address === null`.\n", "oneOf": [ { "$ref": "#/components/schemas/WalletApi_BatchResolvedIdentity" }, { "$ref": "#/components/schemas/WalletApi_UnresolvedDomainEntry" } ] }, "WalletApi_TokenBalance": { "type": "object", "properties": { "mint": { "type": "string", "description": "Token mint address", "example": "So11111111111111111111111111111111111111112" }, "symbol": { "type": "string", "nullable": true, "description": "Token symbol", "example": "SOL" }, "name": { "type": "string", "nullable": true, "description": "Token name", "example": "Solana" }, "balance": { "type": "number", "description": "Token balance (adjusted for decimals)", "example": 1.5 }, "decimals": { "type": "integer", "description": "Number of decimal places", "example": 9 }, "pricePerToken": { "type": "number", "nullable": true, "description": "Price per token in USD", "example": 145.32 }, "usdValue": { "type": "number", "nullable": true, "description": "Total USD value of holdings", "example": 217.98 }, "logoUri": { "type": "string", "nullable": true, "description": "URL to token logo image", "example": "https://example.com/sol-logo.png" }, "tokenProgram": { "type": "string", "enum": [ "spl-token", "token-2022" ], "description": "Token program type (spl-token for legacy, token-2022 for new standard)", "example": "spl-token" } }, "required": [ "mint", "balance", "decimals", "tokenProgram" ] }, "WalletApi_Nft": { "type": "object", "properties": { "mint": { "type": "string", "description": "NFT mint address", "example": "7Xq8wXyXVqfBPPqVJjPDwG9zN5wCVxBYZ6z7vPYBzr6F" }, "name": { "type": "string", "nullable": true, "description": "NFT name", "example": "Degen Ape" }, "imageUri": { "type": "string", "nullable": true, "description": "NFT image URI", "example": "https://example.com/nft.png" }, "collectionName": { "type": "string", "nullable": true, "description": "Collection name", "example": "Degen Ape Academy" }, "collectionAddress": { "type": "string", "nullable": true, "description": "Collection address", "example": "DegN1dXmU2uYa4n7U9qTh7YNYpK4u8L9qXx7XqYqJfGH" }, "compressed": { "type": "boolean", "description": "Whether this is a compressed NFT", "example": false } }, "required": [ "mint", "compressed" ] }, "WalletApi_BalancesResponse": { "type": "object", "properties": { "balances": { "type": "array", "items": { "$ref": "#/components/schemas/WalletApi_TokenBalance" }, "description": "Array of token balances for the current page, including native SOL.\nWhen showNative=true, SOL appears as the first element with mint address So11111111111111111111111111111111111111112.\nOther tokens are sorted by USD value (descending).\n" }, "nfts": { "type": "array", "items": { "$ref": "#/components/schemas/WalletApi_Nft" }, "description": "Array of NFT holdings (only included if showNfts=true, max 100, first page only)" }, "totalUsdValue": { "type": "number", "description": "Total USD value of balances on this page (not total portfolio value)", "example": 217.98 }, "pagination": { "type": "object", "description": "Pagination metadata. Users must manually request additional pages using the page parameter.", "properties": { "page": { "type": "integer", "description": "Current page number", "example": 1 }, "limit": { "type": "integer", "description": "Number of items per page", "example": 100 }, "hasMore": { "type": "boolean", "description": "True if more results are available. Increment the page parameter to fetch the next page.", "example": true } }, "required": [ "page", "limit", "hasMore" ] } }, "required": [ "balances", "totalUsdValue", "pagination" ] }, "WalletApi_BalanceChange": { "type": "object", "properties": { "mint": { "type": "string", "description": "Token mint address (or 'SOL' for native)", "example": "So11111111111111111111111111111111111111112" }, "amount": { "type": "number", "description": "Change amount (positive for increase, negative for decrease)", "example": -0.05 }, "decimals": { "type": "integer", "description": "Token decimals", "example": 9 } }, "required": [ "mint", "amount", "decimals" ] }, "WalletApi_HistoryTransaction": { "type": "object", "properties": { "signature": { "type": "string", "description": "Transaction signature", "example": "5wHu1qwD7Jsj3xqWjdSEJmYr3Q5f5RjXqjqQJ7jqEj7jqEj7jqEj7jqEj7jqEj7jqE" }, "timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp in seconds", "example": 1704067200 }, "slot": { "type": "integer", "description": "Slot number", "example": 250000000 }, "fee": { "type": "number", "description": "Transaction fee in SOL", "example": 0.000005 }, "feePayer": { "type": "string", "description": "Address that paid the transaction fee", "example": "GQUtvPx89ZNCwmvQqFmH59bJcU8fW8siETpaxod7Aydz" }, "error": { "type": "string", "nullable": true, "description": "Error message if transaction failed", "example": null }, "balanceChanges": { "type": "array", "items": { "$ref": "#/components/schemas/WalletApi_BalanceChange" }, "description": "All balance changes in this transaction" } }, "required": [ "signature", "slot", "fee", "feePayer", "balanceChanges" ] }, "WalletApi_HistoryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WalletApi_HistoryTransaction" } }, "pagination": { "$ref": "#/components/schemas/WalletApi_Pagination" } }, "required": [ "data", "pagination" ] }, "WalletApi_Transfer": { "type": "object", "properties": { "signature": { "type": "string", "description": "Transaction signature", "example": "5wHu1qwD7Jsj3xqWjdSEJmYr3Q5f5RjXqjqQJ7jqEj7jqEj7jqEj7jqEj7jqEj7jqE" }, "timestamp": { "type": "integer", "description": "Unix timestamp in seconds", "example": 1704067200 }, "direction": { "type": "string", "enum": [ "in", "out" ], "description": "Transfer direction relative to the wallet", "example": "in" }, "counterparty": { "type": "string", "description": "The other party in the transfer (sender if 'in', recipient if 'out')", "example": "HXsKP7wrBWaQ8T2Vtjry3Nj3oUgwYcqq9vrHDM12G664" }, "mint": { "type": "string", "description": "Token mint address (So11111111111111111111111111111111111111112 for SOL)", "example": "So11111111111111111111111111111111111111112" }, "symbol": { "type": "string", "nullable": true, "description": "Token symbol if known", "example": "SOL" }, "amount": { "type": "number", "description": "Transfer amount (human-readable, divided by decimals)", "example": 1.5 }, "amountRaw": { "type": "string", "description": "Raw transfer amount in smallest unit (lamports for SOL, raw token amount for SPL tokens)", "example": "1500000000" }, "decimals": { "type": "integer", "description": "Token decimals", "example": 9 } }, "required": [ "signature", "timestamp", "direction", "counterparty", "mint", "amount", "amountRaw", "decimals" ] }, "WalletApi_TransfersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WalletApi_Transfer" } }, "pagination": { "$ref": "#/components/schemas/WalletApi_Pagination" } }, "required": [ "data", "pagination" ] }, "WalletApi_FundingSource": { "type": "object", "properties": { "funder": { "type": "string", "description": "Address that originally funded this wallet", "example": "2ojv9BAiHUrvsm9gxDe7fJSzbNZSJcxZvf8dqmWGHG8S" }, "funderName": { "type": "string", "nullable": true, "description": "Name of the funder if it's a known entity", "example": "Coinbase 2" }, "funderType": { "type": "string", "nullable": true, "description": "Type of the funder entity", "example": "exchange" }, "mint": { "type": "string", "description": "Token mint address (So11111111111111111111111111111111111111112 for SOL)", "example": "So11111111111111111111111111111111111111112" }, "symbol": { "type": "string", "description": "Token symbol", "example": "SOL" }, "amount": { "type": "number", "description": "Initial funding amount (human-readable, in SOL)", "example": 0.05 }, "amountRaw": { "type": "string", "description": "Raw funding amount in smallest unit (lamports for SOL)", "example": "50000000" }, "decimals": { "type": "integer", "description": "Token decimals", "example": 9 }, "signature": { "type": "string", "description": "Transaction signature of the funding transfer", "example": "5wHu1qwD7Jsj3xqWjdSEJmYr3Q5f5RjXqjqQJ7jqEj7jqEj7jqEj7jqEj7jqEj7jqE" }, "timestamp": { "type": "integer", "description": "Unix timestamp in seconds", "example": 1704067200 }, "date": { "type": "string", "format": "date-time", "description": "Human-readable UTC date in ISO 8601 format", "example": "2024-01-01T00:00:00.000Z" }, "slot": { "type": "integer", "description": "Slot number", "example": 250000000 }, "explorerUrl": { "type": "string", "description": "Solana Explorer URL for the transaction", "example": "https://orbmarkets.io/tx/5wHu1qwD7Jsj3xqWjdSEJmYr3Q5f5RjXqjqQJ7jqEj7jqEj7jqEj7jqEj7jqEj7jqE" } }, "required": [ "funder", "mint", "symbol", "amount", "amountRaw", "decimals", "signature", "timestamp", "date", "slot", "explorerUrl" ] }, "WalletApi_Pagination": { "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "Whether more results are available", "example": true }, "nextCursor": { "type": "string", "nullable": true, "description": "Cursor to fetch the next page of results", "example": "5wHu1qwD7Jsj3xqWjdSEJmYr3Q5f5RjXqjqQJ7jqEj7jqEj7jqEj7jqEj7jqEj7jqE" } }, "required": [ "hasMore" ] }, "WalletApi_Error": { "type": "object", "properties": { "error": { "type": "string", "description": "Error message", "example": "Invalid wallet address" }, "code": { "type": "integer", "description": "HTTP status code", "example": 400 }, "details": { "type": "string", "description": "Additional error details", "example": "'invalid-address' is not a valid Solana address" } }, "required": [ "error", "code" ] }, "SenderApi_ErrorResponse": { "type": "object", "properties": { "jsonrpc": { "type": "string", "description": "The JSON-RPC protocol version.", "enum": [ "2.0" ], "example": "2.0" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "description": "The error code.", "example": -32602 }, "message": { "type": "string", "description": "The error message." }, "data": { "type": "object", "description": "Additional data about the error." } } }, "id": { "type": "string", "description": "Identifier matching the request.", "example": "1" } } }, "PriorityFeeApi_PriorityFeeEstimateRequest": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "default": "2.0", "description": "JSON-RPC version identifier for the Solana RPC API request, must be \"2.0\"" }, "id": { "type": "string", "default": "1", "description": "Client-generated identifier for the request" }, "method": { "type": "string", "enum": [ "getPriorityFeeEstimate" ], "default": "getPriorityFeeEstimate", "description": "The RPC method name" }, "params": { "type": "array", "description": "Parameters for the method call", "default": [ { "transaction": "LxzhDW7TapzziJVHEGPh1QjmZB6kjNqmvuJ9gmihBGEkzw2N8ospDq32UZdVmKWzRZqKuyvhp7xmLvsmmHa3MfxVKpYoLV9cPkw5isHnHgDUwLSMsDaZ4dLEULexXAvuV9k6fLD2LMhFKM6gqH6j69GQLAm1g4e3z5ZVZN6pmJdSmZ4PqKcwNn4sS7E3Abp1hV59uBJB9i4jEdEAh28rZ8WCeNizzEmrJZFhatFFFGSDsk23jDPEjbkMcoRWXKf1WthFScC2S6Wz284Dtjqp7kW8eybV3DpmN9DtBbcfFNQPtUwmiBZCKszdYym5AjJvRHiUKUdMwFpC3toPnMvTmKZ9iHQtzZRkg5xBufRtUN5eVYJfdw2DxzH6RfqhC2rAjfSbfJA4wmaq9f5eUe2iEjmqvne6r85PPcHBJzyqkVtAyUFtTc9DfU8UiM9rFhQ2UB71M6m5UCsC6EwowMw5k8iF8rL7iPCLdubVdy8S58DPLNG4E4rdosev1T63YdRWSgEwBZh7iX4zGBA9AKAm3B9itCSxLSL46Y6uZgVku9UXsMcWWz3URoa6hRbo55CYPLhrVeqjqX5DsXpaG6QkngbEaESQUnkakE1AFkYXmNXEd2m3sLRTYB2o5UTkwkJS2u5sJHyYqAvXr3vFZr7qAYFLD3LwS5tsdb45ZQVQwsbnNddMHgkpmSqLHS6Fv1epxqHbzpRCU1tgMsriApVWC3pj2LLD41HxkV8aKvkVyHgJFACUtbvRBZAasHf1F71Gz3qZNTdh3efWsZJRXnfxKPbATU7NTMaMUL8JjknfoVwp3" } ], "items": { "type": "object", "properties": { "transaction": { "type": "string", "description": "Base58 or Base64 encoded Solana transaction for which to estimate optimal priority fees.\nThe API will analyze the specific instructions and accounts in this transaction to provide\naccurate fee estimates based on current network conditions and computational complexity.\n" }, "accountKeys": { "type": "array", "description": "Array of Solana account public keys to estimate priority fees for (alternative to providing a transaction)", "items": { "type": "string", "description": "Base58 encoded public key of a Solana account" } }, "options": { "$ref": "#/components/schemas/PriorityFeeApi_PriorityFeeOptions" } } } } } }, "PriorityFeeApi_PriorityFeeOptions": { "type": "object", "description": "Advanced options for customizing Solana priority fee estimation based on network conditions", "properties": { "transactionEncoding": { "type": "string", "enum": [ "Base58", "Base64" ], "description": "Encoding format of the provided Solana transaction" }, "priorityLevel": { "type": "string", "enum": [ "Min", "Low", "Medium", "High", "VeryHigh", "UnsafeMax" ], "description": "Specific priority level to estimate fees for based on current Solana network congestion" }, "includeAllPriorityFeeLevels": { "type": "boolean", "description": "When true, returns comprehensive estimates for all priority levels from minimum to maximum" }, "lookbackSlots": { "type": "integer", "minimum": 1, "maximum": 150, "description": "Number of recent Solana blockchain slots to analyze for accurate fee estimation (1-150)" }, "includeVote": { "type": "boolean", "description": "When true, includes vote transactions in the fee calculation for more comprehensive analysis" }, "recommended": { "type": "boolean", "description": "When true, returns the recommended optimal fee based on current Solana network conditions" }, "evaluateEmptySlotAsZero": { "type": "boolean", "description": "When true, slots with no transactions are counted as zero-fee slots in the calculation" } } }, "PriorityFeeApi_PriorityFeeEstimateResponse": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "description": "JSON-RPC version identifier" }, "id": { "type": "string", "description": "Client-generated identifier matching the request" }, "result": { "type": "object", "description": "Result object containing comprehensive Solana priority fee estimates", "properties": { "priorityFeeEstimate": { "type": "number", "format": "float", "description": "Estimated optimal priority fee in microlamports for the requested Solana transaction,\ncalculated based on recent blockchain activity and computational requirements.\n" }, "priorityFeeLevels": { "type": "object", "description": "Detailed fee estimates for different priority levels on the Solana blockchain (in microlamports),\nallowing developers to choose the optimal balance between cost and confirmation speed.\n", "properties": { "min": { "type": "number", "format": "float", "description": "Minimum viable fee for Solana transactions - suitable for non-urgent transactions during low congestion periods\n(may result in transaction failure during network congestion)\n" }, "low": { "type": "number", "format": "float", "description": "Low priority fee for Solana transactions - economical option for transactions that aren't time-sensitive\n(longer confirmation time, lower cost)\n" }, "medium": { "type": "number", "format": "float", "description": "Medium priority fee for Solana transactions - balanced option for most standard transactions\n(reasonable confirmation time with moderate cost)\n" }, "high": { "type": "number", "format": "float", "description": "High priority fee for Solana transactions - prioritized processing for time-sensitive operations\nlike DeFi trades or NFT mints (faster confirmation, higher cost)\n" }, "veryHigh": { "type": "number", "format": "float", "description": "Very high priority fee for Solana transactions - premium option for critical transactions requiring\nnear-immediate confirmation (very fast confirmation, premium cost)\n" }, "unsafeMax": { "type": "number", "format": "float", "description": "Maximum observed fee on Solana - the highest fee seen in the analysis window, representing\nan upper bound during extreme congestion (fastest possible confirmation, but potentially unnecessarily high)\n" } } } } } } }, "AdminApi_ProjectUsageResponse": { "type": "object", "properties": { "creditsRemaining": { "type": "number", "description": "Number of credits remaining in the current billing cycle. Calculated as `creditsLimit - regularCreditsUsed`, floored at 0.", "example": 487500 }, "creditsUsed": { "type": "number", "description": "Total credits consumed in the current billing cycle, including both regular and prepaid credits.", "example": 12500 }, "prepaidCreditsRemaining": { "type": "number", "description": "Number of prepaid credits remaining.", "example": 50000 }, "prepaidCreditsUsed": { "type": "number", "description": "Number of prepaid credits consumed in the current billing cycle.", "example": 0 }, "subscriptionDetails": { "type": "object", "description": "Details about the project's subscription plan and current billing cycle.", "properties": { "billingCycle": { "type": "object", "description": "Start and end dates of the current billing cycle.", "properties": { "start": { "type": "string", "description": "Billing cycle start date.", "example": "2026-04-01" }, "end": { "type": "string", "description": "Billing cycle end date.", "example": "2026-05-01" } } }, "creditsLimit": { "type": "number", "description": "Total credit allowance for the current billing cycle based on the plan.", "example": 500000 }, "plan": { "type": "string", "description": "The name of the subscription plan.", "example": "business" } } }, "usage": { "type": "object", "description": "Request counts broken down by service type for the current billing cycle.", "properties": { "api": { "type": "number", "description": "Number of Enhanced API requests (e.g., parsed transactions, token metadata).", "example": 1200 }, "archival": { "type": "number", "description": "Number of archival RPC requests.", "example": 0 }, "das": { "type": "number", "description": "Number of DAS (Digital Asset Standard) API requests.", "example": 5000 }, "grpc": { "type": "number", "description": "Number of gRPC streaming requests.", "example": 300 }, "grpcGeyser": { "type": "number", "description": "Number of Geyser gRPC requests.", "example": 0 }, "photon": { "type": "number", "description": "Number of ZK Compression (Photon) requests.", "example": 0 }, "rpc": { "type": "number", "description": "Number of standard Solana RPC requests.", "example": 4500 }, "stream": { "type": "number", "description": "Number of LaserStream data streaming requests.", "example": 100 }, "webhook": { "type": "number", "description": "Number of webhook delivery events.", "example": 800 }, "websocket": { "type": "number", "description": "Number of WebSocket subscription requests.", "example": 600 } } } } }, "AdminApi_ErrorResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP status code." }, "message": { "type": "string", "description": "Human-readable error message." }, "error": { "type": "string", "description": "HTTP error name." } } } }, "parameters": { "EnhancedApi_limitParam": { "name": "limit", "in": "query", "description": "Maximum number of items to return.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 100 } }, "EnhancedApi_beforeParam": { "name": "before", "in": "query", "description": "Start searching backwards from this transaction signature.", "required": false, "schema": { "type": "string" } }, "EnhancedApi_untilParam": { "name": "until", "in": "query", "description": "Search until this transaction signature.", "required": false, "schema": { "type": "string" } }, "EnhancedApi_beforeSigParam": { "name": "before-signature", "in": "query", "description": "Start searching backwards from this transaction signature.", "required": false, "schema": { "type": "string" } }, "EnhancedApi_afterSigParam": { "name": "after-signature", "in": "query", "description": "Start searching forwards from this transaction signature.", "required": false, "schema": { "type": "string" } }, "EnhancedApi_sortOrderParam": { "name": "sort-order", "in": "query", "description": "The order to sort the results in.", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, "EnhancedApi_tokenAccountsParam": { "name": "token-accounts", "in": "query", "description": "Filter transactions for related token accounts. Controls whether to include transactions involving token accounts owned by the address.", "required": false, "schema": { "type": "string", "enum": [ "none", "balanceChanged", "all" ], "default": "none" } }, "EnhancedApi_gtSlotParam": { "name": "gt-slot", "in": "query", "description": "Only return transactions with a slot greater than this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_gteSlotParam": { "name": "gte-slot", "in": "query", "description": "Only return transactions with a slot greater than or equal to this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_ltSlotParam": { "name": "lt-slot", "in": "query", "description": "Only return transactions with a slot less than this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_lteSlotParam": { "name": "lte-slot", "in": "query", "description": "Only return transactions with a slot less than or equal to this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_gtTimeParam": { "name": "gt-time", "in": "query", "description": "Only return transactions with a block time greater than this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_gteTimeParam": { "name": "gte-time", "in": "query", "description": "Only return transactions with a block time greater than or equal to this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_ltTimeParam": { "name": "lt-time", "in": "query", "description": "Only return transactions with a block time less than this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_lteTimeParam": { "name": "lte-time", "in": "query", "description": "Only return transactions with a block time less than or equal to this value.", "required": false, "schema": { "type": "integer" } }, "EnhancedApi_commitmentParam": { "name": "commitment", "in": "query", "description": "How finalized a block must be to be included in the search. If not provided, will default to \"finalized\" commitment. Note that \"processed\" level commitment is not supported.", "required": false, "schema": { "$ref": "#/components/schemas/EnhancedApi_Commitment" } }, "EnhancedApi_addressParam": { "name": "address", "in": "path", "description": "The address to query for.", "required": true, "schema": { "type": "string", "example": "86xCnPeV69n6t3DnyGvkKobf9FdN2H9oiVDdaMpo2MMY", "default": "86xCnPeV69n6t3DnyGvkKobf9FdN2H9oiVDdaMpo2MMY" } }, "EnhancedApi_webhookIDParam": { "name": "webhookID", "in": "path", "description": "The webhook ID — a UUIDv4 that uniquely identifies the webhook.", "required": true, "schema": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "EnhancedApi_pageNumberParam": { "name": "pageNumber", "in": "query", "description": "The page number used for pagination.", "required": false, "schema": { "type": "number" } }, "EnhancedApi_transactionIdParam": { "name": "transaction-id", "in": "path", "description": "The signature of the transaction you wish to query for.", "required": true, "schema": { "type": "string" } }, "EnhancedApi_transactionSourceParam": { "name": "source", "in": "query", "description": "The TransactionSource to filter by. For a list of possible options, see the Transaction Types section.", "required": false, "schema": { "$ref": "#/components/schemas/EnhancedApi_TransactionSource" } }, "EnhancedApi_transactionTypeParam": { "name": "type", "in": "query", "description": "The TransactionType to filter by. For a list of possible options, see the Transaction Types section.", "required": false, "schema": { "$ref": "#/components/schemas/EnhancedApi_TransactionType" } }, "EnhancedApi_limitNewParam": { "name": "limit", "in": "query", "description": "The number of transactions to retrieve. The value should be between 1 and 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, "Webhooks_limitParam": { "name": "limit", "in": "query", "description": "Maximum number of items to return.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 100 } }, "Webhooks_beforeParam": { "name": "before", "in": "query", "description": "Start searching backwards from this transaction signature.", "required": false, "schema": { "type": "string" } }, "Webhooks_untilParam": { "name": "until", "in": "query", "description": "Search until this transaction signature.", "required": false, "schema": { "type": "string" } }, "Webhooks_commitmentParam": { "name": "commitment", "in": "query", "description": "How finalized a block must be to be included in the search. If not provided, will default to \"finalized\" commitment. Note that \"processed\" level commitment is not supported.", "required": false, "schema": { "$ref": "#/components/schemas/Webhooks_Commitment" } }, "Webhooks_addressParam": { "name": "address", "in": "path", "description": "The address to query for.", "required": true, "schema": { "type": "string" } }, "Webhooks_webhookIDParam": { "name": "webhookID", "in": "path", "description": "The webhook ID — a UUIDv4 that uniquely identifies the webhook.", "required": true, "schema": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "Webhooks_pageNumberParam": { "name": "pageNumber", "in": "query", "description": "The page number used for pagination.", "required": false, "schema": { "type": "number" } }, "Webhooks_transactionIdParam": { "name": "transaction-id", "in": "path", "description": "The signature of the transaction you wish to query for.", "required": true, "schema": { "type": "string" } }, "Webhooks_transactionSourceParam": { "name": "source", "in": "query", "description": "The TransactionSource to filter by. For a list of possible options, see the Transaction Types section.", "required": false, "schema": { "$ref": "#/components/schemas/Webhooks_TransactionSource" } }, "Webhooks_transactionTypeParam": { "name": "type", "in": "query", "description": "The TransactionType to filter by. For a list of possible options, see the Transaction Types section.", "required": false, "schema": { "$ref": "#/components/schemas/Webhooks_TransactionType" } }, "Webhooks_limitNewParam": { "name": "limit", "in": "query", "description": "The number of transactions to retrieve. The value should be between 1 and 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, "WalletApi_WalletAddress": { "name": "wallet", "in": "path", "required": true, "description": "Solana wallet address (base58 encoded)", "schema": { "type": "string", "pattern": "^[1-9A-HJ-NP-Za-km-z]{32,44}$" }, "example": "GQUtvPx89ZNCwmvQqFmH59bJcU8fW8siETpaxod7Aydz" }, "WalletApi_WalletOrDomain": { "name": "wallet", "in": "path", "required": true, "description": "Solana wallet address (base58 encoded) or SNS/ANS domain name (e.g. `toly.sol`,\n`miester.bonk`). Domain resolution is mainnet-only. Any non-`.sol` domain is treated\nas an ANS custom TLD — there is no fixed TLD whitelist.\n", "schema": { "type": "string" }, "examples": { "address": { "summary": "Solana address", "value": "GQUtvPx89ZNCwmvQqFmH59bJcU8fW8siETpaxod7Aydz" }, "snsDomain": { "summary": "SNS (.sol) domain", "value": "toly.sol" }, "ansDomain": { "summary": "ANS custom TLD", "value": "miester.bonk" } } }, "apiKeyParam": { "name": "api-key", "in": "query", "required": true, "description": "Helius API key. Obtain from https://dashboard.helius.dev or via `helius signup --json`.", "schema": { "type": "string" } } }, "responses": { "EnhancedApi_200-NoContent": { "description": "No content.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "EnhancedApi_400-BadRequest": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32602, "message": "Invalid params" }, "id": "1" } } } }, "EnhancedApi_401-Unauthorized": { "description": "Unauthorized request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32001, "message": "Unauthorized" }, "id": "1" } } } }, "EnhancedApi_403-Forbidden": { "description": "Request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32003, "message": "Forbidden" }, "id": "1" } } } }, "EnhancedApi_404-NotFound": { "description": "The specified resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32601, "message": "Method not found" }, "id": "1" } } } }, "EnhancedApi_429-TooManyRequests": { "description": "Exceeded rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32005, "message": "Rate limit exceeded" }, "id": "1" } } } }, "EnhancedApi_500-InternalServerError": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32603, "message": "Internal error" }, "id": "1" } } } }, "EnhancedApi_503-ServiceUnavailable": { "description": "The service is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32002, "message": "Service unavailable" }, "id": "1" } } } }, "EnhancedApi_504-GatewayTimeout": { "description": "The request timed out.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedApi_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32003, "message": "Gateway timeout" }, "id": "1" } } } }, "Webhooks_200-NoContent": { "description": "No content.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "Webhooks_400-BadRequest": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32602, "message": "Invalid params" }, "id": "1" } } } }, "Webhooks_401-Unauthorized": { "description": "Unauthorized request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32001, "message": "Unauthorized" }, "id": "1" } } } }, "Webhooks_403-Forbidden": { "description": "Request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32003, "message": "Forbidden" }, "id": "1" } } } }, "Webhooks_404-NotFound": { "description": "The specified resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32601, "message": "Method not found" }, "id": "1" } } } }, "Webhooks_429-TooManyRequests": { "description": "Exceeded rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32005, "message": "Rate limit exceeded" }, "id": "1" } } } }, "Webhooks_500-InternalServerError": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32603, "message": "Internal error" }, "id": "1" } } } }, "Webhooks_503-ServiceUnavailable": { "description": "The service is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32002, "message": "Service unavailable" }, "id": "1" } } } }, "Webhooks_504-GatewayTimeout": { "description": "The request timed out.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks_ErrorResponse" }, "example": { "jsonrpc": "2.0", "error": { "code": -32003, "message": "Gateway timeout" }, "id": "1" } } } }, "WalletApi_BadRequest": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_Error" }, "example": { "error": "Invalid wallet address", "code": 400, "details": "'invalid-address' is not a valid Solana address" } } } }, "WalletApi_Unauthorized": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_Error" }, "example": { "error": "API key required. Pass via ?api-key=xxx or X-Api-Key header", "code": 401 } } } }, "WalletApi_RateLimited": { "description": "Rate limit exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_Error" }, "example": { "error": "RATE_LIMIT_EXCEEDED", "code": 429, "details": "Too many requests. Retry after 2 seconds." } } } }, "WalletApi_InternalError": { "description": "Transient server error. Retryable with exponential backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletApi_Error" }, "example": { "error": "INTERNAL_ERROR", "code": 500, "details": "An unexpected error occurred. Please retry." } } } } }, "securitySchemes": { "ApiKeyQuery": { "type": "apiKey", "in": "query", "name": "api-key", "description": "Your Helius API key. You can get one for free in the [dashboard](https://dashboard.helius.dev/api-keys)." }, "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "API key passed in request header" } }, "examples": { "SenderApi_request": { "value": { "jsonrpc": "2.0", "id": "1", "method": "sendTransaction", "params": [ "Ab/WBgJxCprwWlK2fCxSwm9KrWlJQW8TdnYqXMvg5KropeLqHaa5yJeoWUb+LsGi6zlfs1Z/jA/RgJW++tBhPAKAAQACBGuePYZrXq9Jj+DwkquiMvsrNU5rlcAbmRfuAYui/CwAQr437DqfrFoSt1BSgM/2/0Iqja1QMefnu1hTYX96AA0DBkZv5SEXMv/srbpyw5vnvIzlu8X3EmssQ5s6QAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAhWHa4WfUT12o+cyi2WGwfBvngyurXf5VQd4Ukn+5ZSIDAgAFAqCGAQACAAkDQA0DAAAAAAADAgABDAIAAABAQg8AAAAAAAA=", { "encoding": "base64", "skipPreflight": true, "maxRetries": 0 } ] } }, "SenderApi_response": { "value": { "jsonrpc": "2.0", "id": "1", "result": "4qTLpN1sBrp5SzZUKfrSH2897FmxA7AB4EbN4ccgSgEjG9RG2686pSKWhEbz65q4bvaRsdpKRJKZ3dkdGZA78u5s" } } } }, "tags": [ { "name": "NFTs", "description": "Access comprehensive NFT data including events, collection aggregations, real-time stats, and complete historical activity on Solana." }, { "name": "Tokens", "description": "Complete token account data, on-chain and off-chain metadata, and detailed information for both fungible and non-fungible Solana tokens." }, { "name": "Transactions", "description": "Enhanced and human-readable transaction histories with decoded instruction data and detailed context." }, { "name": "Addresses", "description": "Enhanced on-chain identity data with complete wallet activity and ownership information." }, { "name": "Webhooks", "description": "Configure real-time blockchain notifications for any Solana address, transaction type, or on-chain event with customizable delivery options." }, { "name": "Identity", "description": "Lookup wallet identities and known addresses" }, { "name": "Balances", "description": "Query token and NFT balances" }, { "name": "History", "description": "Transaction history and balance changes" }, { "name": "Transfers", "description": "Token transfer activity" }, { "name": "Funding", "description": "Wallet funding information" } ] }