{ "openapi": "3.1.1", "info": { "title": "Crypto.PublicApi | v1", "version": "1.0.0" }, "servers": [ { "url": "https://api-p.herowallet.com", "description": "Production server" } ], "paths": { "/v1/public/blockchains": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets active mainnet blockchains for website clients.", "operationId": "GetPublicBlockchains", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicBlockchainResponse" } } } } } } } }, "/v1/public/tokens": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets a paginated page of active mainnet tokens with optional filters.", "operationId": "GetPublicTokens", "parameters": [ { "name": "NetworkId", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "ChainId", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Blockchain", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "PageId", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "PageCount", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIndexOfPublicTokenResponse" } } } } } } }, "/v1/public/tokens/new": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets tokens listed in the last 24 hours enriched with public metadata.", "operationId": "GetPublicNewTokens", "parameters": [ { "name": "Blockchain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIndexOfPublicNewTokenResponse" } } } } } } }, "/v1/public/tokens/trending": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets currently trending tokens on CoinGecko with optional filters.", "operationId": "GetPublicTrendingTokens", "parameters": [ { "name": "Blockchain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIndexOfPublicTrendingTokenResponse" } } } } } } }, "/v1/public/tokens/high-volume": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets tokens ordered by highest 24h trading volume with optional filters.", "operationId": "GetPublicHighVolumeTokens", "parameters": [ { "name": "Blockchain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIndexOfPublicHighVolumeTokenResponse" } } } } } } }, "/v1/public/tokens/high-liquidity": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets tokens ordered by liquidity ratio (TotalVolume / MarketCap) with optional filters.", "operationId": "GetPublicHighLiquidityTokens", "parameters": [ { "name": "Blockchain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIndexOfPublicHighLiquidityTokenResponse" } } } } } } }, "/v1/public/tokens/top-gainers": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets tokens with the highest price change percentage in the given interval.", "operationId": "GetPublicTopGainers", "parameters": [ { "name": "Blockchain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIndexOfPublicGainerLoserTokenResponse" } } } } } } }, "/v1/public/tokens/top-losers": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets tokens with the lowest price change percentage in the given interval.", "operationId": "GetPublicTopLosers", "parameters": [ { "name": "Blockchain", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Interval", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IIndexOfPublicGainerLoserTokenResponse" } } } } } } }, "/v1/public/tokens/detail": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets detailed token information including market data and supported networks. Pass apiId for CoinGecko source, or contractAddress + blockchain for CoinMarketCap source.", "operationId": "GetPublicTokenDetail", "parameters": [ { "name": "apiId", "in": "query", "schema": { "type": "string" } }, { "name": "contractAddress", "in": "query", "schema": { "type": "string" } }, { "name": "blockchain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTokenDetailResponse" } } } } } } }, "/v1/public/tokens/history-chart": { "get": { "tags": [ "Public Catalog" ], "summary": "Gets token price/market-cap/volume history. Pass tokenApiId for CoinGecko source, or contractAddress + blockchain for contract-based CoinGecko source.", "operationId": "GetPublicTokenHistoryChart", "parameters": [ { "name": "ContractAddress", "in": "query", "schema": { "type": "string" } }, { "name": "TokenApiId", "in": "query", "schema": { "type": "string" } }, { "name": "Blockchain", "in": "query", "schema": { "type": "string" } }, { "name": "TimeFrame", "in": "query", "schema": { "$ref": "#/components/schemas/TimeFrame" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTokenHistoryChartResponse" } } } } } } }, "/v1/public/support": { "get": { "tags": [ "Public Catalog" ], "summary": "Returns which public catalog features are supported for the given blockchain.", "operationId": "GetBlockchainSupport", "parameters": [ { "name": "blockchain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockchainSupportResponse" } } } }, "400": { "description": "Bad Request" } } } }, "/v1/public/token-logo": { "get": { "tags": [ "Public Catalog" ], "summary": "Proxies a token logo image from an allowed external host.", "operationId": "GetTokenLogo", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/png": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } } }, "components": { "schemas": { "BlockchainSupportResponse": { "type": "object", "properties": { "blockchain": { "type": "string" }, "hasNewTokens": { "type": "boolean" }, "hasTrendingTokens": { "type": "boolean" }, "hasHighVolumeTokens": { "type": "boolean" }, "hasHighLiquidityTokens": { "type": "boolean" }, "hasTopGainers": { "type": "boolean" }, "hasTopLosers": { "type": "boolean" } } }, "IIndexOfPublicGainerLoserTokenResponse": { "type": "object", "properties": { "currentPage": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/PublicGainerLoserTokenResponse" } }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalRecords": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paging": { "type": [ "null", "string" ] } } }, "IIndexOfPublicHighLiquidityTokenResponse": { "type": "object", "properties": { "currentPage": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/PublicHighLiquidityTokenResponse" } }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalRecords": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paging": { "type": [ "null", "string" ] } } }, "IIndexOfPublicHighVolumeTokenResponse": { "type": "object", "properties": { "currentPage": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/PublicHighVolumeTokenResponse" } }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalRecords": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paging": { "type": [ "null", "string" ] } } }, "IIndexOfPublicNewTokenResponse": { "type": "object", "properties": { "currentPage": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/PublicNewTokenResponse" } }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalRecords": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paging": { "type": [ "null", "string" ] } } }, "IIndexOfPublicTokenResponse": { "type": "object", "properties": { "currentPage": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/PublicTokenResponse" } }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalRecords": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paging": { "type": [ "null", "string" ] } } }, "IIndexOfPublicTrendingTokenResponse": { "type": "object", "properties": { "currentPage": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/PublicTrendingTokenResponse" } }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalRecords": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paging": { "type": [ "null", "string" ] } } }, "NetworkType": { "type": "integer" }, "PublicBlockchainResponse": { "type": "object", "properties": { "networkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "name": { "type": "string" }, "showName": { "type": [ "null", "string" ] }, "chainName": { "type": [ "null", "string" ] }, "networkApiId": { "type": [ "null", "string" ] }, "chainId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "networkType": { "$ref": "#/components/schemas/NetworkType" }, "logoUrl": { "type": [ "null", "string" ] }, "supportOnMobile": { "type": "boolean" }, "supportOnWeb": { "type": "boolean" }, "supportOnExtension": { "type": "boolean" }, "supportSend": { "type": "boolean" }, "supportReceive": { "type": "boolean" }, "supportSwap": { "type": "boolean" } } }, "PublicGainerLoserTokenResponse": { "type": "object", "properties": { "networkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "chainId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "network": { "$ref": "#/components/schemas/NetworkType" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "blockChain": { "type": "string" }, "contractAddress": { "type": [ "null", "string" ] }, "dexerName": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "currentPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "marketCap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "liquidity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "volume24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "priceChangePercentage24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "PublicHighLiquidityTokenResponse": { "type": "object", "properties": { "networkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "chainId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "network": { "$ref": "#/components/schemas/NetworkType" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "blockChain": { "type": "string" }, "apiIdMarket": { "type": [ "null", "string" ] }, "contractAddress": { "type": "string" }, "dexerName": { "type": "string" }, "currentPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "marketCap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "volume24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "liquidity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceChangePercentage24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "PublicHighVolumeTokenResponse": { "type": "object", "properties": { "networkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "chainId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "network": { "$ref": "#/components/schemas/NetworkType" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "blockChain": { "type": "string" }, "apiIdMarket": { "type": [ "null", "string" ] }, "contractAddress": { "type": "string" }, "dexerName": { "type": "string" }, "currentPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "marketCap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "volume24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceChangePercentage24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "PublicNewTokenResponse": { "type": "object", "properties": { "networkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "chainId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "network": { "$ref": "#/components/schemas/NetworkType" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "blockChain": { "type": "string" }, "apiIdMarket": { "type": [ "null", "string" ] }, "contractAddress": { "type": [ "null", "string" ] }, "dexerName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "priceChangePercentage24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "PublicTokenDetailResponse": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "symbol": { "type": [ "null", "string" ] }, "logoUrl": { "type": [ "null", "string" ] }, "currentPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "priceChangePercentage24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "marketCap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "volume24H": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "circulatingSupply": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "marketCapRank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "genesisDate": { "type": [ "null", "string" ], "format": "date-time" }, "description": { "type": [ "null", "string" ] }, "supportedNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/PublicTokenDetailResponseSupportedNetwork" } } } }, "PublicTokenDetailResponseSupportedNetwork": { "type": "object", "properties": { "name": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "showName": { "type": [ "null", "string" ] }, "chainName": { "type": [ "null", "string" ] }, "networkType": { "type": "string" } } }, "PublicTokenHistoryChartResponse": { "type": "object", "properties": { "prices": { "type": "array", "items": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "marketCaps": { "type": "array", "items": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "totalVolumes": { "type": "array", "items": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } } } }, "PublicTokenResponse": { "type": "object", "properties": { "assetNetworkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "networkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "chainId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "network": { "$ref": "#/components/schemas/NetworkType" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "blockChain": { "type": "string" }, "caption": { "type": [ "null", "string" ] }, "apiId": { "type": [ "null", "string" ] }, "apiIdMarket": { "type": [ "null", "string" ] }, "contractAddress": { "type": [ "null", "string" ] }, "decimals": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "rank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "currentPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "marketCap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "totalVolume": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "priceChangePercentage24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "PublicTrendingTokenResponse": { "type": "object", "properties": { "networkId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "chainId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "network": { "$ref": "#/components/schemas/NetworkType" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "blockChain": { "type": "string" }, "apiIdMarket": { "type": [ "null", "string" ] }, "contractAddress": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "currentPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "marketCap": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "liquidity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "priceChangePercentage24h": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "TimeFrame": { "type": "integer" } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "Pass your API key in the **X-Api-Key** header.", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "ApiKey": [ ] } ], "tags": [ { "name": "Public Catalog" } ] }