{ "openapi": "3.0.0", "info": { "title": "Arkham Intel API", "version": "1.1.0" }, "paths": { "/analytics/credit-periods": { "get": { "summary": "Get historical credit usage by billing period", "description": "Returns the last 12 billing periods of credit usage for your billing entity.\n\nEach period includes the period boundaries, plan credits included, extra (overage) credits, and total credits consumed.\n\nOnly available to organization admins (returning their org's usage) and individual API subscribers (returning their own usage). Other callers receive `403`.", "operationId": "GetCreditPeriods", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditUsagePeriod" }, "example": [ { "computedAt": "2026-05-01T00:05:12Z", "creditsIncluded": 500000, "creditsUsed": 482350, "entityId": "org_01HF8X3J0KQZ2N7T6P9YV4WB5R", "entityType": "org", "extraCredits": 0, "periodEnd": "2026-05-01T00:00:00Z", "periodStart": "2026-04-01T00:00:00Z", "status": "closed" } ] } } } }, "500": { "description": "Internal Server Error" } } } }, "/analytics/endpoint-calls": { "get": { "summary": "Get API endpoint call analytics", "description": "Returns your API usage broken down by endpoint, including call counts and credits consumed.\n\nIf your API key belongs to an organization member, results are scoped to your usage within that org. Otherwise, results cover your individual subscription usage.", "operationId": "GetAnalyticsData", "parameters": [ { "name": "period", "in": "query", "description": "Time window: \"24h\", \"7d\", or \"30d\". Defaults to \"24h\". Ignored when both start_date and end_date are provided.", "schema": { "enum": [ "24h", "7d", "30d" ], "type": "string", "description": "Time window: \"24h\", \"7d\", or \"30d\". Defaults to \"24h\". Ignored when both start_date and end_date are provided.", "example": "7d" } }, { "name": "end_date", "in": "query", "description": "RFC3339 timestamp. Historical cutoff for the period-based window, or the upper bound of a custom range.", "schema": { "type": "string", "description": "RFC3339 timestamp. Historical cutoff for the period-based window, or the upper bound of a custom range.", "example": "2026-05-26T00:00:00Z" } }, { "name": "start_date", "in": "query", "description": "RFC3339 timestamp. Lower bound of a custom date range. Only takes effect together with end_date — a custom range requires both; start_date supplied on its own is ignored. Max range 366 days.", "schema": { "type": "string", "description": "RFC3339 timestamp. Lower bound of a custom date range. Only takes effect together with end_date — a custom range requires both; start_date supplied on its own is ignored. Max range 366 days.", "example": "2026-04-26T00:00:00Z" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/arkm/circulating": { "get": { "summary": "Get ARKM circulating supply", "description": "Returns the current circulating supply of ARKM tokens.", "operationId": "GetARKMCirculating", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetARKMCirculatingResponse" } } } }, "500": { "description": "Internal Server Error" } } } }, "/balances/address/{address}": { "get": { "summary": "Get token balances for an address", "description": "Returns token balances for the specified address, optionally filtered by chains.", "operationId": "GetAddressBalances", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bsc'). If omitted, returns balances across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query balances for.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query balances for.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressBalancesResponse" }, "example": { "addresses": { "bsc": { "0x28C6c06298d514Db089934071355E5743bf21d60": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "bsc", "contract": false, "isUserAddress": false } }, "ethereum": { "0x28C6c06298d514Db089934071355E5743bf21d60": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false } } }, "balances": { "bsc": [ { "balance": 3734.2858510100004, "balanceExact": "3734285851010000000000", "ethereumAddress": "0x55d398326f99059fF775485246999027B3197955", "id": "binance-bridged-usdt-bnb-smart-chain", "name": "Tether USD", "price": 1, "priceChange24h": 0, "priceChange24hPercent": 0, "quoteTime": "2026-07-06T08:56:06.003Z", "symbol": "USDT", "usd": 3734.2858510100004 } ], "ethereum": [ { "balance": 933180509.069545, "balanceExact": "933180509069545", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether USD", "price": 1, "priceChange24h": 0, "priceChange24hPercent": 0, "quoteTime": "2026-07-06T08:56:21.074Z", "symbol": "USDT", "usd": 933180509.069545 }, { "balance": 264229.89222968067, "balanceExact": "264229892229680683921876", "id": "ethereum", "name": "Ethereum", "price": 1764.02, "priceChange24h": -2.2200000000000273, "priceChange24hPercent": -0.12569073285623852, "quoteTime": "2026-07-06T08:56:12.855Z", "symbol": "ETH", "usd": 466106814.4910013 } ] }, "totalBalance": { "bsc": 4958.963746508313, "ethereum": 1851859770.8709288 }, "totalBalance24hAgo": { "bsc": 4962.53510092634, "ethereum": 1855389918.2681246 } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/balances/entity/{entity}": { "get": { "summary": "Get token balances for an entity", "description": "Returns token balances for the specified entity, optionally filtered by chains.", "operationId": "GetEntityBalances", "parameters": [ { "name": "cheap", "in": "query", "description": "If 'true', uses a faster but less real-time balance query (up to 24 hours delayed).", "schema": { "type": "string", "description": "If 'true', uses a faster but less real-time balance query (up to 24 hours delayed).", "example": "true" } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bsc'). If omitted, returns balances across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "entity", "in": "path", "description": "The entity ID to query balances for.", "required": true, "schema": { "type": "string", "description": "The entity ID to query balances for.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityBalancesResponse" }, "example": { "balances": { "bsc": [ { "balance": 40881.77844727871, "id": "binance-bitcoin", "name": "Binance Bitcoin", "price": 65027, "priceChange24h": 950, "priceChange24hPercent": 1.4825912573934485, "quoteTime": "2026-06-22T13:23:37.62Z", "symbol": "BTCB", "usd": 2658419407.0911927 } ], "ethereum": [ { "balance": 40046128192.73723, "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 0, "priceChange24hPercent": 0, "quoteTime": "2026-06-22T13:24:28.299Z", "symbol": "USDT", "usd": 40046128192.73723 }, { "balance": 7422685972.66057, "id": "usd-coin", "name": "USDC", "price": 1, "priceChange24h": 0, "priceChange24hPercent": 0, "quoteTime": "2026-06-22T13:24:30.156Z", "symbol": "USDC", "usd": 7422685972.66057 } ] }, "entities": { "binance": { "crunchbase": "https://www.crunchbase.com/organization/binance", "description": "", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "populatedTags": [ { "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } }, "totalBalance": { "bsc": 11662208524.033506, "ethereum": 66276809360.97472 }, "totalBalance24hAgo": { "bsc": 11595187303.045288, "ethereum": 65932976474.17882 } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/balances/solana/subaccounts/address/{addresses}": { "get": { "summary": "Get Solana subaccount balances for addresses", "description": "Returns token balances from Solana subaccounts (staking, lending, etc.) for the specified addresses.", "operationId": "GetSolanaAddressSubaccountBalances", "parameters": [ { "name": "pricingID", "in": "query", "description": "The CoinGecko pricing ID of the token to query subaccount balances for. Filters results to balances of this token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token to query subaccount balances for. Filters results to balances of this token.", "example": "jito-staked-sol" } }, { "name": "limit", "in": "query", "description": "Maximum number of subaccount balance entries to return. Default: 1000.", "schema": { "type": "string", "description": "Maximum number of subaccount balance entries to return. Default: 1000.", "example": "1000" } }, { "name": "addresses", "in": "path", "description": "Comma-separated list of Solana addresses to query subaccount balances for.", "required": true, "schema": { "type": "string", "description": "Comma-separated list of Solana addresses to query subaccount balances for.", "example": "GxDDTT1zqgH2aNgdoyDvEgvHdsLq91JAExCTao7c5GT4" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountBalances" }, "example": [ { "address": "BCjNfgiZYpfZG2aTDDFw5dL4zu7cwBRdv2v8FsnjK6Dy", "balance": 508628.141646117, "balanceExact": "508628141646117", "id": "jito-staked-sol", "name": "Jito Staked SOL", "ownerAddress": "GxDDTT1zqgH2aNgdoyDvEgvHdsLq91JAExCTao7c5GT4", "price": 87.73, "symbol": "JitoSOL", "usd": 44621946.86661385 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/balances/solana/subaccounts/entity/{entities}": { "get": { "summary": "Get Solana subaccount balances for entities", "description": "Returns token balances from Solana subaccounts (staking, lending, etc.) for the specified entities.", "operationId": "GetSolanaEntitySubaccountBalances", "parameters": [ { "name": "pricingID", "in": "query", "description": "The CoinGecko pricing ID of the token to query subaccount balances for. Filters results to balances of this token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token to query subaccount balances for. Filters results to balances of this token.", "example": "tensor" } }, { "name": "limit", "in": "query", "description": "Maximum number of subaccount balance entries to return. Default: 1000.", "schema": { "type": "string", "description": "Maximum number of subaccount balance entries to return. Default: 1000.", "example": "1000" } }, { "name": "entities", "in": "path", "description": "Comma-separated list of entity IDs to query subaccount balances for.", "required": true, "schema": { "type": "string", "description": "Comma-separated list of entity IDs to query subaccount balances for.", "example": "binance,coinbase" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountBalances" }, "example": [ { "address": "BCjNfgiZYpfZG2aTDDFw5dL4zu7cwBRdv2v8FsnjK6Dy", "balance": 508628.141646117, "balanceExact": "508628141646117", "id": "jito-staked-sol", "name": "Jito Staked SOL", "ownerAddress": "GxDDTT1zqgH2aNgdoyDvEgvHdsLq91JAExCTao7c5GT4", "price": 87.73, "symbol": "JitoSOL", "usd": 44621946.86661385 } ] }, "example": [ { "address": "GugV3a7dGm2n5SDmsoiWKgaPGjwkoMBuz1wQaDCAftKb", "balance": 73296943.94763146, "balanceExact": "73296943947631461", "id": "tensor", "name": "Tensor", "ownerAddress": "5tzFkiKscXHK5ZXCGbXZxdw7gTjjD1mBwuoFbhUvuAi9", "price": 0.04028654, "symbol": "TNSR", "usd": 2952880.2642240124 } ] } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/chains": { "get": { "summary": "Get supported chains list", "description": "Retrieves a list of supported blockchain chains.", "operationId": "GetSupportedChains", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" }, "example": [ "ethereum", "bitcoin", "tron", "polygon", "bsc" ] } } } }, "500": { "description": "Internal Server Error" } } } }, "/cluster/{id}/summary": { "get": { "summary": "Get cluster summary statistics", "description": "Returns summary statistics for the specified cluster, including:\n- Total number of unique addresses in the cluster\n- Total balance in USD\n- Total transaction volume in USD\n- First and last transaction timestamps\n\nClusters are groups of addresses that have been linked together through on-chain heuristics (e.g., Bitcoin input clustering).\n\nTo find a cluster ID, look up an address with GET /intelligence/address_enriched/{address} and read its clusterIds field.", "operationId": "GetClusterSummary", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the cluster to summarize.", "required": true, "schema": { "type": "string", "description": "The ID of the cluster to summarize.", "example": "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterSummary" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/counterparties/address/{address}": { "get": { "summary": "Get top counterparties for an address", "description": "Returns aggregated counterparty activity by volume for the specified address.\n\nSupports filtering by transfer direction, chain, token, time range, and minimum USD volume.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.", "operationId": "GetAddressCounterParty", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'base,bsc'). If omitted, returns counterparties across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "flow", "in": "query", "description": "Transfer direction. Only \"in\" or \"out\" are accepted (omit for both directions).", "schema": { "$ref": "#/components/schemas/CounterpartyFlow" } }, { "name": "tokens", "in": "query", "description": "Comma-separated list of token addresses or token IDs; matches counterparties involving any of them.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Comma-separated list of token addresses or token IDs; matches counterparties involving any of them.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "timeGte", "in": "query", "description": "Filter to activity after this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "schema": { "type": "string", "description": "Filter to activity after this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Filter to activity before this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "schema": { "type": "string", "description": "Filter to activity before this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "nullable": true, "example": "2024-06-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Filter to activity within this duration before now (e.g. 24h, 7d). Cannot be combined with timeGte/timeLte.", "schema": { "type": "string", "description": "Filter to activity within this duration before now (e.g. 24h, 7d). Cannot be combined with timeGte/timeLte.", "example": "24h" } }, { "name": "usdGte", "in": "query", "description": "Filter to counterparties whose aggregated USD volume is at least this value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter to counterparties whose aggregated USD volume is at least this value.", "nullable": true, "example": "100.23" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return. Default: 20. Max: 1000.", "schema": { "type": "integer", "description": "Maximum number of results to return. Default: 20. Max: 1000.", "example": 10 } }, { "name": "tags", "in": "query", "description": "List of counterparty tags to filter by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of counterparty tags to filter by.", "example": [ "whale", "kol" ] } }, { "name": "address", "in": "path", "description": "The address to query counterparties for. A comma-separated list is also accepted — their counterparties are aggregated (per-counterparty volume summed across the listed addresses).", "required": true, "schema": { "type": "string", "description": "The address to query counterparties for. A comma-separated list is also accepted — their counterparties are aggregated (per-counterparty volume summed across the listed addresses).", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Counterparty" }, "example": [ { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "chains": [ "ethereum" ], "flow": "in", "transactionCount": 223156, "usd": 331013556816.85 } ] }, "example": { "base": [ { "address": { "address": "0x31beec3942E4Faf3F253c86b51537387d16Ada34", "arkhamLabel": { "address": "0x31beec3942E4Faf3F253c86b51537387d16Ada34", "chainType": "evm", "name": "Binance Deposit" }, "chain": "base", "contract": false, "depositServiceID": "binance", "isUserAddress": false }, "chains": [ "base" ], "flow": "out", "transactionCount": 1, "usd": 5252.65185546875 }, { "address": { "address": "0x6dcBCe46a8B494c885D0e7b6817d2b519dF64467", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/coinbase", "id": "coinbase", "linkedin": "https://www.linkedin.com/company/coinbase", "name": "Coinbase", "note": "", "service": null, "twitter": "https://twitter.com/coinbase", "type": "cex", "website": "https://coinbase.com" }, "arkhamLabel": { "address": "0x6dcBCe46a8B494c885D0e7b6817d2b519dF64467", "chainType": "evm", "name": "Hot Wallet" }, "chain": "base", "contract": false, "isUserAddress": false }, "chains": [ "base" ], "flow": "in", "transactionCount": 1, "usd": 2028.17822265625 } ], "bsc": [ { "address": { "address": "0xF977814e90dA44bFA03b6295A0616a897441aceC", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0xF977814e90dA44bFA03b6295A0616a897441aceC", "chainType": "evm", "name": "Cold Wallet" }, "chain": "bsc", "contract": false, "isUserAddress": false }, "chains": [ "bsc" ], "flow": "all", "transactionCount": 78, "usd": 1014571199.420227 }, { "address": { "address": "0xD65448affe1475F101378A744a62C00F04CF50D6", "arkhamEntity": { "id": "kanga-exchange", "name": "Kanga Exchange", "note": "", "service": null, "twitter": "https://twitter.com/KangaExchange", "type": "cex", "website": "https://kanga.exchange/" }, "arkhamLabel": { "address": "0xD65448affe1475F101378A744a62C00F04CF50D6", "chainType": "evm", "name": "Hot Wallet" }, "chain": "bsc", "contract": false, "isUserAddress": false }, "chains": [ "bsc" ], "flow": "in", "transactionCount": 1, "usd": 3163.48583984375 } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/counterparties/entity/{entity}": { "get": { "summary": "Get top counterparties for an entity", "description": "Returns aggregated counterparty activity by volume for the specified entity.\n\nSupports filtering by transfer direction, chain, token, time range, and minimum USD volume.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.", "operationId": "GetEntityCounterParty", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'base,bsc'). If omitted, returns counterparties across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "flow", "in": "query", "description": "Transfer direction. Only \"in\" or \"out\" are accepted (omit for both directions).", "schema": { "$ref": "#/components/schemas/CounterpartyFlow" } }, { "name": "tokens", "in": "query", "description": "Comma-separated list of token addresses or token IDs; matches counterparties involving any of them.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Comma-separated list of token addresses or token IDs; matches counterparties involving any of them.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "timeGte", "in": "query", "description": "Filter to activity after this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "schema": { "type": "string", "description": "Filter to activity after this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Filter to activity before this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "schema": { "type": "string", "description": "Filter to activity before this time. Accepts RFC 3339, Unix seconds/ms, or YYYY-MM-DD.", "nullable": true, "example": "2024-06-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Filter to activity within this duration before now (e.g. 24h, 7d). Cannot be combined with timeGte/timeLte.", "schema": { "type": "string", "description": "Filter to activity within this duration before now (e.g. 24h, 7d). Cannot be combined with timeGte/timeLte.", "example": "24h" } }, { "name": "usdGte", "in": "query", "description": "Filter to counterparties whose aggregated USD volume is at least this value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter to counterparties whose aggregated USD volume is at least this value.", "nullable": true, "example": "100.23" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return. Default: 20. Max: 1000.", "schema": { "type": "integer", "description": "Maximum number of results to return. Default: 20. Max: 1000.", "example": 10 } }, { "name": "tags", "in": "query", "description": "List of counterparty tags to filter by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of counterparty tags to filter by.", "example": [ "whale", "kol" ] } }, { "name": "entity", "in": "path", "description": "The entity ID to query counterparties for.", "required": true, "schema": { "type": "string", "description": "The entity ID to query counterparties for.", "example": "vitalik-buterin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Counterparty" }, "example": [ { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "chains": [ "ethereum" ], "flow": "in", "transactionCount": 223156, "usd": 331013556816.85 } ] }, "example": { "base": [ { "address": { "address": "0x9008D19f58AAbD9eD0D60971565AA8510560ab41", "arkhamEntity": { "id": "cowswap", "name": "CoW Protocol", "note": "", "service": null, "twitter": "https://twitter.com/CoWSwap", "type": "dex-aggregator", "website": "https://cow.fi" }, "arkhamLabel": { "address": "0x9008D19f58AAbD9eD0D60971565AA8510560ab41", "chainType": "evm", "name": "GPv2Settlement" }, "chain": "base", "contract": true, "isUserAddress": false }, "chains": [ "base", "ethereum" ], "flow": "all", "transactionCount": 1224, "usd": 107909121.9766097 }, { "address": { "address": "0x33929958868F2a7C5bd8123243dDe6D23C5A6c58", "chain": "base", "contract": false, "isUserAddress": false }, "chains": [ "base" ], "flow": "in", "transactionCount": 1, "usd": 1280000000 } ], "bsc": [ { "address": { "address": "0xE081d4E19D18029Acb1250cDF29Bfd671040f5c7", "arkhamLabel": { "address": "0xE081d4E19D18029Acb1250cDF29Bfd671040f5c7", "chainType": "evm", "name": "\"kyawaung\" on Galxe" }, "chain": "bsc", "contract": false, "isUserAddress": false }, "chains": [ "bsc" ], "flow": "in", "transactionCount": 1, "usd": 1240000000 } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/flow/address/{address}": { "get": { "summary": "Get historical USD flows for an address", "description": "Returns historical USD inflows, outflows, and cumulative totals for the specified address across supported chains.", "operationId": "GetAddressFlow", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bsc'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query flow data for.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query flow data for.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSnapshot" }, "example": [ { "cumulativeInflow": 1.23, "cumulativeOutflow": 1.23, "inflow": 1.23, "outflow": 1.23, "time": "2024-01-01T00:00:00Z" } ] }, "example": { "bsc": [ { "cumulativeInflow": 91579540.89000003, "cumulativeOutflow": 92789860.85, "inflow": 99.71, "outflow": 0, "time": "2023-10-31T00:00:00Z" }, { "cumulativeInflow": 91579640.60000002, "cumulativeOutflow": 92789860.85, "inflow": 2493652.26, "outflow": 0, "time": "2023-12-08T00:00:00Z" } ], "ethereum": [ { "cumulativeInflow": 1027355003822.2888, "cumulativeOutflow": 1023262378331.2817, "inflow": 523882897.43, "outflow": 554928524.09, "time": "2023-12-03T00:00:00Z" }, { "cumulativeInflow": 1027878886719.7189, "cumulativeOutflow": 1023817306855.3717, "inflow": 1312623236.01, "outflow": 1204741283.07, "time": "2023-12-04T00:00:00Z" } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/flow/entity/{entity}": { "get": { "summary": "Get historical USD flows for an entity", "description": "Returns historical USD inflows, outflows, and cumulative totals for the specified entity across supported chains.", "operationId": "GetEntityFlow", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bitcoin'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "entity", "in": "path", "description": "The entity ID to query flow data for.", "required": true, "schema": { "type": "string", "description": "The entity ID to query flow data for.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSnapshot" }, "example": [ { "cumulativeInflow": 1.23, "cumulativeOutflow": 1.23, "inflow": 1.23, "outflow": 1.23, "time": "2024-01-01T00:00:00Z" } ] }, "example": { "bitcoin": [ { "cumulativeInflow": 905891016225.6693, "cumulativeOutflow": 889779478783.3397, "inflow": 6565472523.45, "outflow": 6632247150.18, "time": "2022-01-21T00:00:00Z" }, { "cumulativeInflow": 912456488749.1193, "cumulativeOutflow": 896411725933.5198, "inflow": 528887137.66, "outflow": 660515462.75, "time": "2022-01-22T00:00:00Z" } ], "ethereum": [ { "cumulativeInflow": 1425833420702.8699, "cumulativeOutflow": 1396841791568.5383, "inflow": 1588990961.6, "outflow": 1499520350.86, "time": "2022-01-08T00:00:00Z" }, { "cumulativeInflow": 1427422411664.47, "cumulativeOutflow": 1398341311919.3984, "inflow": 1370833866.45, "outflow": 1438004592.65, "time": "2022-01-09T00:00:00Z" } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/history/address/{address}": { "get": { "summary": "Get historical data for an address", "description": "Returns a daily USD value time series for the specified address.", "operationId": "GetAddressHistory", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bsc'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query historical data for.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query historical data for.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/HistorySnapshot" }, "example": [ { "time": "2024-01-01T00:00:00Z", "usd": 1.23 } ] }, "example": { "bsc": [ { "time": "2023-12-13T00:00:00Z", "usd": 2844820.37 }, { "time": "2023-12-14T00:00:00Z", "usd": 3174696.58 } ], "ethereum": [ { "time": "2023-11-29T00:00:00Z", "usd": 2524608983.37 }, { "time": "2023-11-30T00:00:00Z", "usd": 2535428111.78 } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/history/entity/{entity}": { "get": { "summary": "Get historical data for an entity", "description": "Returns a daily USD value time series for the specified entity.", "operationId": "GetEntityHistory", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bitcoin'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "entity", "in": "path", "description": "The entity ID to query historical data for.", "required": true, "schema": { "type": "string", "description": "The entity ID to query historical data for.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/HistorySnapshot" }, "example": [ { "time": "2024-01-01T00:00:00Z", "usd": 1.23 } ] }, "example": { "bitcoin": [ { "time": "2022-01-22T00:00:00Z", "usd": 19480915256.37 }, { "time": "2022-01-23T00:00:00Z", "usd": 18645267553.47 } ], "ethereum": [ { "time": "2021-12-31T00:00:00Z", "usd": 51606841219.03 }, { "time": "2022-01-01T00:00:00Z", "usd": 51120113947.47 } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/account/{address}/active": { "get": { "summary": "Check for HyperCore activity", "description": "Whether a HyperCore address has any HyperCore activity: a spot balance, open perp position, margin, staking, or vault equity.", "operationId": "GetHypercoreAccountActive", "parameters": [ { "name": "address", "in": "path", "description": "HyperCore master or sub-account address.", "required": true, "schema": { "type": "string", "description": "HyperCore master or sub-account address.", "example": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreAccountActiveResponse" }, "example": { "active": true, "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/account/{address}/perp-positions": { "get": { "summary": "Get HyperCore perp positions", "description": "Open perpetual positions for a HyperCore address (master + sub-accounts) with mark price, unrealized PnL, and per-DEX USDC margin.", "operationId": "GetHypercorePerpPositions", "parameters": [ { "name": "address", "in": "path", "description": "HyperCore master or sub-account address.", "required": true, "schema": { "type": "string", "description": "HyperCore master or sub-account address.", "example": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercorePerpPositionsResponse" }, "example": { "accountUsdValue": 62831603.012425, "addresses": [ "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "0x08b095625fb698837fc436c489ce9e4f6ee084c1", "0x152600cac5306fd519ccb2bdd4b18a441443428a", "0x153ae96fafe232f61b9a19c285b8e8e265642f69", "0x37449263a96d00ec4cd68952a3f3c7fd1927d958", "0x4304dc380a4c9a452c58707487e185caf992ff05", "0x6d9f9706d647d19e93164a7217576797358fa8c3", "0x8185204d31602595fadbb9305155e8981762e60c", "0x82578861165b62466f8e11e51efe74455ed0e1a6", "0x88f9bd20b748c3e533374fa201621ceb119ee9db", "0x8af63f51e0c60851a30da696a6a0911a3d019d5e", "0x8fecb60f12fd9a3db6901b8a7703a24fa2ee1268", "0x90e678b96a3d15bac0e109535692be5361571652", "0x91ea0caf217cb0e51d833d9b66464371fb9d1c5b", "0xa3e4be245fa0cbd5df1718c33cb9c08af5796f3b", "0xb3514b307d17e09d2086738b62ac5db371692d9d", "0xba6be69a57e42572df416997af3b7dcdd59ef360", "0xc21f25650fd7165905e94014529261070c4530a3", "0xc64283a986819174aa0b13b22ff9ab55ac2bd394", "0xe78030f0e93def6280f7331edb81db4a3f547633", "0xefee01d3a0d06c188627d98b6aa814f401f87c4b", "0xfa452867a690af8bc0a3aa585facaf8e70e65ef8", "0xff1ec702af93ac3e9537d9e24c2c4750d44cbf75" ], "dexBalances": [ { "dex": "xyz", "usdcBalance": 10084680.877152 }, { "dex": "vntl", "usdcBalance": 0 }, { "dex": "cash", "usdcBalance": 0.004359 } ], "positions": [ { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "xyz:XYZ100", "direction": "long", "entryPx": 28568.39, "leverageType": "cross", "leverageValue": 3, "markPx": 28523.999999999996, "maxLeverage": 30, "positionValue": 79536.3216, "szi": 2.7884, "unrealizedPnl": -123.78444 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "xyz:TSLA", "direction": "long", "entryPx": 392.186, "leverageType": "cross", "leverageValue": 3, "markPx": 380.03000000000003, "maxLeverage": 20, "positionValue": 608103.86441, "szi": 1600.147, "underlyingPricingId": "tesla-xstock", "underlyingSymbol": "TSLAX", "unrealizedPnl": -19451.467595 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "xyz:NVDA", "direction": "long", "entryPx": 206.302, "leverageType": "cross", "leverageValue": 3, "markPx": 203.20000000000002, "maxLeverage": 20, "positionValue": 847307.424, "szi": 4169.82, "underlyingPricingId": "nvidia-xstock", "underlyingSymbol": "NVDAX", "unrealizedPnl": -12935.268385 } ], "unrealizedPnl": 1015323.5175330002, "usdcBalance": 179763906.134545 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/account/{address}/portfolio-history": { "get": { "summary": "Get HyperCore account value / PnL history", "description": "Live account-value and PnL time series per timeframe (day, week, month, allTime) for a HyperCore address. Not aggregated across sub-accounts.", "operationId": "GetHypercorePortfolioHistory", "parameters": [ { "name": "address", "in": "path", "description": "HyperCore master or sub-account address.", "required": true, "schema": { "type": "string", "description": "HyperCore master or sub-account address.", "example": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercorePortfolioHistoryResponse" }, "example": { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "periods": [ { "accountValue": [ { "time": 1784246344057, "value": 95092178.097197 }, { "time": 1784298591213, "value": 98859536.656199 } ], "period": "day", "pnl": [ { "time": 1784224644641, "value": 849540.7263119817 }, { "time": 1784298591213, "value": 1945082.7996740043 } ] }, { "accountValue": [ { "time": 1783727877035, "value": 91759827.573454 }, { "time": 1783814323032, "value": 96805222.506593 }, { "time": 1783896617062, "value": 101532293.403535 } ], "period": "week", "pnl": [ { "time": 1784073197689, "value": -2659247.7237069905 }, { "time": 1784138060004, "value": -3659770.578257978 }, { "time": 1784224644641, "value": -2810229.8519459963 } ] } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/account/{address}/spot-balances": { "get": { "summary": "Get HyperCore spot balances", "description": "Spot token balances for a HyperCore address (master + sub-accounts), each valued in USD at the spot mid price.", "operationId": "GetHypercoreSpotBalances", "parameters": [ { "name": "address", "in": "path", "description": "HyperCore master or sub-account address.", "required": true, "schema": { "type": "string", "description": "HyperCore master or sub-account address.", "example": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreSpotBalancesResponse" }, "example": { "addresses": [ "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "0x08b095625fb698837fc436c489ce9e4f6ee084c1", "0x152600cac5306fd519ccb2bdd4b18a441443428a", "0x153ae96fafe232f61b9a19c285b8e8e265642f69", "0x37449263a96d00ec4cd68952a3f3c7fd1927d958", "0x4304dc380a4c9a452c58707487e185caf992ff05", "0x6d9f9706d647d19e93164a7217576797358fa8c3", "0x8185204d31602595fadbb9305155e8981762e60c", "0x82578861165b62466f8e11e51efe74455ed0e1a6", "0x88f9bd20b748c3e533374fa201621ceb119ee9db", "0x8af63f51e0c60851a30da696a6a0911a3d019d5e", "0x8fecb60f12fd9a3db6901b8a7703a24fa2ee1268", "0x90e678b96a3d15bac0e109535692be5361571652", "0x91ea0caf217cb0e51d833d9b66464371fb9d1c5b", "0xa3e4be245fa0cbd5df1718c33cb9c08af5796f3b", "0xb3514b307d17e09d2086738b62ac5db371692d9d", "0xba6be69a57e42572df416997af3b7dcdd59ef360", "0xc21f25650fd7165905e94014529261070c4530a3", "0xc64283a986819174aa0b13b22ff9ab55ac2bd394", "0xe78030f0e93def6280f7331edb81db4a3f547633", "0xefee01d3a0d06c188627d98b6aa814f401f87c4b", "0xfa452867a690af8bc0a3aa585facaf8e70e65ef8", "0xff1ec702af93ac3e9537d9e24c2c4750d44cbf75" ], "balances": [ { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "USDC", "hold": 5417652.57475905, "token": 0, "total": 10874813.93987035, "underlyingPricingId": "usd-coin", "usdPrice": 1, "usdValue": 5457161.3651113 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "PURR", "entryPx": 0.08784222575940936, "hold": 0, "token": 1, "total": 129.21127, "underlyingPricingId": "purr-2", "underlyingSymbol": "PURR", "unrealizedPnl": -2.1359560693949984, "usdPrice": 0.0713115, "usdValue": 9.214249480605002 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "HFUN", "hold": 0, "token": 2, "total": 0.73279813, "underlyingPricingId": "hypurr-fun", "underlyingSymbol": "HFUN", "usdPrice": 13.4645, "usdValue": 9.866760421385 } ], "totalUsdValue": 16717217.12361454 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/account/{address}/subaccounts": { "get": { "summary": "Get HyperCore sub-accounts", "description": "Sub-accounts (name, address, vault flag) indexed for a HyperCore master address.", "operationId": "GetHypercoreSubAccounts", "parameters": [ { "name": "address", "in": "path", "description": "HyperCore master or sub-account address.", "required": true, "schema": { "type": "string", "description": "HyperCore master or sub-account address.", "example": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreSubAccountsResponse" }, "example": { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "subAccounts": [ { "address": "0x8185204d31602595fadbb9305155e8981762e60c", "isVault": false, "master": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "name": "sub1" }, { "address": "0x37449263a96d00ec4cd68952a3f3c7fd1927d958", "isVault": false, "master": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "name": "sub10" }, { "address": "0x152600cac5306fd519ccb2bdd4b18a441443428a", "isVault": false, "master": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "name": "sub11" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/account/{address}/summary": { "get": { "summary": "Get HyperCore account value summary", "description": "Total account value (spot USD + perp equity + staked HYPE) for a HyperCore address. A master address aggregates across all of its sub-accounts; a sub-account returns only its own value.", "operationId": "GetHypercoreAccountSummary", "parameters": [ { "name": "address", "in": "path", "description": "HyperCore master or sub-account address.", "required": true, "schema": { "type": "string", "description": "HyperCore master or sub-account address.", "example": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreAccountSummaryResponse" }, "example": { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "addresses": [ "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "0x08b095625fb698837fc436c489ce9e4f6ee084c1", "0x152600cac5306fd519ccb2bdd4b18a441443428a", "0x153ae96fafe232f61b9a19c285b8e8e265642f69", "0x37449263a96d00ec4cd68952a3f3c7fd1927d958", "0x4304dc380a4c9a452c58707487e185caf992ff05", "0x6d9f9706d647d19e93164a7217576797358fa8c3", "0x8185204d31602595fadbb9305155e8981762e60c", "0x82578861165b62466f8e11e51efe74455ed0e1a6", "0x88f9bd20b748c3e533374fa201621ceb119ee9db", "0x8af63f51e0c60851a30da696a6a0911a3d019d5e", "0x8fecb60f12fd9a3db6901b8a7703a24fa2ee1268", "0x90e678b96a3d15bac0e109535692be5361571652", "0x91ea0caf217cb0e51d833d9b66464371fb9d1c5b", "0xa3e4be245fa0cbd5df1718c33cb9c08af5796f3b", "0xb3514b307d17e09d2086738b62ac5db371692d9d", "0xba6be69a57e42572df416997af3b7dcdd59ef360", "0xc21f25650fd7165905e94014529261070c4530a3", "0xc64283a986819174aa0b13b22ff9ab55ac2bd394", "0xe78030f0e93def6280f7331edb81db4a3f547633", "0xefee01d3a0d06c188627d98b6aa814f401f87c4b", "0xfa452867a690af8bc0a3aa585facaf8e70e65ef8", "0xff1ec702af93ac3e9537d9e24c2c4750d44cbf75" ], "perpPositionCount": 123, "perpUnrealizedPnl": 1015323.5175330002, "perpUsdValue": 62831603.012425, "perpUsdcBalance": 179763906.134545, "pricingAvailable": true, "spotBalanceCount": 34, "spotUsdValue": 16717217.12361454, "stakedUsdValue": 15428141.678624816, "subAccountCount": 22, "totalUsdValue": 94976961.81466436 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/account/{address}/trades": { "get": { "summary": "Get HyperCore trade history", "description": "Merged spot and perp fills for a HyperCore address (master + sub-accounts), newest first, paginated via limit/offset.", "operationId": "GetHypercoreTrades", "parameters": [ { "name": "limit", "in": "query", "description": "Max fills to return (default 50, max 200).", "schema": { "type": "integer", "description": "Max fills to return (default 50, max 200).", "example": 50 } }, { "name": "offset", "in": "query", "description": "Pagination offset into the merged fill history. Default: 0.", "schema": { "type": "integer", "description": "Pagination offset into the merged fill history. Default: 0.", "example": 0 } }, { "name": "address", "in": "path", "description": "HyperCore master or sub-account address.", "required": true, "schema": { "type": "string", "description": "HyperCore master or sub-account address.", "example": "0x020ca66c30bec2c4fe3861a94e4db4a498a35872" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreTradesResponse" }, "example": { "addresses": [ "0x020ca66c30bec2c4fe3861a94e4db4a498a35872" ], "hasMore": true, "limit": 50, "offset": 0, "trades": [ { "address": "0x020ca66c30bec2c4fe3861a94e4db4a498a35872", "closedPnl": 0, "coin": "ETH", "direction": "Open Long", "fee": 9.970859, "feeToken": "USDC", "hash": "0x0a62f1391c59819b0bdc044022f1670203a2001eb75ca06dae2b9c8bdb5d5b85", "kind": "perp", "price": 1832.7, "side": "B", "size": 18.1351, "time": "2026-07-17T14:10:59.009Z" }, { "address": "0x020ca66c30bec2c4fe3861a94e4db4a498a35872", "closedPnl": 0, "coin": "ETH", "direction": "Open Long", "fee": 3.77439, "feeToken": "USDC", "hash": "0x0a62f1391c59819b0bdc044022f1670203a2001eb75ca06dae2b9c8bdb5d5b85", "kind": "perp", "price": 1832.7, "side": "B", "size": 6.8649, "time": "2026-07-17T14:10:59.009Z" }, { "address": "0x020ca66c30bec2c4fe3861a94e4db4a498a35872", "closedPnl": 0, "coin": "ETH", "direction": "Open Long", "fee": 13.753499, "feeToken": "USDC", "hash": "0x282c56304428027829a6044022f1010206a50015df2b214acbf50183032bdc62", "kind": "perp", "price": 1833.8, "side": "B", "size": 25, "time": "2026-07-17T14:10:51.906Z" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/entity/{entity}/active": { "get": { "summary": "Check for HyperCore entity activity", "description": "Whether any address attributed to the entity has HyperCore activity: a spot balance, open perp position, margin, staking, or vault equity.", "operationId": "GetHypercoreEntityActive", "parameters": [ { "name": "entity", "in": "path", "description": "Arkham entity ID.", "required": true, "schema": { "type": "string", "description": "Arkham entity ID.", "example": "wintermute" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreEntityActiveResponse" }, "example": { "active": true, "entity": "wintermute" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/entity/{entity}/perp-positions": { "get": { "summary": "Get HyperCore entity perp positions", "description": "Open perpetual positions across every address attributed to the entity, with mark price, unrealized PnL, and per-DEX USDC margin.", "operationId": "GetHypercoreEntityPerpPositions", "parameters": [ { "name": "entity", "in": "path", "description": "Arkham entity ID.", "required": true, "schema": { "type": "string", "description": "Arkham entity ID.", "example": "wintermute" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercorePerpPositionsResponse" }, "example": { "accountUsdValue": 60422375.07808398, "addresses": [ "0x0000006daea1723962647b7e189d311d757fb793", "0x0000f079e68bbcc79ab9600ace786b0a4db1c83c", "0x03ae1a796dfe0400439211133d065bda774b9d3e" ], "dexBalances": [ { "dex": "xyz", "usdcBalance": 9719026.928198999 }, { "dex": "", "usdcBalance": 161683016.732425 }, { "dex": "cash", "usdcBalance": 0.004359 } ], "positions": [ { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "PUMP", "direction": "short", "entryPx": 0.0015532833786410095, "leverageType": "cross", "leverageValue": 3, "markPx": 0.001625, "maxLeverage": 10, "positionValue": 4264428.89925, "szi": -2624263938, "underlyingPricingId": "pump-fun", "underlyingSymbol": "PUMP", "unrealizedPnl": -188203.34318759906 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "kPEPE", "direction": "short", "entryPx": 0.0026949657593151586, "leverageType": "cross", "leverageValue": 10, "markPx": 0.002675, "maxLeverage": 10, "positionValue": 1309223.594175, "szi": -489429381, "underlyingPricingId": "pepe", "underlyingSymbol": "PEPE", "unrealizedPnl": 9771.829222813132 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "kBONK", "direction": "short", "entryPx": 0.003497, "leverageType": "cross", "leverageValue": 10, "markPx": 0.003168, "maxLeverage": 10, "positionValue": 171282.754368, "szi": -54066526, "underlyingPricingId": "bonk", "underlyingSymbol": "BONK", "unrealizedPnl": 17787.887054000017 } ], "unrealizedPnl": 1653719.941092011, "usdcBalance": 171402043.664983 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/entity/{entity}/portfolio-history": { "get": { "summary": "Get HyperCore entity account value / PnL history", "description": "Combined account-value and PnL time series per timeframe (day, week, month, allTime) across an entity's HyperCore addresses, at daily resolution.", "operationId": "GetHypercoreEntityPortfolioHistory", "parameters": [ { "name": "entity", "in": "path", "description": "Arkham entity ID.", "required": true, "schema": { "type": "string", "description": "Arkham entity ID.", "example": "wintermute" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreEntityPortfolioHistoryResponse" }, "example": { "entity": "wintermute", "periods": [ { "accountValue": [ { "time": 1784246344057, "value": 95158621.32031299 }, { "time": 1784294531578, "value": 98562252.84599899 } ], "period": "day", "pnl": [ { "time": 1784224706077, "value": 846167.4401189685 }, { "time": 1784294531578, "value": 2471029.4675139785 } ] }, { "accountValue": [ { "time": 1783727996396, "value": 91760066.196543 }, { "time": 1783814323032, "value": 96805461.583287 }, { "time": 1783900560020, "value": 101532531.30774198 } ], "period": "week", "pnl": [ { "time": 1783726080034, "value": -2659042.1070310175 }, { "time": 1783810080061, "value": -2659041.3849770427 }, { "time": 1783897680023, "value": -2659040.7379760146 } ] } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/entity/{entity}/spot-balances": { "get": { "summary": "Get HyperCore entity spot balances", "description": "Spot token balances across every address attributed to the entity, each valued in USD at the spot mid price.", "operationId": "GetHypercoreEntitySpotBalances", "parameters": [ { "name": "entity", "in": "path", "description": "Arkham entity ID.", "required": true, "schema": { "type": "string", "description": "Arkham entity ID.", "example": "wintermute" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreSpotBalancesResponse" }, "example": { "addresses": [ "0x0000006daea1723962647b7e189d311d757fb793", "0x0000f079e68bbcc79ab9600ace786b0a4db1c83c", "0x03ae1a796dfe0400439211133d065bda774b9d3e" ], "balances": [ { "address": "0x9f2a049145af1ee33ee1de8adc0e62041761cc5d", "coin": "MAX", "hold": 0, "token": 734, "total": 9995.425307, "usdPrice": 4e-7, "usdValue": 0.0039981701228 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "USDC", "hold": 6289812.51771749, "token": 0, "total": 9991392.00856484, "underlyingPricingId": "usd-coin", "usdPrice": 1, "usdValue": 3701579.490847349 }, { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "coin": "UBTC", "entryPx": 64115.25251628088, "hold": 36.39076, "token": 197, "total": 97.9853715109, "underlyingPricingId": "unit-bitcoin", "underlyingSymbol": "UBTC", "unrealizedPnl": -141515.61936333403, "usdPrice": 62671, "usdValue": 6140841.217959614 } ], "totalUsdValue": 16750028.265744798 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/entity/{entity}/summary": { "get": { "summary": "Get HyperCore entity value summary", "description": "Total HyperCore value (spot USD + perp equity + staked HYPE) aggregated across every address attributed to the entity, sub-accounts included.", "operationId": "GetHypercoreEntitySummary", "parameters": [ { "name": "entity", "in": "path", "description": "Arkham entity ID.", "required": true, "schema": { "type": "string", "description": "Arkham entity ID.", "example": "wintermute" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreEntitySummaryResponse" }, "example": { "addressCount": 71, "entity": "wintermute", "perpPositionCount": 123, "perpUnrealizedPnl": 1653719.941092011, "perpUsdValue": 60422375.07808398, "perpUsdcBalance": 171402043.664983, "pricingAvailable": true, "spotBalanceCount": 45, "spotUsdValue": 16750028.265744798, "stakedUsdValue": 15341482.640184918, "subAccountCount": 22, "totalUsdValue": 92513885.98401369 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/markets": { "get": { "summary": "List HyperCore markets", "description": "Every token that has a HyperCore spot or perpetual market. Returns each token's pricing id, symbol, and name.", "operationId": "GetHypercoreMarkets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreMarketsResponse" }, "example": { "markets": [ { "name": "Bitcoin", "pricingId": "bitcoin", "symbol": "BTC" }, { "name": "Ethereum", "pricingId": "ethereum", "symbol": "ETH" }, { "name": "Hyperliquid", "pricingId": "hyperliquid", "symbol": "HYPE" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/token/{pricingId}/positions": { "get": { "summary": "Get top HyperCore perp positions for a token", "description": "Returns the largest open HyperCore perp positions on the token's canonical market, optionally netted per entity.", "operationId": "GetHypercoreTokenPositions", "parameters": [ { "name": "side", "in": "query", "description": "Filter to 'long' or 'short' positions; omit for both.", "schema": { "type": "string", "description": "Filter to 'long' or 'short' positions; omit for both.", "example": "long" } }, { "name": "groupByEntity", "in": "query", "description": "If 'true', nets positions per attributed entity.", "schema": { "type": "string", "description": "If 'true', nets positions per attributed entity.", "example": "true" } }, { "name": "sort", "in": "query", "description": "Sort column: size, value, pnl, funding (default size).", "schema": { "type": "string", "description": "Sort column: size, value, pnl, funding (default size).", "example": "size" } }, { "name": "ascending", "in": "query", "description": "If 'true', sorts ascending.", "schema": { "type": "string", "description": "If 'true', sorts ascending.", "example": "true" } }, { "name": "limit", "in": "query", "description": "Rows per page (default 50, max 100).", "schema": { "type": "integer", "description": "Rows per page (default 50, max 100).", "example": 50 } }, { "name": "offset", "in": "query", "description": "Pagination offset (offset+limit capped at 1000). Default: 0.", "schema": { "type": "integer", "description": "Pagination offset (offset+limit capped at 1000). Default: 0.", "example": 0 } }, { "name": "pricingId", "in": "path", "description": "CoinGecko pricing id of the token.", "required": true, "schema": { "type": "string", "description": "CoinGecko pricing id of the token.", "example": "bitcoin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreTokenPositionsResponse" }, "example": { "hasPerp": true, "positions": [ { "address": { "address": "0x92ea19eceb7a8de0f50978a1583a5d8b018050e9", "arkhamLabel": { "address": "0x92ea19ECeB7a8dE0f50978A1583A5D8b018050e9", "chainType": "evm", "name": "\"GarretBullish\" on Markets.xyz" }, "chain": "hyperevm", "contract": false, "service": false }, "addressCount": 1, "coin": "BTC", "cumFundingSinceOpen": 862173.863344, "direction": "long", "entryPx": 76117.3, "leverageType": "cross", "leverageValue": 5, "markPx": 62700, "maxLeverage": 40, "positionValue": 79524596.34899999, "szi": 1268.33487, "unrealizedPnl": -17017629.451251004 }, { "address": { "address": "0x66f889094739dbb7d20aa60f645acd88feba75a9", "arkhamLabel": { "address": "0x66f889094739dbb7d20AA60F645AcD88FEbA75a9", "chainType": "evm", "name": "\"DoshiAtoll\" on Markets.xyz" }, "chain": "hyperevm", "contract": false, "service": false }, "addressCount": 1, "coin": "BTC", "cumFundingSinceOpen": 8757.225544, "direction": "long", "entryPx": 63451.3, "leverageType": "cross", "leverageValue": 30, "markPx": 62700, "maxLeverage": 40, "positionValue": 62702811.468, "szi": 1000.04484, "unrealizedPnl": -751333.6882920029 }, { "address": { "address": "0x15a4f009bb324a3fb9e36137136b201e3fe0dfdb", "arkhamLabel": { "address": "0x15a4F009BB324A3fb9E36137136B201E3Fe0DFDb", "chainType": "evm", "name": "\"baxter-island-papaverpoppy2999\" on Markets.xyz" }, "chain": "hyperevm", "contract": false, "service": false }, "addressCount": 1, "coin": "BTC", "cumFundingSinceOpen": 210709.639252, "direction": "long", "entryPx": 62353.6, "leverageType": "cross", "leverageValue": 40, "markPx": 62700, "maxLeverage": 40, "positionValue": 62700000, "szi": 1000, "unrealizedPnl": 346400.00000000146 } ], "total": 29706 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/hypercore/trades": { "get": { "summary": "Search HyperCore trades", "description": "Filtered, sorted feed of HyperCore perp and spot fills merged under one limit, each enriched with the trader's entity and labels.", "operationId": "GetHypercoreTradesFeed", "parameters": [ { "name": "base", "in": "query", "description": "Filter by trader: a comma-separated list of addresses and/or entity ids.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by trader: a comma-separated list of addresses and/or entity ids.", "example": [ "wintermute" ] } }, { "name": "coins", "in": "query", "description": "Filter to these raw coin identifiers.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter to these raw coin identifiers.", "example": [ "BTC" ] } }, { "name": "pricingIds", "in": "query", "description": "Filter by token: CoinGecko pricing ids, expanded to every coin that resolves to them.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by token: CoinGecko pricing ids, expanded to every coin that resolves to them.", "example": [ "bitcoin" ] } }, { "name": "side", "in": "query", "description": "Filter by side: 'buy' or 'sell'.", "schema": { "type": "string", "description": "Filter by side: 'buy' or 'sell'.", "example": "buy" } }, { "name": "directions", "in": "query", "description": "Filter perp fills by direction label, for example 'Open Long'.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter perp fills by direction label, for example 'Open Long'.", "example": [ "Open Long" ] } }, { "name": "product", "in": "query", "description": "Limit to 'perp' or 'spot'; empty returns both.", "schema": { "type": "string", "description": "Limit to 'perp' or 'spot'; empty returns both.", "example": "perp" } }, { "name": "crossed", "in": "query", "description": "Filter by whether the fill crossed the book: true for taker fills, false for maker fills.", "schema": { "type": "boolean", "description": "Filter by whether the fill crossed the book: true for taker fills, false for maker fills.", "nullable": true, "example": true } }, { "name": "tags", "in": "query", "description": "Filter by trader address tags.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by trader address tags.", "example": [ "whale" ] } }, { "name": "valueGte", "in": "query", "description": "Minimum notional value (price*size).", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Minimum notional value (price*size).", "nullable": true, "example": "1000" } }, { "name": "valueLte", "in": "query", "description": "Maximum notional value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Maximum notional value.", "nullable": true, "example": "1000000" } }, { "name": "sizeGte", "in": "query", "description": "Minimum fill size.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Minimum fill size.", "nullable": true, "example": "0.001" } }, { "name": "sizeLte", "in": "query", "description": "Maximum fill size.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Maximum fill size.", "nullable": true, "example": "1000" } }, { "name": "priceGte", "in": "query", "description": "Minimum fill price.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Minimum fill price.", "nullable": true, "example": "1" } }, { "name": "priceLte", "in": "query", "description": "Maximum fill price.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Maximum fill price.", "nullable": true, "example": "1000000" } }, { "name": "timeGte", "in": "query", "description": "Only fills at or after this time.", "schema": { "type": "string", "description": "Only fills at or after this time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Only fills at or before this time.", "schema": { "type": "string", "description": "Only fills at or before this time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Relative window ending now, e.g. '24h'. Units are case-sensitive: s (seconds), m (minutes), h (hours), d (days), w (weeks), M (months, 30 days), y (years) — so 1m is one minute and 1M is one month. Mutually exclusive with timeGte/timeLte.", "schema": { "type": "string", "description": "Relative window ending now, e.g. '24h'. Units are case-sensitive: s (seconds), m (minutes), h (hours), d (days), w (weeks), M (months, 30 days), y (years) — so 1m is one minute and 1M is one month. Mutually exclusive with timeGte/timeLte.", "example": "24h" } }, { "name": "sortKey", "in": "query", "description": "Sort by 'time', 'value', 'size', or 'price' (default 'time').", "schema": { "type": "string", "description": "Sort by 'time', 'value', 'size', or 'price' (default 'time').", "example": "time" } }, { "name": "sortDir", "in": "query", "description": "'asc' or 'desc' (default 'desc').", "schema": { "type": "string", "description": "'asc' or 'desc' (default 'desc').", "example": "desc" } }, { "name": "limit", "in": "query", "description": "Max trades to return (default 50, max 200).", "schema": { "type": "integer", "description": "Max trades to return (default 50, max 200).", "example": 50 } }, { "name": "offset", "in": "query", "description": "Pagination offset (offset+limit must be \u003c= 10000). Default: 0.", "schema": { "type": "integer", "description": "Pagination offset (offset+limit must be \u003c= 10000). Default: 0.", "example": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypercoreTradesFeedResponse" }, "example": { "count": 10000, "hasMore": true, "limit": 50, "offset": 0, "trades": [ { "blockNumber": 1079589907, "closedPnl": 0, "coin": "XPL", "crossed": true, "direction": "Open Short", "eventIndex": 1, "hash": "0x79a1ce670f9579457b1b0440593c1302029a004caa9898171d6a79b9ce995330", "kind": "perp", "price": 0.082864, "side": "sell", "size": 1600, "startPosition": -20374051, "time": "2026-07-20T12:39:52.215921792Z", "trader": { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/wintermute-trading", "id": "wintermute", "linkedin": "https://www.linkedin.com/company/wintermute-trading", "name": "Wintermute", "note": "", "service": null, "twitter": "https://twitter.com/wintermute_t", "type": "fund", "website": "https://www.wintermute.com/" }, "arkhamLabel": { "address": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00", "chainType": "evm", "name": "\"Wintermute\" on Markets.xyz" }, "chain": "hyperevm", "contract": false, "service": false }, "underlyingPricingId": "plasma", "underlyingSymbol": "XPL", "userAddress": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "value": 132.58239999999998 }, { "blockNumber": 1079589895, "closedPnl": -1.440164, "coin": "xyz:MSTR", "crossed": true, "direction": "Close Short", "eventIndex": 2, "hash": "0x7dcbeface8b60af67f450440593c07020138009283b929c821949affa7b9e4e1", "kind": "perp", "price": 96.06, "side": "buy", "size": 1.562, "startPosition": -3783.087, "time": "2026-07-20T12:39:51.408383922Z", "trader": { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/wintermute-trading", "id": "wintermute", "linkedin": "https://www.linkedin.com/company/wintermute-trading", "name": "Wintermute", "note": "", "service": null, "twitter": "https://twitter.com/wintermute_t", "type": "fund", "website": "https://www.wintermute.com/" }, "arkhamLabel": { "address": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00", "chainType": "evm", "name": "\"Wintermute\" on Markets.xyz" }, "chain": "hyperevm", "contract": false, "service": false }, "underlyingPricingId": "microstrategy-xstock", "underlyingSymbol": "MSTRX", "userAddress": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "value": 150.04572000000002 }, { "blockNumber": 1079589836, "coin": "@107", "crossed": false, "eventIndex": 5, "hash": "0x76a5f729344f55aa781f0440593bcc0201c0000ecf42747c1a6ea27bf3432f95", "kind": "spot", "price": 61.115, "side": "sell", "size": 32.73, "time": "2026-07-20T12:39:47.45744244Z", "trader": { "address": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/wintermute-trading", "id": "wintermute", "linkedin": "https://www.linkedin.com/company/wintermute-trading", "name": "Wintermute", "note": "", "service": null, "twitter": "https://twitter.com/wintermute_t", "type": "fund", "website": "https://www.wintermute.com/" }, "arkhamLabel": { "address": "0xECB63caA47c7c4E77F60f1cE858Cf28dC2B82b00", "chainType": "evm", "name": "\"Wintermute\" on Markets.xyz" }, "chain": "hyperevm", "contract": false, "service": false }, "underlyingPricingId": "hyperliquid", "underlyingSymbol": "HYPE", "userAddress": "0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00", "value": 2000.2939499999998 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address/batch": { "post": { "summary": "Batch lookup address intelligence", "description": "Returns intelligence for up to 1000 addresses in a single request. Send a POST body with an `addresses` array of blockchain addresses. Optionally filter results with the `chain` query parameter (a single network) or `chains` (multiple networks). If neither is provided, the best chain is auto-detected per address.", "operationId": "GetBatchAddressIntelligence", "parameters": [ { "name": "chains", "in": "query", "description": "List of chains to filter by. If omitted, auto-detects the best chain.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "chain", "in": "query", "description": "Single blockchain network to filter all addresses to. If omitted, auto-detects per address.", "schema": { "$ref": "#/components/schemas/Chain" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddressRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddressResponse" }, "example": { "addresses": { "0x28C6c06298d514Db089934071355E5743bf21d60": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address/batch/all": { "post": { "summary": "Batch lookup address intelligence across all chains", "description": "Returns intelligence for up to 1000 addresses across all supported chains. Send a JSON body with an \"addresses\" array of blockchain addresses.", "operationId": "GetBatchAllAddressIntelligence", "parameters": [ { "name": "chains", "in": "query", "description": "List of chains to filter by. If omitted, auto-detects the best chain.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "chain", "in": "query", "description": "Single blockchain network to filter all addresses to. If omitted, auto-detects per address.", "schema": { "$ref": "#/components/schemas/Chain" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddressRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAllAddressResponse" }, "example": { "addresses": { "0x28C6c06298d514Db089934071355E5743bf21d60": { "ethereum": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false } } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address/{address}": { "get": { "summary": "Get intelligence about an address", "description": "Returns intelligence data for the specified address, including entity associations, labels, and contract status.", "operationId": "GetAddressIntelligence", "parameters": [ { "name": "chain", "in": "query", "description": "Blockchain network to query. Only one network is used: if multiple values are provided, only the first applies. If omitted, the best chain is auto-detected across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" }, "example": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address/{address}/all": { "get": { "summary": "Get all intelligence about an address across chains", "description": "Returns multi-chain intelligence for the provided address, with data for each supported chain where the address format is valid.", "operationId": "GetAllAddressIntelligence", "parameters": [ { "name": "address", "in": "path", "description": "The blockchain address to query across all compatible chains.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query across all compatible chains.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Address" }, "example": { "ethereum": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address_enriched/batch": { "post": { "summary": "Batch lookup enriched address intelligence", "description": "Returns enriched intelligence (with tags, clusters, entity predictions) for up to 1000 addresses in a single request. Send a JSON body with an \"addresses\" array of blockchain addresses.", "operationId": "GetBatchAddressIntelligenceEnriched", "parameters": [ { "name": "chains", "in": "query", "description": "list of chains to filter by. If omitted, auto-detects the best chain.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "includeTags", "in": "query", "description": "Whether to include address tags in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include address tags in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeClusters", "in": "query", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeEntityPredictions", "in": "query", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "example": "true" } }, { "name": "chain", "in": "query", "description": "Single blockchain network to filter all addresses to. If omitted, auto-detects per address.", "schema": { "$ref": "#/components/schemas/Chain" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddressEnrichedRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddressEnrichedResponse" }, "example": { "addresses": { "0x28C6c06298d514Db089934071355E5743bf21d60": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address_enriched/batch/all": { "post": { "summary": "Batch lookup enriched address intelligence across all chains", "description": "Returns enriched intelligence (with tags, clusters, entity predictions) for up to 1000 addresses across all supported chains. Send a JSON body with an \"addresses\" array of blockchain addresses.", "operationId": "GetBatchAllAddressIntelligenceEnriched", "parameters": [ { "name": "chains", "in": "query", "description": "list of chains to filter by. If omitted, queries all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "includeTags", "in": "query", "description": "Whether to include address tags in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include address tags in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeClusters", "in": "query", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeEntityPredictions", "in": "query", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "example": "true" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAllAddressEnrichedRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAllAddressEnrichedResponse" }, "example": { "addresses": { "0x28C6c06298d514Db089934071355E5743bf21d60": { "ethereum": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] } } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address_enriched/{address}": { "get": { "summary": "Get intelligence about an address with additional address information", "description": "Similar to /intelligence/address/{address}, but includes additional address information (tags, cluster IDs, entity predictions). By default, includes tags, entity predictions, and cluster IDs. Use query parameters to exclude specific enrichments.", "operationId": "GetAddressIntelligenceEnriched", "parameters": [ { "name": "chain", "in": "query", "description": "Blockchain network to query. Only one network is used: if multiple values are provided, only the first applies. If omitted, the best chain is auto-detected across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "includeTags", "in": "query", "description": "Whether to include address tags in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include address tags in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeClusters", "in": "query", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeEntityPredictions", "in": "query", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "example": "true" } }, { "name": "address", "in": "path", "description": "The blockchain address to query.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressEnriched" }, "example": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address_enriched/{address}/all": { "get": { "summary": "Get intelligence about an address on all chains with additional address information", "description": "Similar to /intelligence/address_enriched/{address}, but aggregates data across every supported chain. By default, includes tags, entity predictions, and cluster IDs. Use query parameters to exclude specific enrichments.", "operationId": "GetAllAddressIntelligenceEnriched", "parameters": [ { "name": "includeTags", "in": "query", "description": "Whether to include address tags in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include address tags in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeEntityPredictions", "in": "query", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include entity predictions in the response. Defaults to 'true'.", "example": "true" } }, { "name": "includeClusters", "in": "query", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include cluster IDs in the response. Defaults to 'true'.", "example": "true" } }, { "name": "address", "in": "path", "description": "The blockchain address to query across all compatible chains.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query across all compatible chains.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AddressEnriched" }, "example": { "ethereum": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/address_tags/updates": { "get": { "summary": "Get address-tag association updates", "description": "Returns a feed of address-tag association changes (new tags applied to addresses, removed tags) with cursor-based pagination.", "operationId": "GetAddressTagUpdates", "parameters": [ { "name": "since", "in": "query", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "schema": { "type": "string", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "from", "in": "query", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "to", "in": "query", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-07T00:00:00Z" } }, { "name": "status", "in": "query", "description": "Filter by change status. For address tags only 'new', 'deleted', and 'all' are valid (no 'updated').", "schema": { "$ref": "#/components/schemas/UpdateStatus" } }, { "name": "chain", "in": "query", "description": "Blockchain networks to filter by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Blockchain networks to filter by.", "example": [ "ethereum", "bsc" ] } }, { "name": "address", "in": "query", "description": "Blockchain addresses to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Blockchain addresses to filter by. Max 100.", "example": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, { "name": "tagId", "in": "query", "description": "Tag IDs to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs to filter by. Max 100.", "example": [ "early-token-holder", "contract-deployer" ] } }, { "name": "tagParams", "in": "query", "description": "Filter by tag parameters (JSON string matching tag-specific params).", "schema": { "type": "string", "description": "Filter by tag parameters (JSON string matching tag-specific params).", "example": "Binance" } }, { "name": "entityId", "in": "query", "description": "Entity IDs to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Entity IDs to filter by. Max 100.", "example": [ "binance", "coinbase" ] } }, { "name": "category", "in": "query", "description": "Tag categories to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Tag categories to filter by. Max 100.", "example": [ "DeFi", "Social" ] } }, { "name": "orderBy", "in": "query", "description": "Sort order: 'time' (asc) or 'rank' (desc). Default 'time'.", "schema": { "type": "string", "description": "Sort order: 'time' (asc) or 'rank' (desc). Default 'time'.", "example": "time" } }, { "name": "limit", "in": "query", "description": "Maximum results to return (1-1000, default 100).", "schema": { "type": "integer", "description": "Maximum results to return (1-1000, default 100).", "example": 100 } }, { "name": "pageToken", "in": "query", "description": "Cursor token for pagination (from previous response).", "schema": { "type": "string", "description": "Cursor token for pagination (from previous response).", "example": "eyJkIjoiMjAyNS0wMS0wMVQwMDowMDowMFoiLCJxIjowfQ==" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "latest_diff_ts", "items", "hasMore" ], "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "Whether more results are available beyond this page.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AddressTagUpdate" }, "description": "Array of update items.", "nullable": true, "example": [ { "address": "0x18e226459CCf0Eec276514a4fd3b226D8961e4d1", "category": "Other", "chain": "ethereum", "diff_seq": 1930533, "diff_ts": "2026-02-03T06:49:00Z", "entity_id": "binance", "entity_name": "Binance", "entity_type": "cex", "label": "Early CATCOIN Holder", "rank": 540, "status": "new", "tag_id": "early-token-holder", "tag_name": "Early Token Holder", "tag_params": "{\"pricing_id\":\"catcoin-3\",\"symbol\":\"CATCOIN\"}", "template": "Early %s Holder" } ] }, "latest_diff_ts": { "type": "string", "description": "Most recent change timestamp in this response. Use as 'since' parameter for incremental sync. Null if no items returned.", "format": "date-time", "nullable": true, "example": "2025-04-09T00:00:00Z" }, "pageToken": { "type": "string", "description": "Opaque cursor for fetching the next page. Empty when no more pages.", "example": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "address": "0x18e226459CCf0Eec276514a4fd3b226D8961e4d1", "category": "Other", "chain": "ethereum", "diff_seq": 1930533, "diff_ts": "2026-02-03T06:49:00Z", "entity_id": "binance", "entity_name": "Binance", "entity_type": "cex", "label": "Early CATCOIN Holder", "rank": 540, "status": "new", "tag_id": "early-token-holder", "tag_name": "Early Token Holder", "tag_params": "{\"pricing_id\":\"catcoin-3\",\"symbol\":\"CATCOIN\"}", "template": "Early %s Holder" } ], "latest_diff_ts": "2025-04-09T00:00:00Z", "pageToken": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "address": "0x000000000000000000000000000000000000800A", "category": "Other", "chain": "arbitrum_one", "diff_seq": 1, "diff_ts": "2025-01-01T02:52:00Z", "rank": 140, "status": "new", "tag_id": "arbitrum-one-first-funder", "tag_name": "Arbitrum One First Funder", "tag_params": "0x35e14525280193cb71e8204cABafCf10F7e5Dc25", "template": "Arbitrum One First Funder: %s" }, { "address": "0x000072ba5D51098b904A927ddE54C22aD480B5B5", "category": "Other", "chain": "arbitrum_one", "diff_seq": 13, "diff_ts": "2025-01-01T02:52:00Z", "entity_id": "0xdyno", "entity_name": "@0xDyno", "entity_type": "individual", "label": "494119.eth", "rank": 540, "status": "deleted", "tag_id": "early-token-holder", "tag_name": "Early Token Holder", "tag_params": "GEM", "template": "Early %s Holder" } ], "latest_diff_ts": "2025-01-01T02:52:00Z", "pageToken": "eyJkIjoiMjAyNS0wMS0wMVQwMjo1MjowMFoiLCJxIjoxMDB9" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/addresses/updates": { "get": { "summary": "Get address intelligence updates", "description": "Returns a feed of address label, entity, and tag changes with cursor-based pagination.", "operationId": "GetAddressUpdates", "parameters": [ { "name": "since", "in": "query", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "schema": { "type": "string", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "from", "in": "query", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "to", "in": "query", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-07T00:00:00Z" } }, { "name": "status", "in": "query", "description": "Filter by change status.", "schema": { "$ref": "#/components/schemas/UpdateStatus" } }, { "name": "address", "in": "query", "description": "Blockchain addresses to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Blockchain addresses to filter by. Max 100.", "example": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, { "name": "chain", "in": "query", "description": "Blockchain networks to filter by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Blockchain networks to filter by.", "example": [ "ethereum", "bsc" ] } }, { "name": "entityId", "in": "query", "description": "Entity IDs to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Entity IDs to filter by. Max 100.", "example": [ "binance", "coinbase" ] } }, { "name": "entityType", "in": "query", "description": "Entity types to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Entity types to filter by. Max 100.", "example": [ "cex", "dex", "fund" ] } }, { "name": "label", "in": "query", "description": "Filter by address label.", "schema": { "type": "string", "description": "Filter by address label.", "example": "Cold Wallet" } }, { "name": "service", "in": "query", "description": "Filter by service addresses.", "schema": { "type": "boolean", "description": "Filter by service addresses.", "nullable": true, "example": true } }, { "name": "depositExchangeId", "in": "query", "description": "Deposit exchange entity IDs to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Deposit exchange entity IDs to filter by. Max 100.", "example": [ "binance", "coinbase" ] } }, { "name": "tagId", "in": "query", "description": "Tag IDs to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs to filter by. Max 100.", "example": [ "gnosis-safe-signer", "contract-deployer" ] } }, { "name": "tagParams", "in": "query", "description": "Filter by tag parameters (JSON string matching tag-specific params).", "schema": { "type": "string", "description": "Filter by tag parameters (JSON string matching tag-specific params).", "example": "Binance" } }, { "name": "orderBy", "in": "query", "description": "Sort order: 'time' (asc), 'balance', 'volume', or 'transfers' (desc). Default 'time'.", "schema": { "type": "string", "description": "Sort order: 'time' (asc), 'balance', 'volume', or 'transfers' (desc). Default 'time'.", "example": "time" } }, { "name": "limit", "in": "query", "description": "Maximum results to return (1-1000, default 100).", "schema": { "type": "integer", "description": "Maximum results to return (1-1000, default 100).", "example": 100 } }, { "name": "includeTags", "in": "query", "description": "Whether to include address tags in the response. Defaults to true.", "schema": { "type": "boolean", "description": "Whether to include address tags in the response. Defaults to true.", "nullable": true, "example": true } }, { "name": "includeEntityPredictions", "in": "query", "description": "Whether to include entity predictions in the response. Defaults to true.", "schema": { "type": "boolean", "description": "Whether to include entity predictions in the response. Defaults to true.", "nullable": true, "example": true } }, { "name": "includeClusters", "in": "query", "description": "Whether to include cluster data in the response. Defaults to true.", "schema": { "type": "boolean", "description": "Whether to include cluster data in the response. Defaults to true.", "nullable": true, "example": true } }, { "name": "pageToken", "in": "query", "description": "Cursor token for pagination (from previous response).", "schema": { "type": "string", "description": "Cursor token for pagination (from previous response).", "example": "eyJkIjoiMjAyNS0wMS0wMVQwMDowMDowMFoiLCJxIjowfQ==" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "latest_diff_ts", "items", "hasMore" ], "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "Whether more results are available beyond this page.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AddressUpdate" }, "description": "Array of update items.", "nullable": true, "example": [ { "address": "0xaD354CfBAa4A8572DD6Df021514a3931A8329Ef5", "chain": "ethereum", "cluster_ids": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "deposit_exchange_id": "binance", "diff_seq": 16381934, "diff_ts": "2025-04-09T00:00:00Z", "entity_id": "binance", "entity_name": "Binance", "entity_type": "cex", "label": "SingleOwnerMSCA (Proxy)", "metrics": { "balance_usd": 1399819400.52, "first_tx": "2024-11-25T06:53:23Z", "last_tx": "2026-02-01T14:59:35Z", "transfers": 33, "volume_usd": 1399862803.52 }, "populated_tags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predicted_entity": { "id": "binance", "name": "Binance", "type": "cex" }, "service": true, "status": "updated" } ] }, "latest_diff_ts": { "type": "string", "description": "Most recent change timestamp in this response. Use as 'since' parameter for incremental sync. Null if no items returned.", "format": "date-time", "nullable": true, "example": "2025-04-09T00:00:00Z" }, "pageToken": { "type": "string", "description": "Opaque cursor for fetching the next page. Empty when no more pages.", "example": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "address": "0xaD354CfBAa4A8572DD6Df021514a3931A8329Ef5", "chain": "ethereum", "cluster_ids": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "deposit_exchange_id": "binance", "diff_seq": 16381934, "diff_ts": "2025-04-09T00:00:00Z", "entity_id": "binance", "entity_name": "Binance", "entity_type": "cex", "label": "SingleOwnerMSCA (Proxy)", "metrics": { "balance_usd": 1399819400.52, "first_tx": "2024-11-25T06:53:23Z", "last_tx": "2026-02-01T14:59:35Z", "transfers": 33, "volume_usd": 1399862803.52 }, "populated_tags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predicted_entity": { "id": "binance", "name": "Binance", "type": "cex" }, "service": true, "status": "updated" } ], "latest_diff_ts": "2025-04-09T00:00:00Z", "pageToken": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "address": "0x000000000000012DeF132E61759048bE5b5C6033", "chain": "arbitrum_one", "deposit_exchange_id": null, "diff_seq": 1, "diff_ts": "2025-01-01T00:00:00Z", "entity_id": null, "entity_name": null, "entity_type": null, "label": "Cortex (CX)", "populated_tags": [ { "chain": "arbitrum_one", "disablePage": true, "excludeEntities": true, "id": "token-label", "label": "%s", "rank": 380, "tagParams": "Cortex (CX)" }, { "chain": "arbitrum_one", "disablePage": true, "excludeEntities": true, "id": "token-standard", "label": "%s Token", "rank": 300, "tagParams": "ERC20" } ], "service": false, "status": "new" }, { "address": "0x000BAE686D6f10C9715593bD9d06cc03E7529c18", "chain": "arbitrum_one", "deposit_exchange_id": null, "diff_seq": 39, "diff_ts": "2025-01-01T00:00:00Z", "entity_id": "uniswap", "entity_name": "Uniswap", "entity_type": "dex", "label": "V3 Pool", "populated_tags": [ { "chain": "arbitrum_one", "disablePage": false, "excludeEntities": false, "id": "dex", "label": "Decentralized Exchange", "rank": 50 } ], "service": false, "status": "new" } ], "latest_diff_ts": "2025-01-01T00:00:00Z", "pageToken": "eyJkIjoiMjAyNS0wMS0wMVQwMDowMDowMFoiLCJxIjoxMDB9" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/contract/{chain}/{address}": { "get": { "summary": "Get intelligence about a contract", "description": "Returns contract metadata for the specified chain and address, including deployer information, proxy status, and block timestamp. Returns 404 if no contract is found at the given chain and address.", "operationId": "GetContractIntelligence", "parameters": [ { "name": "chain", "in": "path", "description": "Blockchain network where the contract is deployed.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "address", "in": "path", "description": "The contract address to query.", "required": true, "schema": { "type": "string", "description": "The contract address to query.", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichedContract" }, "example": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "blockTimestamp": "2018-08-03T19:28:24Z", "bytecode": "", "deployer": { "address": "0x95Ba4cF87D6723ad9C0Db21737D862bE80e93911", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/circle-2", "id": "circle", "linkedin": "https://www.linkedin.com/company/circle-internet-financial", "name": "Circle", "note": "", "service": null, "twitter": "https://twitter.com/circle", "type": "stablecoin", "website": "https://circle.com" }, "arkhamLabel": { "address": "0x95Ba4cF87D6723ad9C0Db21737D862bE80e93911", "chainType": "evm", "name": "Deployer" }, "chain": "ethereum", "contract": false, "isUserAddress": false }, "functionSighashes": null, "internalDeployer": { "address": "0x95Ba4cF87D6723ad9C0Db21737D862bE80e93911", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/circle-2", "id": "circle", "linkedin": "https://www.linkedin.com/company/circle-internet-financial", "name": "Circle", "note": "", "service": null, "twitter": "https://twitter.com/circle", "type": "stablecoin", "website": "https://circle.com" }, "arkhamLabel": { "address": "0x95Ba4cF87D6723ad9C0Db21737D862bE80e93911", "chainType": "evm", "name": "Deployer" }, "chain": "ethereum", "contract": false, "isUserAddress": false }, "isProxy": true, "proxyAddress": "0xa2327a938Febf5FEC13baCFb16Ae10EcBc4cbDCF", "transactionHash": "0xe7e0fe390354509cd08c9a0168536938600ddc552b3f7cb96030ebef62e75895" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/entities/updates": { "get": { "summary": "Get entity intelligence updates", "description": "Returns a feed of entity changes (new entities, name updates, type changes, deletions) with cursor-based pagination.", "operationId": "GetEntityUpdates", "parameters": [ { "name": "since", "in": "query", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "schema": { "type": "string", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "from", "in": "query", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "to", "in": "query", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-07T00:00:00Z" } }, { "name": "status", "in": "query", "description": "Filter by change status.", "schema": { "$ref": "#/components/schemas/UpdateStatus" } }, { "name": "entityId", "in": "query", "description": "Entity IDs to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Entity IDs to filter by. Max 100.", "example": [ "binance", "coinbase" ] } }, { "name": "entityType", "in": "query", "description": "Entity types to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Entity types to filter by. Max 100.", "example": [ "cex", "dex", "fund" ] } }, { "name": "orderBy", "in": "query", "description": "Sort order: 'time' (asc), 'balance', 'volume', or 'addressCount' (desc). Default 'time'.", "schema": { "type": "string", "description": "Sort order: 'time' (asc), 'balance', 'volume', or 'addressCount' (desc). Default 'time'.", "example": "time" } }, { "name": "limit", "in": "query", "description": "Maximum results to return (1-1000, default 100).", "schema": { "type": "integer", "description": "Maximum results to return (1-1000, default 100).", "example": 100 } }, { "name": "pageToken", "in": "query", "description": "Cursor token for pagination (from previous response).", "schema": { "type": "string", "description": "Cursor token for pagination (from previous response).", "example": "eyJkIjoiMjAyNS0wMS0wMVQwMDowMDowMFoiLCJxIjowfQ==" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "latest_diff_ts", "items", "hasMore" ], "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "Whether more results are available beyond this page.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUpdate" }, "description": "Array of update items.", "nullable": true, "example": [ { "city": "Abu Dhabi", "country": "ARE", "crunchbase_url": "https://www.crunchbase.com/organization/binance", "diff_seq": 103484, "diff_ts": "2026-02-06T02:40:38Z", "id": "binance", "instagram_url": "https://www.instagram.com/binance", "linkedin_url": "https://www.linkedin.com/company/binance", "metrics": { "address_count": 60377768, "balance_usd": 248837164196.3, "first_tx": "2017-06-19T06:17:43Z", "last_tx": "2026-02-12T23:59:59Z", "volume_usd": 43905586610785.82 }, "name": "Binance", "region": "Abu Dhabi", "shortname": "Binance", "status": "new", "twitter_url": "https://twitter.com/binance", "type": "cex", "website_url": "https://binance.com" } ] }, "latest_diff_ts": { "type": "string", "description": "Most recent change timestamp in this response. Use as 'since' parameter for incremental sync. Null if no items returned.", "format": "date-time", "nullable": true, "example": "2025-04-09T00:00:00Z" }, "pageToken": { "type": "string", "description": "Opaque cursor for fetching the next page. Empty when no more pages.", "example": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "city": "Abu Dhabi", "country": "ARE", "crunchbase_url": "https://www.crunchbase.com/organization/binance", "diff_seq": 103484, "diff_ts": "2026-02-06T02:40:38Z", "id": "binance", "instagram_url": "https://www.instagram.com/binance", "linkedin_url": "https://www.linkedin.com/company/binance", "metrics": { "address_count": 60377768, "balance_usd": 248837164196.3, "first_tx": "2017-06-19T06:17:43Z", "last_tx": "2026-02-12T23:59:59Z", "volume_usd": 43905586610785.82 }, "name": "Binance", "region": "Abu Dhabi", "shortname": "Binance", "status": "new", "twitter_url": "https://twitter.com/binance", "type": "cex", "website_url": "https://binance.com" } ], "latest_diff_ts": "2025-04-09T00:00:00Z", "pageToken": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "diff_seq": 1, "diff_ts": "2025-01-01T03:31:00Z", "id": "blockchain-bandit", "metrics": { "address_count": 15, "balance_usd": 99992288.08999999, "first_tx": "2016-02-14T15:59:14Z", "last_tx": "2026-02-06T19:37:41Z", "volume_usd": 528350643.2299999 }, "name": "Blockchain Bandit", "status": "new", "type": "hacker" }, { "diff_seq": 1, "diff_ts": "2025-01-07T04:12:00Z", "id": "cryptex-net", "linkedin_url": "https://www.linkedin.com/company/cryptexnet/about", "metrics": { "address_count": 2096, "balance_usd": 5078693.820000242, "first_tx": "2018-04-17T19:34:08Z", "last_tx": "2026-02-12T16:10:36Z", "volume_usd": 4594517787.85998 }, "name": "Cryptex", "status": "new", "twitter_url": "https://x.com/cryptex_net", "type": "cex", "website_url": "https://cryptex.net" } ], "latest_diff_ts": "2025-01-14T03:34:00Z", "pageToken": "eyJkIjoiMjAyNS0wMS0xNFQwMzozNDowMFoiLCJxIjo5MH0=" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/entity/{entity}": { "get": { "summary": "Get intelligence about an entity", "description": "Returns top-level entity information, including associated tags, social links, and metadata.", "operationId": "GetEntityIntelligence", "parameters": [ { "name": "entity", "in": "path", "description": "The entity ID to query.", "required": true, "schema": { "type": "string", "description": "The entity ID to query.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity" }, "example": { "crunchbase": "https://www.crunchbase.com/organization/binance", "customized": false, "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "populatedTags": [ { "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/entity/{entity}/summary": { "get": { "summary": "Get entity summary statistics", "description": "Returns summary statistics for the specified entity, including:\n- Total number of unique addresses (deduplicated across chains)\n- Total balance in USD across all chains\n- Total transfer volume in USD\n- First and last transfer timestamps\n\nSupports Arkham entities and user-created entities. When authenticated, user-added addresses are included for Arkham entities.\n\n**Shareable user entities:** If a user entity is marked as shareable, any authenticated or unauthenticated user can access the summary.", "operationId": "GetEntitySummary", "parameters": [ { "name": "entity", "in": "path", "description": "The entity ID to retrieve summary statistics for.", "required": true, "schema": { "type": "string", "description": "The entity ID to retrieve summary statistics for.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySummary" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/entity_balance_changes": { "get": { "summary": "Get entity balance changes", "description": "Returns a ranked list of entities with their balance changes over a specified time interval. Filter by chain, entity type, token, and balance thresholds. Useful for tracking which entities are accumulating or distributing assets.", "operationId": "GetEntityBalanceChanges", "parameters": [ { "name": "orderBy", "in": "query", "description": "Field to sort results by. One of: balanceUsd, balanceUsdChange, balanceUsdPctChange, balanceUnit, balanceUnitChange, balanceUnitPctChange.", "required": true, "schema": { "$ref": "#/components/schemas/EntityBalanceChangesOrderBy" } }, { "name": "orderDir", "in": "query", "description": "Sort direction: 'asc' for ascending or 'desc' for descending.", "required": true, "schema": { "$ref": "#/components/schemas/EntityBalanceChangesOrderDir" } }, { "name": "interval", "in": "query", "description": "Time interval for balance change calculation. One of '7d', '14d', or '30d'.", "required": true, "schema": { "$ref": "#/components/schemas/EntityBalanceChangesInterval" } }, { "name": "chains", "in": "query", "description": "List of chains to filter by.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" }, "description": "List of chains to filter by.", "example": [ "ethereum" ] } }, { "name": "entityTypes", "in": "query", "description": "List of entity types to filter by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of entity types to filter by.", "example": [ "cex", "fund" ] } }, { "name": "entityIds", "in": "query", "description": "List of specific entity IDs to filter by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of specific entity IDs to filter by.", "example": [ "binance", "coinbase" ] } }, { "name": "entityTags", "in": "query", "description": "List of entity tags to include. Requires elevated access; requests using this parameter without it may return 403.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of entity tags to include. Requires elevated access; requests using this parameter without it may return 403.", "example": [ "hot-wallet", "kol" ] } }, { "name": "negatedEntityTags", "in": "query", "description": "List of entity tags to exclude. Requires elevated access; requests using this parameter without it may return 403.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of entity tags to exclude. Requires elevated access; requests using this parameter without it may return 403.", "example": [ "hot-wallet", "kol" ] } }, { "name": "pricingIds", "in": "query", "description": "List of CoinGecko pricing IDs to filter by.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of CoinGecko pricing IDs to filter by.", "example": [ "bitcoin", "ethereum" ] } }, { "name": "balanceMin", "in": "query", "description": "Minimum balance threshold in USD to filter entities.", "schema": { "type": "integer", "description": "Minimum balance threshold in USD to filter entities.", "example": 1 } }, { "name": "balanceMax", "in": "query", "description": "Maximum balance threshold in USD to filter entities.", "schema": { "type": "integer", "description": "Maximum balance threshold in USD to filter entities.", "example": 1 } }, { "name": "limit", "in": "query", "description": "Number of results to return per page. Required; must be between 1 and 100.", "required": true, "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Number of results to return per page. Required; must be between 1 and 100.", "example": 10 } }, { "name": "offset", "in": "query", "description": "Number of results to skip from the beginning.", "schema": { "type": "integer", "description": "Number of results to skip from the beginning.", "example": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntityBalanceChanges" }, "example": [ { "balanceUnit": 1.23, "balanceUsd": 1.23, "entityId": "binance", "entityName": "Binance", "entityType": "cex", "prevBalanceUnit": 1.23, "prevBalanceUsd": 1.23, "tokenBalances": [ { "balanceUnit": 1.23, "balanceUsd": 1.23, "prevBalanceUnit": 1.23, "prevBalanceUsd": 1.23, "tokenId": "usd-coin", "tokenSymbol": "USDC" } ] } ] }, "example": [ { "balanceUnit": 2.588710860077077e+30, "balanceUsd": 128882055209.18153, "entityId": "binance", "entityName": "Binance", "entityType": "cex", "prevBalanceUnit": 2.588710860077077e+30, "prevBalanceUsd": 128959949999.75998, "tokenBalances": [ { "balanceUnit": 665902.74090254, "balanceUsd": 42777592075.57917, "prevBalanceUnit": 671251.50395595, "prevBalanceUsd": 43238665627.32252, "tokenId": "bitcoin", "tokenSymbol": "btc" }, { "balanceUnit": 4073033.238123183, "balanceUsd": 7084063789.738129, "prevBalanceUnit": 3964473.476386405, "prevBalanceUsd": 6660434374.533453, "tokenId": "ethereum", "tokenSymbol": "eth" } ] } ] } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/entity_predictions/{entity}": { "get": { "summary": "Get predictions for an entity", "description": "Returns predicted addresses for the specified entity. These predictions are generated using machine learning algorithms to identify addresses that may belong to the entity based on transaction patterns and other blockchain data. Returns up to 1000 predictions per entity, sorted by USD balance.", "operationId": "GetEntityPredictions", "parameters": [ { "name": "entity", "in": "path", "description": "The entity ID to retrieve address predictions for.", "required": true, "schema": { "type": "string", "description": "The entity ID to retrieve address predictions for.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntityPrediction" }, "example": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "entityID": "binance", "usdBalance": 938079658.6 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/entity_types": { "get": { "summary": "Get all entity types", "description": "Returns the list of all entity type classifications (e.g., 'cex', 'dex', 'fund', 'individual'). Use these values to filter other intelligence endpoints by entity type.", "operationId": "GetEntityTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "gaming" }, "example": [ "gaming", "derivatives", "misc", "nft-marketplace", "hacker", "dex", "defi", "crosschain-interoperability", "privacy", "meme", "smart-contract-platform", "charity", "blockchain-infra", "bridge", "real-world-assets", "launchpad", "fund-decentralized", "miner-validator", "faucet", "oracle", "blockchain-infrastructure", "dao", "insurance", "staking", "ai", "mixer", "blockchain-scaling", "individual", "fund", "prediction-market", "ponzi", "social", "dex-aggregator", "scam", "validator", "liquid-staking", "yield", "custodian", "government", "lending-centralized", "cex", "mev", "darkweb", "lending-decentralized", "cdp", "wallet", "otc", "ransomware", "gambling", "stablecoin", "nft" ] } } } }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/search": { "get": { "summary": "Search addresses, entities, tokens, and pools", "description": "Full-text search across addresses, entities, tokens, and Solana pools. Returns matching results ranked by relevance.", "operationId": "IntelligenceSearchHandler", "parameters": [ { "name": "query", "in": "query", "description": "Search query string to match against entities, addresses, tokens, pools, ENS names, and more. An empty query returns no results.", "schema": { "type": "string", "description": "Search query string to match against entities, addresses, tokens, pools, ENS names, and more. An empty query returns no results.", "example": "binance" } }, { "name": "arkhamEntities", "in": "query", "description": "Max Arkham-curated entities to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max Arkham-curated entities to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "arkhamAddresses", "in": "query", "description": "Max Arkham-curated addresses with labels to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max Arkham-curated addresses with labels to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "userEntities", "in": "query", "description": "Max user-defined entities to return (0–50, default 5). Requires authentication.", "schema": { "type": "integer", "description": "Max user-defined entities to return (0–50, default 5). Requires authentication.", "nullable": true, "example": 1 } }, { "name": "userAddresses", "in": "query", "description": "Max user-defined addresses with labels to return (0–50, default 5). Requires authentication.", "schema": { "type": "integer", "description": "Max user-defined addresses with labels to return (0–50, default 5). Requires authentication.", "nullable": true, "example": 1 } }, { "name": "ens", "in": "query", "description": "Max ENS primary names to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max ENS primary names to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "types", "in": "query", "description": "Max entity-type matches to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max entity-type matches to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "services", "in": "query", "description": "Max CEX/VASP entities to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max CEX/VASP entities to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "twitter", "in": "query", "description": "Max Twitter-handle matches to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max Twitter-handle matches to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "opensea", "in": "query", "description": "Max OpenSea usernames to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max OpenSea usernames to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "tokens", "in": "query", "description": "Max tokens to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max tokens to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "pools", "in": "query", "description": "Max Solana pools to return (0–50, default 5).", "schema": { "type": "integer", "description": "Max Solana pools to return (0–50, default 5).", "nullable": true, "example": 1 } }, { "name": "tags", "in": "query", "description": "Max tag matches to return (0–50, default 0).", "schema": { "type": "integer", "description": "Max tag matches to return (0–50, default 0).", "nullable": true, "example": 1 } }, { "name": "polymarketEvents", "in": "query", "description": "Max Polymarket prediction events to return (0–50, default 0). Also enables the predictions-wallet match for address queries.", "schema": { "type": "integer", "description": "Max Polymarket prediction events to return (0–50, default 0). Also enables the predictions-wallet match for address queries.", "nullable": true, "example": 1 } }, { "name": "arkhamEntitiesOffset", "in": "query", "description": "Skip the first N Arkham entities (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N Arkham entities (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "arkhamAddressesOffset", "in": "query", "description": "Skip the first N Arkham addresses with labels (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N Arkham addresses with labels (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "userEntitiesOffset", "in": "query", "description": "Skip the first N user entities (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N user entities (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "userAddressesOffset", "in": "query", "description": "Skip the first N user addresses with labels (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N user addresses with labels (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "ensOffset", "in": "query", "description": "Skip the first N ENS names (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N ENS names (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "typesOffset", "in": "query", "description": "Skip the first N entity-type matches (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N entity-type matches (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "servicesOffset", "in": "query", "description": "Skip the first N CEX/VASP entities (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N CEX/VASP entities (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "twitterOffset", "in": "query", "description": "Skip the first N Twitter matches (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N Twitter matches (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "openseaOffset", "in": "query", "description": "Skip the first N OpenSea usernames (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N OpenSea usernames (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "tokensOffset", "in": "query", "description": "Skip the first N tokens (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N tokens (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "poolsOffset", "in": "query", "description": "Skip the first N pools (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N pools (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "tagsOffset", "in": "query", "description": "Skip the first N tag matches (0–500, default 0).", "schema": { "type": "integer", "description": "Skip the first N tag matches (0–500, default 0).", "nullable": true, "example": 1 } }, { "name": "filterLimits", "in": "query", "description": "(Legacy. Prefer flat parameters such as arkhamAddresses=50.) URL-encoded JSON object specifying maximum results per category. Each value is capped at 50; defaults to 5 per category. Flat parameters, when provided, override values in this object.", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/SearchFilterLimits" } }, { "name": "filterOffsets", "in": "query", "description": "(Legacy. Prefer flat parameters such as arkhamAddressesOffset=10.) URL-encoded JSON object specifying pagination offset per category. Each value is capped at 500; defaults to 0 per category. Flat parameters, when provided, override values in this object.", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/SearchFilterOffsets" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResults" }, "example": { "arkhamAddresses": [ { "address": "1HDWAto9mD4vwZkxE7RZ4nxvgYcA5vJQpG", "arkhamLabel": { "address": "1HDWAto9mD4vwZkxE7RZ4nxvgYcA5vJQpG", "chainType": "bitcoin", "name": "Binance Deposit" }, "chain": "bitcoin" } ], "arkhamEntities": [ { "id": "binance", "name": "Binance", "note": "", "service": true, "twitter": "binance", "type": "cex" } ], "ens": [ { "address": "0x00000029fF545c86524Ade7cAF132527707948C4", "name": "binance.umbra.eth" } ], "opensea": [ { "address": "0xF5B42425E9805A1d76aC3F893aF71Ab2065563d4", "profileImage": null, "username": "binance_cz" } ], "pools": [ { "liquidityUsd": 0, "marketCapUsd": 0, "poolAddress": "CiLg83sX8nJQMPkRwGMZYcjbgcHxaXsL6XjZre5nmeKn", "priceUsd": 0.00008714, "pricingID": "bainance-labs", "programAddress": "CPMMoo8L3F4NbTegBCKVNunggL7H1ZpdTHKxQB5qKP1C", "tokenAddress": "4tViJmZ7LKREaqxrh3tXeCB5TfK7o67W3WhykHrr49ZC", "tokenName": "bAInance Labs", "tokenSymbol": "bainance", "volume1h": 0 } ], "services": [ { "id": "binance", "name": "Binance", "note": "", "service": true, "twitter": "binance", "type": "cex" } ], "tokens": [ { "deployments": [ { "address": "0x250632378E573c6Be1AC2f97Fcdf00515d0Aa91B", "chain": "bsc" } ], "identifier": { "pricingID": "binance-eth" }, "name": "Binance ETH staking", "price": 1940.37, "price24hAgo": 1927.27, "symbol": "beth" } ], "twitter": [ { "id": "binance-us", "name": "Binance US", "note": "", "service": true, "twitter": "BinanceUS", "type": "cex" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/tags/updates": { "get": { "summary": "Get tag definition updates", "description": "Returns a feed of tag definition changes (new tags, updated descriptions, rank changes, deletions) with cursor-based pagination.", "operationId": "GetTagUpdates", "parameters": [ { "name": "since", "in": "query", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "schema": { "type": "string", "description": "Returns changes since this time. Required unless both 'from' and 'to' are provided; mutually exclusive with 'from'/'to'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "from", "in": "query", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "Start of time window (use with 'to', max 7-day window). Provide together with 'to' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-01T00:00:00Z" } }, { "name": "to", "in": "query", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "schema": { "type": "string", "description": "End of time window (use with 'from', max 7-day window). Provide together with 'from' as an alternative to 'since'; mutually exclusive with 'since'.", "nullable": true, "example": "2025-01-07T00:00:00Z" } }, { "name": "status", "in": "query", "description": "Filter by change status.", "schema": { "$ref": "#/components/schemas/UpdateStatus" } }, { "name": "tagId", "in": "query", "description": "Tag IDs to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Tag IDs to filter by. Max 100.", "example": [ "contract-deployer", "early-token-holder" ] } }, { "name": "category", "in": "query", "description": "Tag categories to filter by. Max 100.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Tag categories to filter by. Max 100.", "example": [ "DeFi", "Social" ] } }, { "name": "orderBy", "in": "query", "description": "Sort order: 'time' (asc), 'addressCount', or 'entityCount' (desc). Default 'time'.", "schema": { "type": "string", "description": "Sort order: 'time' (asc), 'addressCount', or 'entityCount' (desc). Default 'time'.", "example": "time" } }, { "name": "limit", "in": "query", "description": "Maximum results to return (1-1000, default 100).", "schema": { "type": "integer", "description": "Maximum results to return (1-1000, default 100).", "example": 100 } }, { "name": "pageToken", "in": "query", "description": "Cursor token for pagination (from previous response).", "schema": { "type": "string", "description": "Cursor token for pagination (from previous response).", "example": "eyJkIjoiMjAyNS0wMS0wMVQwMDowMDowMFoiLCJxIjowfQ==" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "latest_diff_ts", "items", "hasMore" ], "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "Whether more results are available beyond this page.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TagUpdate" }, "description": "Array of update items.", "nullable": true, "example": [ { "address_count": 6110547, "category": "Other", "description": "Addresses that have deployed smart contracts", "diff_seq": 1, "diff_ts": "2025-02-09T02:59:00Z", "entity_count": 0, "id": "contract-deployer", "rank": 180, "status": "new", "tag_name": "Contract Deployer", "template": "Contract Deployer" } ] }, "latest_diff_ts": { "type": "string", "description": "Most recent change timestamp in this response. Use as 'since' parameter for incremental sync. Null if no items returned.", "format": "date-time", "nullable": true, "example": "2025-04-09T00:00:00Z" }, "pageToken": { "type": "string", "description": "Opaque cursor for fetching the next page. Empty when no more pages.", "example": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "address_count": 6110547, "category": "Other", "description": "Addresses that have deployed smart contracts", "diff_seq": 1, "diff_ts": "2025-02-09T02:59:00Z", "entity_count": 0, "id": "contract-deployer", "rank": 180, "status": "new", "tag_name": "Contract Deployer", "template": "Contract Deployer" } ], "latest_diff_ts": "2025-04-09T00:00:00Z", "pageToken": "eyJkIjoiMjAyNS0wMi0wMlQwMDowMDowMFoiLCJxIjoyfQ==" } }, "example": { "hasMore": true, "items": [ { "address_count": 336199, "category": "Airdrop", "description": "Addresses who received the $PENGU airdrop", "diff_seq": 1, "diff_ts": "2025-01-24T03:14:00Z", "entity_count": 5963, "id": "pengu-airdrop-recipient-cluster", "rank": 53, "status": "new", "tag_name": "Pengu Airdrop Recipient Cluster", "template": "Pengu Airdrop Recipient Cluster: %s" }, { "address_count": 1, "category": "Other", "description": "Addresses associated with prime brokerage entities that offer a suite of services for institutional clients including lending, leveraged trade executions, OTC deals, and asset management", "diff_seq": 1, "diff_ts": "2025-01-26T06:50:00Z", "entity_count": 0, "id": "brokerage", "rank": 5, "status": "updated", "tag_name": "Brokerage", "template": "Brokerage" } ], "latest_diff_ts": "2025-12-19T05:33:00Z", "pageToken": "eyJkIjoiMjAyNS0xMi0xOVQwNTozMzowMFoiLCJxIjoyOX0=" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/token/{chain}/{address}": { "get": { "summary": "Get intelligence on a token by chain/address", "description": "Retrieve basic token info using chain and contract address.", "operationId": "GetTokenIntelligence", "parameters": [ { "name": "chain", "in": "path", "description": "Blockchain network where the token is deployed.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "address", "in": "path", "description": "The token contract address to query.", "required": true, "schema": { "type": "string", "description": "The token contract address to query.", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" }, "example": { "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USD Coin", "symbol": "USDC", "tvTicker": "BINANCE:USDCUSDT" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/intelligence/token/{id}": { "get": { "summary": "Get intelligence on a token by CoinGecko pricing ID", "description": "Retrieve basic token info using the CoinGecko pricing ID (e.g., \"bitcoin\", \"ethereum\").", "operationId": "GetTokenIntelligenceById", "parameters": [ { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" }, "example": { "identifier": { "pricingID": "usd-coin" }, "name": "USDC", "price": 0.99961, "price24hAgo": 0.999892, "symbol": "usdc", "tvTicker": "BINANCE:USDCUSDT" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/loans/address/{address}": { "get": { "summary": "Get loan/borrow positions for an address", "description": "Returns an overview of loaned/supplied/borrowed assets for a given address.", "operationId": "GetAddressLoans", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,arbitrum_one'). If omitted, returns loan positions across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query loan positions for.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query loan positions for.", "example": "0xaD1fB851e54C55D65D8CEfE65f9E4c64A83650fd" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressLoanBalancesResponse" }, "example": { "addresses": { "arbitrum_one": { "0xaD1fB851e54C55D65D8CEfE65f9E4c64A83650fd": { "address": "0xaD1fB851e54C55D65D8CEfE65f9E4c64A83650fd", "arkhamLabel": { "address": "0xaD1fB851e54C55D65D8CEfE65f9E4c64A83650fd", "chainType": "evm", "name": "etherean.eth" }, "chain": "arbitrum_one", "contract": false, "isUserAddress": false } }, "ethereum": { "0xaD1fB851e54C55D65D8CEfE65f9E4c64A83650fd": { "address": "0xaD1fB851e54C55D65D8CEfE65f9E4c64A83650fd", "arkhamLabel": { "address": "0xaD1fB851e54C55D65D8CEfE65f9E4c64A83650fd", "chainType": "evm", "name": "etherean.eth" }, "chain": "ethereum", "contract": false, "isUserAddress": false } } }, "balances": { "arbitrum_one": [ { "address": "0x9c4ec768c28520B50860ea7a15bd7213a9fF58bf", "balance": 23792.73678, "balanceExact": "23792736780", "id": "usd-coin", "market": "0x9c4ec768c28520B50860ea7a15bd7213a9fF58bf", "name": "USD Coin", "price": 1, "price24hAgo": 1, "protocol": "COMPOUND_V3", "quoteTime": "2026-07-07T15:34:50.955Z", "symbol": "USDC", "type": "borrowed", "underlyingAssetAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", "underlyingAssetID": "usd-coin", "usd": 23792.73678 }, { "address": "0xA5EDBDD9646f8dFF606d7448e414884C7d905dCA", "balance": 12142.723738, "balanceExact": "12142723738", "id": "usd-coin-ethereum-bridged", "market": "0xA5EDBDD9646f8dFF606d7448e414884C7d905dCA", "name": "USD Coin (Arb1)", "price": 1, "price24hAgo": 1, "protocol": "COMPOUND_V3", "quoteTime": "2026-07-07T15:34:35.701Z", "symbol": "USDC", "type": "borrowed", "underlyingAssetAddress": "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8", "underlyingAssetID": "usd-coin-ethereum-bridged", "usd": 12142.723738 } ], "ethereum": [ { "address": "0xc3d688B66703497DAA19211EEdff47f25384cdc3", "balance": 213778.237113, "balanceExact": "213778237113", "id": "usd-coin", "market": "0xc3d688B66703497DAA19211EEdff47f25384cdc3", "name": "USD Coin", "price": 1, "price24hAgo": 1, "protocol": "COMPOUND_V3", "quoteTime": "2026-07-07T15:34:50.955Z", "symbol": "USDC", "type": "borrowed", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "usd": 213778.237113 }, { "address": "0xc3d688B66703497DAA19211EEdff47f25384cdc3", "balance": 78.53290370957879, "balanceExact": "78532903709578783817", "id": "weth", "market": "0xc3d688B66703497DAA19211EEdff47f25384cdc3", "name": "Wrapped Ether", "price": 1792.54, "price24hAgo": 1762.1, "protocol": "COMPOUND_V3", "quoteTime": "2026-07-07T15:34:46.553Z", "symbol": "WETH", "type": "supplied", "underlyingAssetAddress": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", "underlyingAssetID": "weth", "usd": 140773.37121556836 } ] }, "totalPositions": { "arbitrum_one": 48146.42974611472, "ethereum": 359915.8033752398 } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/loans/entity/{entity}": { "get": { "summary": "Get loan/borrow positions for an entity", "description": "Returns an overview of loaned/supplied/borrowed assets for a given entity.", "operationId": "GetEntityLoans", "parameters": [ { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,arbitrum_one'). If omitted, returns loan positions across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "entity", "in": "path", "description": "The entity ID to query loan positions for. Accepts both Arkham entity IDs and user entity IDs.", "required": true, "schema": { "type": "string", "description": "The entity ID to query loan positions for. Accepts both Arkham entity IDs and user entity IDs.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityLoansBalancesResponse" }, "example": { "balances": { "arbitrum_one": [ { "address": "0x6ab707Aca953eDAeFBc4fD23bA73294241490620", "balance": 1676.612954, "id": "usdt0", "market": "0x6ab707Aca953eDAeFBc4fD23bA73294241490620", "name": "Aave Arbitrum USDT", "price": 1, "price24hAgo": 1, "protocol": "AAVE_V3", "quoteTime": "2026-07-07T14:55:44.119Z", "symbol": "aArbUSDT", "type": "supplied", "underlyingAssetAddress": "0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9", "underlyingAssetID": "usdt0", "usd": 1676.612954 }, { "address": "0x724dc807b04555b71ed48a6896b6F41593b8C637", "balance": 29.871206, "id": "usd-coin", "market": "0x724dc807b04555b71ed48a6896b6F41593b8C637", "name": "Aave Arbitrum USDCn", "price": 1, "price24hAgo": 1, "protocol": "AAVE_V3", "quoteTime": "2026-07-07T14:55:39.964Z", "symbol": "aArbUSDCn", "type": "supplied", "underlyingAssetAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", "underlyingAssetID": "usd-coin", "usd": 29.871206 } ], "ethereum": [ { "address": "0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c", "balance": 10875.867582, "id": "usd-coin", "market": "0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c", "name": "Aave Ethereum USDC", "price": 1, "price24hAgo": 1, "protocol": "AAVE_V3", "quoteTime": "2026-07-07T14:55:39.964Z", "symbol": "aEthUSDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "usd": 10875.867582 }, { "address": "0x23878914EFE38d27C4D67Ab83ed1b93A74D4086a", "balance": 5673.819058, "id": "tether", "market": "0x23878914EFE38d27C4D67Ab83ed1b93A74D4086a", "name": "Aave Ethereum USDT", "price": 1, "price24hAgo": 1, "protocol": "AAVE_V3", "quoteTime": "2026-07-07T14:55:32.963Z", "symbol": "aEthUSDT", "type": "supplied", "underlyingAssetAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "underlyingAssetID": "tether", "usd": 5673.819058 } ] }, "entities": { "binance": { "crunchbase": "https://www.crunchbase.com/organization/binance", "description": "", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "populatedTags": [ { "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" }, { "disablePage": false, "excludeEntities": false, "id": "cex", "label": "Centralized Exchange", "rank": 50 } ], "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } }, "totalPositions": { "arbitrum_one": 1725.5757898151708, "ethereum": 18641.93066428793 } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/marketdata/altcoin_index": { "get": { "summary": "Get Altcoin Index", "description": "Returns the current Altcoin Index value, which measures altcoin performance relative to Bitcoin.", "operationId": "GetAltcoinIndexAPI", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAltcoinIndexResponse" } } } }, "500": { "description": "Internal Server Error" } } } }, "/networks/history/{chain}": { "get": { "summary": "Get historical data for a blockchain network", "description": "Retrieves the full daily price, volume, and market-cap history of a blockchain network's native token, from the token's launch to the latest available snapshot.", "operationId": "GetNetworkHistory", "parameters": [ { "name": "chain", "in": "path", "description": "The blockchain network identifier.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenHistoricalQuote" }, "example": [ { "marketCap": 15091573435.25, "time": "2019-03-30T00:00:00Z", "usd": 143.15, "volume24h": 6309182468.75 }, { "marketCap": 146718573462, "time": "2022-11-17T00:04:43.16Z", "usd": 1217.98, "volume24h": 8857864433 }, { "marketCap": 215157394830, "time": "2026-07-06T00:00:30.587Z", "usd": 1783.55, "volume24h": 10802375225 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/networks/status": { "get": { "summary": "Get current status for all blockchain networks", "description": "Retrieves the current status for all supported blockchain networks, including price, 24h price change, volume, market cap, latest block (tip), total transfers, and gas/fee information. Each network includes an \"asOf\" object giving the time each piece of data was last read; values are served from a cache refreshed about once per minute.", "operationId": "GetAllNetworkStatus", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NetworkStatus" }, "example": { "bitcoin": { "active": true, "asOf": { "fee": "2026-07-06T14:00:37.216437394Z", "price": "2026-07-06T14:00:37.212573416Z", "tip": "2026-07-06T14:00:37.214465232Z", "transfers": "2026-07-06T14:00:37.239063539Z" }, "chain": "bitcoin", "gasFee": null, "marketCap": 1239738051993, "price": 61828, "priceChange24h": -910, "priceChange24hPercent": -1.45, "satFee": 506, "tip": 956923, "tps": 0, "transfers": 7215875738, "volume": 27395894777 }, "ethereum": { "active": true, "asOf": { "fee": "2026-07-06T14:00:37.214666903Z", "price": "2026-07-06T14:00:37.212834121Z", "tip": "2026-07-06T14:00:37.214097043Z", "transfers": "2026-07-06T14:00:37.241411754Z" }, "chain": "ethereum", "gasFee": 1.13, "marketCap": 210742916805, "price": 1745.84, "priceChange24h": -18.71, "priceChange24hPercent": -1.06, "satFee": null, "tip": 25473954, "tps": 0, "transfers": 6082358603, "volume": 10129176757 } } } } } }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/activity": { "get": { "summary": "Polymarket activity feed", "description": "Returns a paginated feed of Polymarket trade and lifecycle events (trades, splits, merges, converts), newest first. Use `actions`, `eventType`, or `direction` to scope which event types are returned (`actions` can't be combined with the other two).", "operationId": "GetPolymarketActivity", "parameters": [ { "name": "userAddresses", "in": "query", "description": "Optional. Filter to specific Polymarket trade addresses.", "schema": { "type": "array", "items": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" }, "description": "Optional. Filter to specific Polymarket trade addresses.", "example": [ "0xBDDF61Af533fF524D27154e589d2D7A81510C684" ] } }, { "name": "conditionID", "in": "query", "description": "Optional. Filter to a single market condition ID (all of its outcome tokens).", "schema": { "type": "string", "description": "Optional. Filter to a single market condition ID (all of its outcome tokens).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" } }, { "name": "eventID", "in": "query", "description": "Optional. Filter to all markets and outcomes in a Polymarket event.", "schema": { "type": "integer", "description": "Optional. Filter to all markets and outcomes in a Polymarket event.", "nullable": true, "example": 30615 } }, { "name": "tokenAddresses", "in": "query", "description": "Optional. Filter to specific outcome token addresses. The conditionID, eventID, and tokenAddresses filters are intersected (a token must satisfy all provided).", "schema": { "type": "array", "items": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" }, "description": "Optional. Filter to specific outcome token addresses. The conditionID, eventID, and tokenAddresses filters are intersected (a token must satisfy all provided).", "example": [ "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" ] } }, { "name": "minUsd", "in": "query", "description": "Optional. Minimum notional (size * price) in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Minimum notional (size * price) in whole USD.", "nullable": true, "example": 100 } }, { "name": "maxUsd", "in": "query", "description": "Optional. Maximum notional (size * price) in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Maximum notional (size * price) in whole USD.", "nullable": true, "example": 1000 } }, { "name": "minPrice", "in": "query", "description": "Optional. Minimum per-share price as a 0-1 fraction.", "schema": { "type": "number", "description": "Optional. Minimum per-share price as a 0-1 fraction.", "nullable": true, "example": 0.25 } }, { "name": "maxPrice", "in": "query", "description": "Optional. Maximum per-share price as a 0-1 fraction.", "schema": { "type": "number", "description": "Optional. Maximum per-share price as a 0-1 fraction.", "nullable": true, "example": 0.75 } }, { "name": "minSize", "in": "query", "description": "Optional. Minimum trade size in whole outcome-token shares.", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Minimum trade size in whole outcome-token shares.", "nullable": true, "example": 10 } }, { "name": "maxSize", "in": "query", "description": "Optional. Maximum trade size in whole outcome-token shares.", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Maximum trade size in whole outcome-token shares.", "nullable": true, "example": 500 } }, { "name": "actions", "in": "query", "description": "Optional. Filter to one or more actions: buy, sell, split, merge, convert. Cannot be combined with eventType or direction.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketActivityAction" }, "description": "Optional. Filter to one or more actions: buy, sell, split, merge, convert. Cannot be combined with eventType or direction.", "example": [ "buy" ] } }, { "name": "eventType", "in": "query", "description": "Optional. Filter by event class: trade, split, merge, or convert. Use direction to narrow trades to one side.", "schema": { "$ref": "#/components/schemas/PolymarketActivityEventType" } }, { "name": "direction", "in": "query", "description": "Optional. Narrow trades to one side: buy or sell. Only valid with eventType=trade (or no eventType).", "schema": { "$ref": "#/components/schemas/PolymarketActivityDirection" } }, { "name": "startTime", "in": "query", "description": "Optional. Unix timestamp in seconds for the start of the range (inclusive).", "schema": { "type": "integer", "description": "Optional. Unix timestamp in seconds for the start of the range (inclusive).", "nullable": true, "example": 1717200000 } }, { "name": "endTime", "in": "query", "description": "Optional. Unix timestamp in seconds for the end of the range (exclusive).", "schema": { "type": "integer", "description": "Optional. Unix timestamp in seconds for the end of the range (exclusive).", "nullable": true, "example": 1719878400 } }, { "name": "limit", "in": "query", "description": "Max results (default 50, max 500).", "schema": { "type": "integer", "description": "Max results (default 50, max 500).", "example": 50 } }, { "name": "offset", "in": "query", "description": "Offset for pagination (default 0).", "schema": { "type": "integer", "description": "Offset for pagination (default 0).", "example": 0 } }, { "name": "fastPagination", "in": "query", "description": "Fast pagination defaults to true. When enabled, totalCount is only large enough to determine whether another page exists; set false to count matches up to 10,000.", "schema": { "type": "boolean", "description": "Fast pagination defaults to true. When enabled, totalCount is only large enough to determine whether another page exists; set false to count matches up to 10,000.", "default": true, "nullable": true, "example": true } }, { "name": "sortBy", "in": "query", "description": "Column to order by: time (default), size (outcome-token shares), price (cents-per-share), usd (notional).", "schema": { "$ref": "#/components/schemas/PolymarketActivitySortBy" } }, { "name": "sortOrder", "in": "query", "description": "Sort direction: asc or desc (default).", "schema": { "$ref": "#/components/schemas/SortDir" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketActivityResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/event-positions/{conditionId}": { "get": { "summary": "Polymarket positions in a market", "description": "Returns holders and their positions for a market's outcome tokens — one row per user and token, with shares, price, value, and PnL.", "operationId": "GetPolymarketEventPositions", "parameters": [ { "name": "tokenAddresses", "in": "query", "description": "Optional. Explicit outcome token list; overrides condition-derived tokens and can span markets beyond the path conditionId.", "schema": { "type": "array", "items": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" }, "description": "Optional. Explicit outcome token list; overrides condition-derived tokens and can span markets beyond the path conditionId.", "example": [ "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" ] } }, { "name": "userAddresses", "in": "query", "description": "Optional. Filter to specific Polymarket trade addresses.", "schema": { "type": "array", "items": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" }, "description": "Optional. Filter to specific Polymarket trade addresses.", "example": [ "0xBDDF61Af533fF524D27154e589d2D7A81510C684" ] } }, { "name": "outcome", "in": "query", "description": "Optional. 0 for Yes token, 1 for No token.", "schema": { "type": "integer", "description": "Optional. 0 for Yes token, 1 for No token.", "nullable": true, "example": 1 } }, { "name": "minShares", "in": "query", "description": "Optional. Minimum held shares (whole outcome-token shares).", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Minimum held shares (whole outcome-token shares).", "nullable": true, "example": 10 } }, { "name": "maxShares", "in": "query", "description": "Optional. Maximum held shares (whole outcome-token shares).", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Maximum held shares (whole outcome-token shares).", "nullable": true, "example": 500 } }, { "name": "minValue", "in": "query", "description": "Optional. Minimum current position value in whole USD.", "schema": { "type": "integer", "description": "Optional. Minimum current position value in whole USD.", "nullable": true, "example": 100 } }, { "name": "maxValue", "in": "query", "description": "Optional. Maximum current position value in whole USD.", "schema": { "type": "integer", "description": "Optional. Maximum current position value in whole USD.", "nullable": true, "example": 1000 } }, { "name": "minPnl", "in": "query", "description": "Optional. Minimum PnL in whole USD (can be negative).", "schema": { "type": "integer", "description": "Optional. Minimum PnL in whole USD (can be negative).", "nullable": true, "example": -100 } }, { "name": "maxPnl", "in": "query", "description": "Optional. Maximum PnL in whole USD (can be negative).", "schema": { "type": "integer", "description": "Optional. Maximum PnL in whole USD (can be negative).", "nullable": true, "example": 500 } }, { "name": "sortBy", "in": "query", "description": "Optional. \"pnl\" (default), \"shares\", or \"value\".", "schema": { "$ref": "#/components/schemas/PolymarketEventPositionsSortBy" } }, { "name": "sortOrder", "in": "query", "description": "Optional. \"asc\" or \"desc\" (default).", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Max results (default 50, max 1000).", "schema": { "type": "integer", "description": "Max results (default 50, max 1000).", "example": 50 } }, { "name": "offset", "in": "query", "description": "Offset for pagination (default 0).", "schema": { "type": "integer", "description": "Offset for pagination (default 0).", "example": 0 } }, { "name": "conditionId", "in": "path", "description": "Required. Polymarket condition ID.", "required": true, "schema": { "type": "string", "description": "Required. Polymarket condition ID.", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketEventPositionsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/events": { "get": { "summary": "List Polymarket events", "description": "Returns a filtered, paginated list of Polymarket events, each with a few top-market previews and current prices. Set groupGames=true to represent each sporting fixture by its winner event.", "operationId": "GetPolymarketEvents", "parameters": [ { "name": "tag", "in": "query", "description": "Optional. Filter by event tag. Matches lowercase Polymarket tags case-insensitively.", "schema": { "type": "string", "description": "Optional. Filter by event tag. Matches lowercase Polymarket tags case-insensitively.", "example": "crypto" } }, { "name": "excludeTag", "in": "query", "description": "Optional. Exclude events carrying this tag (case-insensitive).", "schema": { "type": "string", "description": "Optional. Exclude events carrying this tag (case-insensitive).", "example": "sports" } }, { "name": "active", "in": "query", "description": "Optional. Filter to active events — not closed and not ended (true/false).", "schema": { "type": "boolean", "description": "Optional. Filter to active events — not closed and not ended (true/false).", "nullable": true, "example": true } }, { "name": "search", "in": "query", "description": "Optional. Search event titles, market questions, and grouped-market titles.", "schema": { "type": "string", "description": "Optional. Search event titles, market questions, and grouped-market titles.", "example": "bitcoin" } }, { "name": "groupGames", "in": "query", "description": "Optional. When true, return one winner event per sporting fixture instead of each related event. Default: false.", "schema": { "type": "boolean", "description": "Optional. When true, return one winner event per sporting fixture instead of each related event. Default: false.", "example": true } }, { "name": "sortBy", "in": "query", "description": "Optional. Sort field: volume, endDate, or createdAt. Default: volume when no tag, endDate when tag is set.", "schema": { "$ref": "#/components/schemas/PolymarketEventSortBy" } }, { "name": "order", "in": "query", "description": "Sort order: asc or desc. Default: desc.", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Max events to return (1-100). Default: 50.", "schema": { "type": "integer", "description": "Max events to return (1-100). Default: 50.", "example": 50 } }, { "name": "offset", "in": "query", "description": "Pagination offset. Default: 0.", "schema": { "type": "integer", "description": "Pagination offset. Default: 0.", "example": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketEventsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/events/{eventId}": { "get": { "summary": "Get a Polymarket event", "description": "Returns a single Polymarket event by its event ID, along with every active or resolved market in the event. Each market includes its outcomes, current Yes price, 24h volume, and resolution status. Returns 404 if the event does not exist.", "operationId": "GetPolymarketEvent", "parameters": [ { "name": "eventId", "in": "path", "description": "Required. Polymarket event ID.", "required": true, "schema": { "type": "integer", "description": "Required. Polymarket event ID.", "example": 30615 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketEventResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/leaderboard": { "get": { "summary": "Polymarket PnL leaderboard", "description": "Returns the Polymarket total-PnL leaderboard (realized plus unrealized) for a period: 1d, 1w, 1m, or all (default 1d). Order desc for top traders or asc for worst. Pass an address to also receive that trader's rank.", "operationId": "GetPolymarketLeaderboard", "parameters": [ { "name": "period", "in": "query", "description": "Time period: 1d, 1w, 1m, all. Default: 1d", "schema": { "$ref": "#/components/schemas/PolymarketLeaderboardPeriod" } }, { "name": "order", "in": "query", "description": "Sort order: desc (top traders) or asc (worst traders). Default: desc", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Max entries (1-200). Default: 100", "schema": { "type": "integer", "description": "Max entries (1-200). Default: 100", "example": 100 } }, { "name": "offset", "in": "query", "description": "Pagination offset. Default: 0", "schema": { "type": "integer", "description": "Pagination offset. Default: 0", "example": 0 } }, { "name": "address", "in": "query", "description": "Optional trade address. If set, also returns this user's rank.", "schema": { "type": "string", "description": "Optional trade address. If set, also returns this user's rank.", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketLeaderboardResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/order-book/{conditionId}": { "get": { "summary": "Polymarket order book", "description": "Returns the live CLOB order book for each of a market's outcome tokens: bids, asks, and last trade price per side. Returns 404 when the conditionID has no matching tokens.", "operationId": "GetPolymarketOrderBook", "parameters": [ { "name": "conditionId", "in": "path", "description": "Required. Polymarket condition ID for the market.", "required": true, "schema": { "type": "string", "description": "Required. Polymarket condition ID for the market.", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketOrderBookResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/pnl/chart": { "get": { "summary": "Polymarket PnL chart", "description": "Returns a time series of cumulative PnL for a trade address — portfolio-wide, or for a single market when `conditionID` is set. Window follows the `period` preset or an explicit `startTime`/`endTime` range.", "operationId": "GetPolymarketPnLChart", "parameters": [ { "name": "userAddress", "in": "query", "description": "Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, { "name": "conditionID", "in": "query", "description": "Optional. Market condition ID (0x-prefixed bytes32 hex). Aggregates across all outcome tokens. Omit for portfolio-level PnL.", "schema": { "type": "string", "description": "Optional. Market condition ID (0x-prefixed bytes32 hex). Aggregates across all outcome tokens. Omit for portfolio-level PnL.", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" } }, { "name": "period", "in": "query", "description": "Time period: 24h, 7d, 30d, all. Presets auto-shrink to the wallet's available history; all is portfolio-only. Default: 30d", "schema": { "$ref": "#/components/schemas/PolymarketPnLPeriod" } }, { "name": "startTime", "in": "query", "description": "Optional Unix timestamp in seconds for start of range. Not supported with period=all. Condition-level custom ranges must be 30 days or less; all condition-level fixed windows must start within the last 30 days.", "schema": { "type": "integer", "description": "Optional Unix timestamp in seconds for start of range. Not supported with period=all. Condition-level custom ranges must be 30 days or less; all condition-level fixed windows must start within the last 30 days.", "nullable": true, "example": 1717200000 } }, { "name": "endTime", "in": "query", "description": "Optional Unix timestamp in seconds for end of range. For conditionID requests, preset windows derived from endTime must start within the last 30 days.", "schema": { "type": "integer", "description": "Optional Unix timestamp in seconds for end of range. For conditionID requests, preset windows derived from endTime must start within the last 30 days.", "nullable": true, "example": 1719878400 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketPnLChartResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/positions/{addr}": { "get": { "summary": "Polymarket user positions", "description": "Returns a trade address's current open positions, one row per outcome token, with net position, net USDC flow, last price, and unrealized PnL. Sort by trades (default), shares, value, or pnl. Supports offset pagination.", "operationId": "GetPolymarketPositions", "parameters": [ { "name": "sortBy", "in": "query", "description": "Column to order by: trades (default), shares, value, pnl.", "schema": { "$ref": "#/components/schemas/PolymarketPositionsSortBy" } }, { "name": "sortOrder", "in": "query", "description": "Sort direction: asc or desc (default).", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Max results (default 50, max 1000).", "schema": { "type": "integer", "description": "Max results (default 50, max 1000).", "example": 50 } }, { "name": "offset", "in": "query", "description": "Offset for pagination (default 0).", "schema": { "type": "integer", "description": "Offset for pagination (default 0).", "example": 0 } }, { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketPositionsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/prices": { "get": { "summary": "Polymarket price history", "description": "Returns a midprice time series for a single Polymarket outcome token, identified by either `tokenAddress` or `conditionID` (not both).", "operationId": "GetPolymarketPrices", "parameters": [ { "name": "tokenAddress", "in": "query", "description": "Polymarket token address (0x-prefixed hex). Provide exactly one of tokenAddress or conditionID.", "schema": { "type": "string", "description": "Polymarket token address (0x-prefixed hex). Provide exactly one of tokenAddress or conditionID.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } }, { "name": "conditionID", "in": "query", "description": "Market condition ID (0x-prefixed bytes32 hex). Returns prices for the first outcome (outcome_index=0) token. Provide exactly one of tokenAddress or conditionID.", "schema": { "type": "string", "description": "Market condition ID (0x-prefixed bytes32 hex). Returns prices for the first outcome (outcome_index=0) token. Provide exactly one of tokenAddress or conditionID.", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" } }, { "name": "interval", "in": "query", "description": "Price interval: 1s, 5s, 1m, 1h, 1d, auto. Default: 1h. 1s and 5s require startTime and endTime, with a maximum 2-hour span, and return a dense series carrying the last price forward across quiet periods.", "schema": { "$ref": "#/components/schemas/PolymarketPriceInterval" } }, { "name": "range", "in": "query", "description": "Window selector anchored on the token's last bucket: 1d, 1w, 1m, all. Server picks the granularity. Overrides startTime, endTime and interval except interval=1s or interval=5s, which cannot be combined with range.", "schema": { "$ref": "#/components/schemas/PolymarketPriceRange" } }, { "name": "startTime", "in": "query", "description": "Optional Unix timestamp in seconds for start of range. Ignored when range is set.", "schema": { "type": "integer", "description": "Optional Unix timestamp in seconds for start of range. Ignored when range is set.", "nullable": true, "example": 1717200000 } }, { "name": "endTime", "in": "query", "description": "Optional Unix timestamp in seconds for end of range. Ignored when range is set.", "schema": { "type": "integer", "description": "Optional Unix timestamp in seconds for end of range. Ignored when range is set.", "nullable": true, "example": 1719878400 } }, { "name": "limit", "in": "query", "description": "Max number of price points to return (1-7500). Default: 500, or 7500 for interval=1s and interval=5s. When the requested window holds more points than limit, the newest points are returned.", "schema": { "type": "integer", "description": "Max number of price points to return (1-7500). Default: 500, or 7500 for interval=1s and interval=5s. When the requested window holds more points than limit, the newest points are returned.", "example": 500 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketPricesResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/stats": { "get": { "summary": "Polymarket platform stats", "description": "Returns global Polymarket platform statistics: total volume, 24h volume, total traders, active and resolved market counts, and total trades.", "operationId": "GetPolymarketStats", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketStatsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/top-events": { "get": { "summary": "Polymarket top events leaderboard", "description": "Returns the top (trader, event) entries by PnL for a period: 1d, 1w, 1m, or all (default 1d). Each entry sums a trader's PnL across every market within a single Polymarket event. Order desc for top wins or asc for top losses.", "operationId": "GetPolymarketTopEvents", "parameters": [ { "name": "period", "in": "query", "description": "Time period: 1d, 1w, 1m, all. Default: 1d", "schema": { "$ref": "#/components/schemas/PolymarketLeaderboardPeriod" } }, { "name": "order", "in": "query", "description": "Sort order: desc (top wins) or asc (top losses). Default: desc", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Max entries (1-200). Default: 100", "schema": { "type": "integer", "description": "Max entries (1-200). Default: 100", "example": 100 } }, { "name": "offset", "in": "query", "description": "Pagination offset. Default: 0", "schema": { "type": "integer", "description": "Pagination offset. Default: 0", "example": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketTopEventEntry" }, "example": [ { "eventId": 511447, "eventTitle": "Belgium vs. IR Iran - More Markets", "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/soccer ball-bba4025f77.png", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/soccer ball-bba4025f77.png", "periodPnl": "1242863.7688589205", "rank": 1, "tradeCount": 3311, "userAddress": "0x204f72f35326db932158CBA6AdfF0B9A1DA95e14" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/top-events/{eventId}/breakdown": { "get": { "summary": "Polymarket top event breakdown", "description": "Returns the per-market PnL breakdown for a single trader within one event over a period (1d, 1w, 1m, all; default 1d). Each row is one market in the event with its PnL and trade count; markets with exactly zero PnL are omitted. The address query parameter is required.", "operationId": "GetPolymarketTopEventBreakdown", "parameters": [ { "name": "address", "in": "query", "description": "Polymarket trader address.", "required": true, "schema": { "type": "string", "description": "Polymarket trader address.", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, { "name": "period", "in": "query", "description": "Period: 1d, 1w, 1m, all. Default: 1d.", "schema": { "$ref": "#/components/schemas/PolymarketLeaderboardPeriod" } }, { "name": "eventId", "in": "path", "description": "Polymarket event ID.", "required": true, "schema": { "type": "integer", "description": "Polymarket event ID.", "example": 30615 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketTopEventBreakdownResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/top-holders/{conditionId}": { "get": { "summary": "Polymarket market top holders", "description": "Returns the largest position holders for a market, ranked by net position, each with their per-token positions and net USDC flow. Optionally narrow to a single outcome (0 for Yes, 1 for No). Returns 404 when the conditionID has no matching tokens.", "operationId": "GetPolymarketTopHolders", "parameters": [ { "name": "limit", "in": "query", "description": "Max entries to return (1-100). Default: 20.", "schema": { "type": "integer", "description": "Max entries to return (1-100). Default: 20.", "example": 100 } }, { "name": "outcome", "in": "query", "description": "Optional. 0 for Yes token, 1 for No token. Omit for all tokens.", "schema": { "type": "integer", "description": "Optional. 0 for Yes token, 1 for No token. Omit for all tokens.", "nullable": true, "example": 0 } }, { "name": "conditionId", "in": "path", "description": "Required. Polymarket condition ID for the market.", "required": true, "schema": { "type": "string", "description": "Required. Polymarket condition ID for the market.", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketTopHoldersResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/wallet/{addr}/prediction-history": { "get": { "summary": "Polymarket prediction history", "description": "Returns every market a trade address has traded — one row per outcome token, with volume, value, buy/sell totals, PnL, shares, and resolution status.", "operationId": "GetPolymarketPredictionHistory", "parameters": [ { "name": "limit", "in": "query", "description": "Results per page (1-100, default 20).", "schema": { "type": "integer", "description": "Results per page (1-100, default 20).", "example": 20 } }, { "name": "offset", "in": "query", "description": "Offset for pagination (default 0).", "schema": { "type": "integer", "description": "Offset for pagination (default 0).", "example": 0 } }, { "name": "sort", "in": "query", "description": "Sort field: value, volume, currentPrice, trades, pnl, shares, buyUsd, avgBuy, sellUsd, avgSell. Default: pnl. When status=closed, the value and currentPrice sort options are not available.", "schema": { "type": "string", "description": "Sort field: value, volume, currentPrice, trades, pnl, shares, buyUsd, avgBuy, sellUsd, avgSell. Default: pnl. When status=closed, the value and currentPrice sort options are not available.", "example": "pnl" } }, { "name": "order", "in": "query", "description": "Sort order: asc or desc. Default: desc.", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "conditionID", "in": "query", "description": "Optional. Filter to a single market condition ID.", "schema": { "type": "string", "description": "Optional. Filter to a single market condition ID.", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" } }, { "name": "eventID", "in": "query", "description": "Optional. Filter to all markets and outcomes in a Polymarket event.", "schema": { "type": "integer", "description": "Optional. Filter to all markets and outcomes in a Polymarket event.", "nullable": true, "example": 30615 } }, { "name": "tokenAddresses", "in": "query", "description": "Optional. Filter to specific outcome token addresses.", "schema": { "type": "array", "items": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" }, "description": "Optional. Filter to specific outcome token addresses.", "example": [ "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" ] } }, { "name": "search", "in": "query", "description": "Optional. Search market question, group title, event title, or condition ID.", "schema": { "type": "string", "description": "Optional. Search market question, group title, event title, or condition ID.", "example": "bitcoin" } }, { "name": "minTrades", "in": "query", "description": "Optional. Minimum trade count.", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Minimum trade count.", "nullable": true, "example": 1 } }, { "name": "maxTrades", "in": "query", "description": "Optional. Maximum trade count.", "schema": { "minimum": 0, "type": "integer", "description": "Optional. Maximum trade count.", "nullable": true, "example": 100 } }, { "name": "minVolume", "in": "query", "description": "Minimum total volume in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Minimum total volume in whole USD.", "nullable": true, "example": 100 } }, { "name": "maxVolume", "in": "query", "description": "Maximum total volume in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Maximum total volume in whole USD.", "nullable": true, "example": 10000 } }, { "name": "minValue", "in": "query", "description": "Minimum current held value in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Minimum current held value in whole USD.", "nullable": true, "example": 100 } }, { "name": "maxValue", "in": "query", "description": "Maximum current held value in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Maximum current held value in whole USD.", "nullable": true, "example": 10000 } }, { "name": "minCurrentPrice", "in": "query", "description": "Minimum current price as a 0-1 fraction.", "schema": { "type": "number", "description": "Minimum current price as a 0-1 fraction.", "nullable": true, "example": 0.25 } }, { "name": "maxCurrentPrice", "in": "query", "description": "Maximum current price as a 0-1 fraction.", "schema": { "type": "number", "description": "Maximum current price as a 0-1 fraction.", "nullable": true, "example": 0.75 } }, { "name": "minPnl", "in": "query", "description": "Minimum PnL in whole USD (can be negative).", "schema": { "type": "integer", "description": "Minimum PnL in whole USD (can be negative).", "nullable": true, "example": -100 } }, { "name": "maxPnl", "in": "query", "description": "Maximum PnL in whole USD (can be negative).", "schema": { "type": "integer", "description": "Maximum PnL in whole USD (can be negative).", "nullable": true, "example": 500 } }, { "name": "minTotalBuyUsdc", "in": "query", "description": "Minimum total buy amount in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Minimum total buy amount in whole USD.", "nullable": true, "example": 100 } }, { "name": "maxTotalBuyUsdc", "in": "query", "description": "Maximum total buy amount in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Maximum total buy amount in whole USD.", "nullable": true, "example": 10000 } }, { "name": "minAvgBuyPrice", "in": "query", "description": "Minimum average buy price as a 0-1 fraction.", "schema": { "type": "number", "description": "Minimum average buy price as a 0-1 fraction.", "nullable": true, "example": 0.25 } }, { "name": "maxAvgBuyPrice", "in": "query", "description": "Maximum average buy price as a 0-1 fraction.", "schema": { "type": "number", "description": "Maximum average buy price as a 0-1 fraction.", "nullable": true, "example": 0.75 } }, { "name": "minTotalSellUsdc", "in": "query", "description": "Minimum total sell amount in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Minimum total sell amount in whole USD.", "nullable": true, "example": 100 } }, { "name": "maxTotalSellUsdc", "in": "query", "description": "Maximum total sell amount in whole USD.", "schema": { "minimum": 0, "type": "integer", "description": "Maximum total sell amount in whole USD.", "nullable": true, "example": 10000 } }, { "name": "minAvgSellPrice", "in": "query", "description": "Minimum average sell price as a 0-1 fraction.", "schema": { "type": "number", "description": "Minimum average sell price as a 0-1 fraction.", "nullable": true, "example": 0.25 } }, { "name": "maxAvgSellPrice", "in": "query", "description": "Maximum average sell price as a 0-1 fraction.", "schema": { "type": "number", "description": "Maximum average sell price as a 0-1 fraction.", "nullable": true, "example": 0.75 } }, { "name": "minSharesHeld", "in": "query", "description": "Minimum remaining held shares in whole shares.", "schema": { "minimum": 0, "type": "integer", "description": "Minimum remaining held shares in whole shares.", "nullable": true, "example": 10 } }, { "name": "maxSharesHeld", "in": "query", "description": "Maximum remaining held shares in whole shares.", "schema": { "minimum": 0, "type": "integer", "description": "Maximum remaining held shares in whole shares.", "nullable": true, "example": 500 } }, { "name": "status", "in": "query", "description": "Optional. Filter by position state: open or closed.", "schema": { "type": "string", "description": "Optional. Filter by position state: open or closed.", "example": "open" } }, { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketPredictionHistoryResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/wallet/{addr}/summary/balance": { "get": { "summary": "Polymarket wallet USDC balance", "description": "Returns a trade address's current Polygon USDC cash balance (the collateral used for Polymarket trading).", "operationId": "GetPolymarketWalletSummaryBalance", "parameters": [ { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketWalletSummaryBalanceResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/wallet/{addr}/summary/biggest-win": { "get": { "summary": "Polymarket wallet biggest win", "description": "Returns a trade address's single largest realized win, in USDC, across all resolved Polymarket markets.", "operationId": "GetPolymarketWalletSummaryBiggestWin", "parameters": [ { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketWalletSummaryBiggestWinResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/wallet/{addr}/summary/pnl": { "get": { "summary": "Polymarket wallet PnL summary", "description": "Returns a trade address's total PnL (open-position plus all-time realized), realized PnL, and counts of unique, won, and total markets traded.", "operationId": "GetPolymarketWalletSummaryPnL", "parameters": [ { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketWalletSummaryPnLResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/wallet/{addr}/summary/portfolio": { "get": { "summary": "Polymarket wallet portfolio", "description": "Returns live portfolio state for a trade address: unrealized PnL, total open-position value, and the number of open positions and markets.", "operationId": "GetPolymarketWalletPortfolio", "parameters": [ { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketWalletPortfolioResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/wallet/{addr}/summary/stats": { "get": { "summary": "Polymarket wallet trading stats", "description": "Returns lifetime trading stats for a trade address: total volume, total fees, total trades, total events, and the timestamp of first activity.", "operationId": "GetPolymarketWalletSummaryStats", "parameters": [ { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketWalletSummaryStatsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/polymarket/wallet/{addr}/tags": { "get": { "summary": "", "description": "", "operationId": "GetPolymarketWalletTags", "parameters": [ { "name": "limit", "in": "query", "description": "Max tags to return, ranked by gross volume. Default 10, max 50.", "schema": { "type": "integer", "description": "Max tags to return, ranked by gross volume. Default 10, max 50.", "example": 1 } }, { "name": "addr", "in": "path", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "required": true, "schema": { "type": "string", "description": "Required. Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolymarketWalletTagsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/portfolio/address/{address}": { "get": { "summary": "Get address portfolio history", "description": "Retrieves historical portfolio snapshots for the specified address across chains, for the UTC day containing the given time. The response is keyed by chain, then by token pricing ID.", "operationId": "GetAddressPortfolioHistory", "parameters": [ { "name": "time", "in": "query", "description": "Unix timestamp in milliseconds for the historical snapshot. The time is truncated to the start of the UTC day.", "required": true, "schema": { "type": "string", "description": "Unix timestamp in milliseconds for the historical snapshot. The time is truncated to the start of the UTC day.", "example": "1704067200000" } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bsc'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query portfolio history for.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query portfolio history for.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PortfolioEntry" }, "example": { "abc123": { "balance": 1500.5, "id": "usd-coin", "name": "USD Coin", "price": 1, "symbol": "USDC", "usd": 1500.5 } } }, "example": { "bsc": { "1inch": { "balance": 1112.6200000000001, "id": "1inch", "name": "1INCH", "price": 0.45496, "symbol": "1inch", "usd": 506.1975952 }, "alchemy-pay": { "balance": 10, "id": "alchemy-pay", "name": "Alchemy Pay", "price": 0.02132812, "symbol": "ach", "usd": 0.2132812 } }, "ethereum": { "0x": { "balance": 10032515.845947504, "id": "0x", "name": "0x Protocol", "price": 0.369874, "symbol": "zrx", "usd": 3710766.766003987 }, "1inch": { "balance": 6065867.718795477, "id": "1inch", "name": "1INCH", "price": 0.45496, "symbol": "1inch", "usd": 2759727.17734319 } } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/portfolio/entity/{entity}": { "get": { "summary": "Get entity portfolio history", "description": "Retrieves historical portfolio snapshots for the specified entity across chains, for the UTC day containing the given time. The response is keyed by chain, then by token pricing ID.", "operationId": "GetEntityPortfolioHistory", "parameters": [ { "name": "time", "in": "query", "description": "Unix timestamp in milliseconds for the historical snapshot. The time is truncated to the start of the UTC day.", "required": true, "schema": { "type": "string", "description": "Unix timestamp in milliseconds for the historical snapshot. The time is truncated to the start of the UTC day.", "example": "1704067200000" } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,bsc'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "entity", "in": "path", "description": "The entity ID to query portfolio history for. Accepts an Arkham entity ID or a user entity ID.", "required": true, "schema": { "type": "string", "description": "The entity ID to query portfolio history for. Accepts an Arkham entity ID or a user entity ID.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PortfolioEntry" }, "example": { "abc123": { "balance": 1500.5, "id": "usd-coin", "name": "USD Coin", "price": 1, "symbol": "USDC", "usd": 1500.5 } } }, "example": { "bsc": { "2049": { "balance": 120000, "id": "2049", "name": "2049", "price": 0.01338244, "symbol": "2049", "usd": 1605.8928 }, "aave": { "balance": 311773.5865450922, "id": "aave", "name": "Aave", "price": 109.13, "symbol": "aave", "usd": 34023851.499665916 } }, "ethereum": { "0x": { "balance": 72450011.27241233, "id": "0x", "name": "0x Protocol", "price": 0.369874, "symbol": "zrx", "usd": 26797375.469372235 }, "1inch": { "balance": 134991020.98849133, "id": "1inch", "name": "1INCH", "price": 0.45496, "symbol": "1inch", "usd": 61415514.90892401 } } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/portfolio/timeSeries/address/{address}": { "get": { "summary": "Get daily time series data for an address's token", "description": "Returns daily snapshots (in UTC) of the specified address's holdings of a given token. The response is keyed by day (UTC timestamp), then by chain, then by token pricing ID.", "operationId": "GetAddressPortfolioHistoryTimeSeries", "parameters": [ { "name": "pricingId", "in": "query", "description": "The CoinGecko pricing ID of the token to track.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token to track.", "example": "ethereum" } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,arbitrum_one'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query time series data for.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query time series data for.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PortfolioEntry" }, "example": { "abc123": { "balance": 1500.5, "id": "usd-coin", "name": "USD Coin", "price": 1, "symbol": "USDC", "usd": 1500.5 } } }, "example": { "abc123": { "abc123": { "balance": 1500.5, "id": "usd-coin", "name": "USD Coin", "price": 1, "symbol": "USDC", "usd": 1500.5 } } } }, "example": { "2024-11-06T00:00:00Z": { "arbitrum_one": { "ethereum": { "balance": 0.157982385858176, "id": "ethereum", "name": "Ethereum", "price": 2423.42, "symbol": "eth", "usd": 382.8576735364209 } }, "ethereum": { "ethereum": { "balance": 75113.401952444, "id": "ethereum", "name": "Ethereum", "price": 2423.42, "symbol": "eth", "usd": 182031320.55959183 } } } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/portfolio/timeSeries/entity/{entity}": { "get": { "summary": "Get daily time series data for an entity's token", "description": "Returns daily snapshots (in UTC) of the specified entity's holdings of a given token. The response is keyed by day (UTC timestamp), then by chain, then by token pricing ID.", "operationId": "GetEntityPortfolioHistoryTimeSeries", "parameters": [ { "name": "pricingId", "in": "query", "description": "The CoinGecko pricing ID of the token to track.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token to track.", "example": "ethereum" } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,arbitrum_one'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "entity", "in": "path", "description": "The entity ID to query time series data for. Accepts an Arkham entity ID or a user entity ID.", "required": true, "schema": { "type": "string", "description": "The entity ID to query time series data for. Accepts an Arkham entity ID or a user entity ID.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PortfolioEntry" }, "example": { "abc123": { "balance": 1500.5, "id": "usd-coin", "name": "USD Coin", "price": 1, "symbol": "USDC", "usd": 1500.5 } } }, "example": { "abc123": { "abc123": { "balance": 1500.5, "id": "usd-coin", "name": "USD Coin", "price": 1, "symbol": "USDC", "usd": 1500.5 } } } }, "example": { "2023-07-19T00:00:00Z": { "arbitrum_one": { "ethereum": { "balance": 111662.52500999894, "id": "ethereum", "name": "Ethereum", "price": 1897.72, "symbol": "eth", "usd": 211904206.9619752 } }, "ethereum": { "ethereum": { "balance": 3974214.8732396006, "id": "ethereum", "name": "Ethereum", "price": 1897.72, "symbol": "eth", "usd": 7541947049.244255 } } } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/risk/address/batch": { "post": { "summary": "Get risk scores for multiple addresses in one request", "description": "Batched version of GET /risk/address/:address. Accepts up to 200 addresses and returns a map keyed by the address the caller sent.", "operationId": "GetRiskScoreAddressBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRiskScoreAddressBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RiskScoreResponse" }, "example": { "abc123": { "address": "0x6068A806a62DBb6a42E1A83e17E249bF4f8dB3aB", "chain_type": "evm", "darkweb_score": 0, "gambling_score": 0, "greatest_risk_category": "hacker", "greatest_risk_category_backward": "abc123", "greatest_risk_category_forward": "hacker", "hacker_score": 66, "hop_distance": 1, "is_seed": false, "max_hop_reached": 1, "max_score": 66, "max_score_backward": 0, "max_score_forward": 66, "mixed_kyc_service_score": 0, "mixer_score": 0, "non_kyc_service_score": 0, "ponzi_score": 0, "privacy_score": 0, "ransomware_score": 0, "risk_level": "HIGH", "risk_weighted_incoming_usd": 1503.02, "risk_weighted_outgoing_usd": 0, "sanctioned_1hop_score": 0, "sanctions_score": 0, "scam_score": 0, "token_blacklist_score": 0, "top_sources": [ { "contribution_pct": 100, "contribution_usd": 1503.02, "direction": "forward", "first_ts": "2019-11-14T00:00:00Z", "hop_distance": 1, "last_ts": "2019-12-13T00:00:00Z", "risk_category": "hacker", "seed_address": "0x851d8fe098341d5592DbBC7bCd4388F73c16291b" } ], "updated_at": "2025-12-16T03:06:14Z" } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/risk/address/{address}": { "get": { "summary": "Get risk score for an address", "description": "Returns a compliance risk score for the specified blockchain address, including exposure categories and risk factors.", "operationId": "GetRiskScoreAddress", "parameters": [ { "name": "address", "in": "path", "description": "The blockchain address to query.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query.", "example": "0x6068A806a62DBb6a42E1A83e17E249bF4f8dB3aB" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskScoreResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/risk/address/{address}/paths": { "get": { "summary": "Get seed-to-target paths for an address's risk score", "description": "Returns the dominant address chains linking the queried address back to each risky seed. Results are rolled up by chain_type (EVM chains collapse to 'evm').", "operationId": "GetRiskScoreAddressPaths", "parameters": [ { "name": "address", "in": "path", "description": "The blockchain address to trace.", "required": true, "schema": { "type": "string", "description": "The blockchain address to trace.", "example": "0x6068A806a62DBb6a42E1A83e17E249bF4f8dB3aB" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRiskScoreAddressPathsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/risk/entity/batch": { "post": { "summary": "Get risk scores for multiple entities in one request", "description": "Batched version of GET /risk/entity/:entity_id. Accepts up to 200 entity IDs and returns a map keyed by entity ID.", "operationId": "GetRiskScoreEntityBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRiskScoreEntityBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RiskScoreEntityResponse" }, "example": { "abc123": { "darkweb_score": 1, "entity_id": "binance", "entity_name": "Binance", "entity_type": "exchange", "gambling_score": 1, "greatest_risk_category": "hacker", "greatest_risk_category_backward": "abc123", "greatest_risk_category_forward": "abc123", "hacker_score": 1, "highest_risk_address": "abc123", "max_score": 66, "max_score_backward": 1, "max_score_forward": 1, "mixed_kyc_service_score": 1, "mixer_score": 1, "non_kyc_service_score": 1, "ponzi_score": 1, "privacy_score": 1, "ransomware_score": 1, "risk_level": "HIGH", "risky_addresses": 3, "risky_addresses_backward": 1, "risky_addresses_forward": 1, "sanctions_score": 1, "scam_score": 1, "seed_addresses": 1, "token_blacklist_score": 1, "top_seed_addresses": [ { "address": "abc123", "chain_type": "evm", "risk_category": "mixed-kyc-service", "seed_score": 30 } ], "top_sources": [ { "contribution_usd": 1.23, "direction": "forward", "hop_distance": 1, "risk_category": "hacker", "seed_address": "abc123" } ], "updated_at": "abc123" } } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/risk/entity/{entity_id}": { "get": { "summary": "Get entity-level risk score", "description": "Returns the aggregated risk score for an entity, computed as the maximum across all of the entity's addresses.", "operationId": "GetRiskScoreEntity", "parameters": [ { "name": "entity_id", "in": "path", "description": "The entity identifier to query.", "required": true, "schema": { "type": "string", "description": "The entity identifier to query.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskScoreEntityResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/subscription/intel-usage": { "get": { "summary": "Get intel data usage for the current billing period", "description": "Returns your intel-data consumption for the current billing period, broken down by chain.\n\nUsage is tracked per seat (the calling user), not account-wide: `totalLimit` is the limit for your seat and `totalCount` is the data points your seat has consumed. The response also includes the start of the current period and the per-chain breakdown of usage.\n\nReturns 503 when usage tracking is unavailable.", "operationId": "GetIntelUsage", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntelUsageResponse" } } } }, "500": { "description": "Internal Server Error" } } } }, "/swaps": { "get": { "summary": "Get swaps", "description": "Retrieves a list of swaps (DEX trades) based on various query filters.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.", "operationId": "GetSwaps", "parameters": [ { "name": "base", "in": "query", "description": "Filter by specific entity or address involved in the swap. Required — omitting it returns an empty list.", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by specific entity or address involved in the swap. Required — omitting it returns an empty list.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" ] } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated value (e.g. 'ethereum,solana'). If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "flow", "in": "query", "description": "Swap direction relative to the base address. Valid values: 'in' (receiving token1), 'out' (sending token0), or 'all'. Defaults to 'all'.", "schema": { "$ref": "#/components/schemas/TransferFlow" } }, { "name": "tokens", "in": "query", "description": "List of token addresses or token IDs that appear as either token0 or token1.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of token addresses or token IDs that appear as either token0 or token1.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "from", "in": "query", "description": "Filter to swaps where the base sold one of these tokens (token addresses or token IDs). Combine with 'to' for a specific sold/bought trade. To match a token on either side regardless of direction use 'tokens'; to filter by the transaction parties instead, use senders/receivers.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter to swaps where the base sold one of these tokens (token addresses or token IDs). Combine with 'to' for a specific sold/bought trade. To match a token on either side regardless of direction use 'tokens'; to filter by the transaction parties instead, use senders/receivers.", "example": [ "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "to", "in": "query", "description": "Filter to swaps where the base bought one of these tokens (token addresses or token IDs). Combine with 'from' for a specific sold/bought trade.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter to swaps where the base bought one of these tokens (token addresses or token IDs). Combine with 'from' for a specific sold/bought trade.", "example": [ "ethereum" ] } }, { "name": "timeGte", "in": "query", "description": "Filter swaps at or after this time (unix ms, unix seconds, RFC3339, or YYYY-MM-DD).", "schema": { "type": "string", "description": "Filter swaps at or after this time (unix ms, unix seconds, RFC3339, or YYYY-MM-DD).", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Filter swaps at or before this time (unix ms, unix seconds, RFC3339, or YYYY-MM-DD).", "schema": { "type": "string", "description": "Filter swaps at or before this time (unix ms, unix seconds, RFC3339, or YYYY-MM-DD).", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Time range filter using relative durations (e.g. 24h, 7d). Cannot be combined with timeGte/timeLte.", "schema": { "type": "string", "description": "Time range filter using relative durations (e.g. 24h, 7d). Cannot be combined with timeGte/timeLte.", "example": "24h" } }, { "name": "value0Gte", "in": "query", "description": "Minimum token0 amount (decimal-adjusted; matched on absolute value).", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Minimum token0 amount (decimal-adjusted; matched on absolute value).", "nullable": true, "example": "1000" } }, { "name": "value0Lte", "in": "query", "description": "Maximum token0 amount (decimal-adjusted; matched on absolute value).", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Maximum token0 amount (decimal-adjusted; matched on absolute value).", "nullable": true, "example": "1000000" } }, { "name": "value1Gte", "in": "query", "description": "Minimum token1 amount (decimal-adjusted; matched on absolute value).", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Minimum token1 amount (decimal-adjusted; matched on absolute value).", "nullable": true, "example": "1" } }, { "name": "value1Lte", "in": "query", "description": "Maximum token1 amount (decimal-adjusted; matched on absolute value).", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Maximum token1 amount (decimal-adjusted; matched on absolute value).", "nullable": true, "example": "1000" } }, { "name": "usdGte", "in": "query", "description": "Minimum historical USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Minimum historical USD value.", "nullable": true, "example": "1000" } }, { "name": "usdLte", "in": "query", "description": "Maximum historical USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Maximum historical USD value.", "nullable": true, "example": "100000" } }, { "name": "sortKey", "in": "query", "description": "Field by which to sort the results. One of: time, usd.", "schema": { "$ref": "#/components/schemas/TransferSortKey" } }, { "name": "sortDir", "in": "query", "description": "Sort direction: 'asc' (ascending) or 'desc' (descending). Defaults to 'desc'.", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return. Default: 20. Max: 1649.", "schema": { "type": "integer", "description": "Maximum number of results to return. Default: 20. Max: 1649.", "example": 20 } }, { "name": "offset", "in": "query", "description": "Pagination offset. offset + limit must not exceed 10000.", "schema": { "type": "integer", "description": "Pagination offset. offset + limit must not exceed 10000.", "example": 0 } }, { "name": "counterparties", "in": "query", "description": "List of addresses or entities to treat strictly as counterparties.", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of addresses or entities to treat strictly as counterparties.", "example": [ "binance" ] } }, { "name": "senders", "in": "query", "description": "Filter by the transaction parties that initiated the swap (sender addresses or entities). Distinct from 'from', which filters on the sold token.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by the transaction parties that initiated the swap (sender addresses or entities). Distinct from 'from', which filters on the sold token.", "example": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, { "name": "receivers", "in": "query", "description": "Filter by the transaction parties that received the swap output (receiver addresses or entities). Distinct from 'to', which filters on the bought token.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by the transaction parties that received the swap output (receiver addresses or entities). Distinct from 'to', which filters on the bought token.", "example": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, { "name": "protocols", "in": "query", "description": "Filter by protocol/DEX addresses or entity IDs.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by protocol/DEX addresses or entity IDs.", "example": [ "uniswap" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichedSwaps" }, "example": { "count": 10000, "swaps": [ { "blockHash": "0x6e9f88a716532f88ca3e3154a4988dc82405fe7774bb2db1965880c02833a051", "blockNumber": 24643153, "blockTimestamp": "2026-03-12T18:23:47Z", "chain": "ethereum", "contractAddress": { "address": "0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/uniswap-labs", "id": "uniswap", "linkedin": "https://www.linkedin.com/company/uniswaporg", "name": "Uniswap", "note": "", "service": null, "twitter": "https://twitter.com/Uniswap", "type": "dex", "website": "https://uniswap.org" }, "arkhamLabel": { "address": "0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640", "chainType": "evm", "name": "USDC 3" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "contractEntityId": "uniswap", "historicalUSD": 9128487.881334, "id": "0xb62ab136f09349dd1d2f7c97e830a161c003e60509ff27cdf1f1769d18b963a8_2", "receiver": { "address": "0x51C72848c68a965f66FA7a88855F9f7784502a7F", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/wintermute-trading", "id": "wintermute", "linkedin": "https://www.linkedin.com/company/wintermute-trading", "name": "Wintermute", "note": "", "service": null, "twitter": "https://twitter.com/wintermute_t", "type": "fund", "website": "https://www.wintermute.com/" }, "arkhamLabel": { "address": "0x51C72848c68a965f66FA7a88855F9f7784502a7F", "chainType": "evm", "name": "Market Maker" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "sender": { "address": "0x51C72848c68a965f66FA7a88855F9f7784502a7F", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/wintermute-trading", "id": "wintermute", "linkedin": "https://www.linkedin.com/company/wintermute-trading", "name": "Wintermute", "note": "", "service": null, "twitter": "https://twitter.com/wintermute_t", "type": "fund", "website": "https://www.wintermute.com/" }, "arkhamLabel": { "address": "0x51C72848c68a965f66FA7a88855F9f7784502a7F", "chainType": "evm", "name": "Market Maker" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "token0": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "token0Decimals": 6, "token0Id": "usd-coin", "token0Name": "USD Coin", "token0Symbol": "USDC", "token1": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", "token1Decimals": 18, "token1Id": "weth", "token1Name": "Wrapped Ether", "token1Symbol": "WETH", "unitValue0": -9128487.881334, "unitValue1": 4263.136684788042, "valid": true }, { "blockHash": "0x8b77776a7b9ed15a50afbda87fab1479a7d369962330d8e162d9c1012da1faa7", "blockNumber": 65642004, "blockTimestamp": "2025-10-23T15:11:49Z", "chain": "bsc", "contractAddress": { "address": "0x47a90A2d92A8367A91EfA1906bFc8c1E05bf10c4", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/uniswap-labs", "id": "uniswap", "linkedin": "https://www.linkedin.com/company/uniswaporg", "name": "Uniswap", "note": "", "service": null, "twitter": "https://twitter.com/Uniswap", "type": "dex", "website": "https://uniswap.org" }, "arkhamLabel": { "address": "0x47a90A2d92A8367A91EfA1906bFc8c1E05bf10c4", "chainType": "evm", "name": "V3 Pool" }, "chain": "bsc", "contract": true, "isUserAddress": false }, "contractEntityId": null, "historicalUSD": 256048.41755623545, "id": "0x1bf3a69b623e444dae87be15f51e9fd2a7a9cd03484c07aac838d77ac6ec8619_3", "receiver": { "address": "0x76801132a22801640284Cd67F7DD41fED2926B6a", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/wintermute-trading", "id": "wintermute", "linkedin": "https://www.linkedin.com/company/wintermute-trading", "name": "Wintermute", "note": "", "service": null, "twitter": "https://twitter.com/wintermute_t", "type": "fund", "website": "https://www.wintermute.com/" }, "chain": "bsc", "contract": true, "isUserAddress": false }, "sender": { "address": "0x32564234dF8961ae1d640bE2CBA4aEab54151551", "chain": "bsc", "contract": true, "isUserAddress": false }, "token0": "0x55d398326f99059fF775485246999027B3197955", "token0Decimals": 18, "token0Id": "binance-bridged-usdt-bnb-smart-chain", "token0Name": "Tether USD", "token0Symbol": "USDT", "token1": "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c", "token1Decimals": 18, "token1Id": "wbnb", "token1Name": "Wrapped BNB", "token1Symbol": "WBNB", "unitValue0": 256048.41755623545, "unitValue1": -228.12506498806798, "valid": true } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/tag/{id}/params": { "get": { "summary": "Get tag parameters", "description": "Returns a list of all unique tag parameter combinations for the specified tag.", "operationId": "GetAllTagParams", "parameters": [ { "name": "limit", "in": "query", "description": "Number of items to return per page (1-1000, default 100).", "schema": { "type": "string", "description": "Number of items to return per page (1-1000, default 100).", "example": "100" } }, { "name": "offset", "in": "query", "description": "Number of items to skip from the beginning (must be \u003e= 0, default 0).", "schema": { "type": "string", "description": "Number of items to skip from the beginning (must be \u003e= 0, default 0).", "example": "0" } }, { "name": "id", "in": "path", "description": "The tag identifier to retrieve parameters for.", "required": true, "schema": { "type": "string", "description": "The tag identifier to retrieve parameters for.", "example": "proof-of-reserves" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PopulatedTag" }, "example": [ { "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/tag/{id}/summary": { "get": { "summary": "Get tag summary statistics", "description": "Returns summary statistics for the specified tag, including total counts of addresses, entities, and unique tag parameters.", "operationId": "GetTagSummary", "parameters": [ { "name": "id", "in": "path", "description": "The tag identifier to retrieve summary statistics for.", "required": true, "schema": { "type": "string", "description": "The tag identifier to retrieve summary statistics for.", "example": "proof-of-reserves" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagSummary" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/addresses/{id}": { "get": { "summary": "Get chain addresses for a token", "description": "Returns all known chain/address pairs for a token identified by its pricing ID.", "operationId": "GetTokenAddresses", "parameters": [ { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string", "nullable": true, "example": "abc123" }, "example": { "base": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "ethereum": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "solana": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/arkham_exchange_tokens": { "get": { "summary": "Get Arkham Exchange tokens", "description": "Returns the tokens listed on Arkham Exchange, split into `spotTokens` and `perpTokens` arrays. Each entry identifies a token by its CoinGecko pricing ID.", "operationId": "GetArkhamExchangeTokens", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArkhamTokensResponse" }, "example": { "perpTokens": [ { "identifier": { "pricingID": "ethereum" } }, { "identifier": { "pricingID": "solana" } } ], "spotTokens": [ { "identifier": { "pricingID": "bitcoin" } }, { "identifier": { "pricingID": "ethereum" } } ] } } } }, "500": { "description": "Internal Server Error" } } } }, "/token/balance/{chain}/{address}": { "get": { "summary": "Get token balance for an entity or address, for a specific chain/address", "description": "Returns the balance of a specific token contract (identified by the `chain` and `address` path params) held by an entity or address. The `address` query param is the holder wallet(s); the path `address` is the token contract.", "operationId": "GetTokenBalanceOfByChainAddress", "parameters": [ { "name": "entityID", "in": "query", "description": "Entity ID to query the balance for. Provide either entityID or address; if both are given, address takes precedence and entityID is ignored. If neither is given, the balance is 0.", "schema": { "type": "string", "description": "Entity ID to query the balance for. Provide either entityID or address; if both are given, address takes precedence and entityID is ignored. If neither is given, the balance is 0.", "example": "binance" } }, { "name": "address", "in": "query", "description": "Addresses to query the balance for, passed as a single comma-separated string, e.g. '0x28C6…,0x21a3…' (not a JSON array). Takes precedence over entityID when both are provided; if neither is given, the balance is 0.", "schema": { "type": "string", "description": "Addresses to query the balance for, passed as a single comma-separated string, e.g. '0x28C6…,0x21a3…' (not a JSON array). Takes precedence over entityID when both are provided; if neither is given, the balance is 0.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } }, { "name": "chain", "in": "path", "description": "Blockchain network where the token is deployed.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "address", "in": "path", "description": "The token contract address.", "required": true, "schema": { "type": "string", "description": "The token contract address.", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenBalance" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/balance/{id}": { "get": { "summary": "Get token balance (all chains) for an entity or address", "description": "Returns the aggregated token balance for either an entity or address, across all chains.", "operationId": "GetTokenBalanceOfByID", "parameters": [ { "name": "entityID", "in": "query", "description": "Entity ID to query the balance for. Provide either entityID or address; if both are given, address takes precedence and entityID is ignored. If neither is given, the balance is 0.", "schema": { "type": "string", "description": "Entity ID to query the balance for. Provide either entityID or address; if both are given, address takes precedence and entityID is ignored. If neither is given, the balance is 0.", "example": "binance" } }, { "name": "address", "in": "query", "description": "Addresses to query the balance for, passed as a single comma-separated string, e.g. '0x28C6…,0x21a3…' (not a JSON array). Takes precedence over entityID when both are provided; if neither is given, the balance is 0.", "schema": { "type": "string", "description": "Addresses to query the balance for, passed as a single comma-separated string, e.g. '0x28C6…,0x21a3…' (not a JSON array). Takes precedence over entityID when both are provided; if neither is given, the balance is 0.", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" } }, { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenBalance" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/holders/{chain}/{address}": { "get": { "summary": "Get top token holders by chain and address", "description": "Returns the top token holders for a specific token contract on a given chain. Results are sorted by balance in descending order.\n\nOnly chains with token contracts (EVM chains, Solana, Tron) are supported here. For UTXO assets like Bitcoin, use the pricing-ID form (/token/holders/{id}).\n\n**Response fields:**\n- **token**: Token metadata (name, symbol, pricing info).\n- **totalSupply**: Total supply for the chain.\n- **addressTopHolders**: Top holders by individual address.\n- **entityTopHolders**: Top holders grouped by entity (only present when groupByEntity=true).\n\n**Note:** Entity objects in the response do not include `populatedTags`. Use `GET /intelligence/entity/{id}` to retrieve tags for individual entities.", "operationId": "GetTopTokenHoldersByChainAddress", "parameters": [ { "name": "groupByEntity", "in": "query", "description": "If 'true', groups holdings by entity rather than individual addresses.", "schema": { "type": "string", "description": "If 'true', groups holdings by entity rather than individual addresses.", "example": "true" } }, { "name": "limit", "in": "query", "description": "Maximum number of holders to return per page (default 100, max 100). offset + limit must not exceed 1000.", "schema": { "type": "integer", "description": "Maximum number of holders to return per page (default 100, max 100). offset + limit must not exceed 1000.", "example": 100 } }, { "name": "offset", "in": "query", "description": "Number of holders to skip for pagination (default 0).", "schema": { "type": "integer", "description": "Number of holders to skip for pagination (default 0).", "example": 0 } }, { "name": "poolAddress", "in": "query", "description": "Optional Solana pool address. When provided, address holder unrealized PnL is calculated from this pool only.", "schema": { "type": "string", "description": "Optional Solana pool address. When provided, address holder unrealized PnL is calculated from this pool only.", "example": "CiLg83sX8nJQMPkRwGMZYcjbgcHxaXsL6XjZre5nmeKn" } }, { "name": "chain", "in": "path", "description": "Blockchain network where the token is deployed.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "address", "in": "path", "description": "The token contract address to query.", "required": true, "schema": { "type": "string", "description": "The token contract address to query.", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopHolderResponse" }, "example": { "addressTopHolders": { "ethereum": [ { "address": { "address": "0x37305B1cD40574E4C5Ce33f8e8306Be057fD7341", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/makerdao", "id": "makerdao", "linkedin": "https://www.linkedin.com/company/makerdao/", "name": "Sky (MakerDAO)", "note": "", "service": null, "twitter": "https://twitter.com/MakerDAO", "type": "cdp", "website": "https://makerdao.com" }, "arkhamLabel": { "address": "0x37305B1cD40574E4C5Ce33f8e8306Be057fD7341", "chainType": "evm", "name": "LITE PSM USDC A POCKET" }, "chain": "ethereum", "contract": false, "isUserAddress": false }, "balance": 4453872464.461215, "pctOfCap": 0.06071662849686393, "usd": 4453872464.461215 }, { "address": { "address": "0xe1940f578743367F38D3f25c2D2d32D6636929B6", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0xe1940f578743367F38D3f25c2D2d32D6636929B6", "chainType": "evm", "name": "SingleOwnerMSCA (Proxy)" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "balance": 1699999999.039577, "pctOfCap": 0.02317494926268423, "usd": 1699999999.039577 } ] }, "entityTopHolders": {}, "token": { "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USD Coin", "symbol": "USDC" }, "totalSupply": { "ethereum": 50539998661.70982 } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/holders/{id}": { "get": { "summary": "Get top token holders by pricing ID", "description": "Returns the top token holders for a token identified by its CoinGecko pricing ID (e.g. \"bitcoin\", \"ethereum\", \"usd-coin\"). Results are sorted by balance in descending order.\n\n**Response fields:**\n- **token**: Token metadata (name, symbol, pricing info).\n- **totalSupply**: Total supply per chain.\n- **addressTopHolders**: Top holders by individual address, keyed by chain.\n- **entityTopHolders**: Top holders grouped by entity (only present when groupByEntity=true), keyed by chain.\n\n**Note:** Entity objects in the response do not include `populatedTags`. Use `GET /intelligence/entity/{id}` to retrieve tags for individual entities.", "operationId": "GetTopTokenHoldersByID", "parameters": [ { "name": "groupByEntity", "in": "query", "description": "If 'true', groups holdings by entity rather than individual addresses.", "schema": { "type": "string", "description": "If 'true', groups holdings by entity rather than individual addresses.", "example": "true" } }, { "name": "limit", "in": "query", "description": "Maximum number of holders to return per page (default 100, max 100). offset + limit must not exceed 1000.", "schema": { "type": "integer", "description": "Maximum number of holders to return per page (default 100, max 100). offset + limit must not exceed 1000.", "example": 100 } }, { "name": "offset", "in": "query", "description": "Number of holders to skip for pagination (default 0).", "schema": { "type": "integer", "description": "Number of holders to skip for pagination (default 0).", "example": 0 } }, { "name": "poolAddress", "in": "query", "description": "Optional Solana pool address. When provided, address holder unrealized PnL is calculated from this pool only.", "schema": { "type": "string", "description": "Optional Solana pool address. When provided, address holder unrealized PnL is calculated from this pool only.", "example": "CiLg83sX8nJQMPkRwGMZYcjbgcHxaXsL6XjZre5nmeKn" } }, { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopHolderResponse" }, "example": { "addressTopHolders": { "ethereum": [ { "address": { "address": "0x37305B1cD40574E4C5Ce33f8e8306Be057fD7341", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/makerdao", "id": "makerdao", "linkedin": "https://www.linkedin.com/company/makerdao/", "name": "Sky (MakerDAO)", "note": "", "service": null, "twitter": "https://twitter.com/MakerDAO", "type": "cdp", "website": "https://makerdao.com" }, "arkhamLabel": { "address": "0x37305B1cD40574E4C5Ce33f8e8306Be057fD7341", "chainType": "evm", "name": "LITE PSM USDC A POCKET" }, "chain": "ethereum", "contract": false, "isUserAddress": false }, "balance": 4453872464.461215, "pctOfCap": 0.06071662849686393, "usd": 4453872464.461215 }, { "address": { "address": "0xe1940f578743367F38D3f25c2D2d32D6636929B6", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/binance", "id": "binance", "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0xe1940f578743367F38D3f25c2D2d32D6636929B6", "chainType": "evm", "name": "SingleOwnerMSCA (Proxy)" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "balance": 1699999999.039577, "pctOfCap": 0.02317494926268423, "usd": 1699999999.039577 } ] }, "entityTopHolders": {}, "token": { "identifier": { "pricingID": "usd-coin" }, "name": "USDC", "price": 0.999831, "price24hAgo": 0.999825, "symbol": "usdc" }, "totalSupply": { "ethereum": 50539998661.70982 } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/market/{id}": { "get": { "summary": "Get current market data for a token", "description": "Returns current market data for a token including price, market cap, volume, and supply information.", "operationId": "GetTokenCurrentMarketData", "parameters": [ { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenMarketData" }, "example": { "allTimeHigh": 1.043, "allTimeLow": 0.877647, "circulatingSupply": 73354602419.50252, "fullyDilutedValue": 73342671855.44943, "marketCap": 73340976893, "maxPrice24h": 0.999979, "minPrice24h": 0.999745, "price": 0.999831, "price180dAgo": 0.999812, "price24hAgo": 0.999797, "price30dAgo": 0.999724, "price7dAgo": 0.999852, "totalSupply": 73355068862.08713, "totalVolume": 7539296441 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/price/history/{chain}/{address}": { "get": { "summary": "Get token price history by chain and address", "description": "Returns historical price data for a token identified by its chain and contract address.\n\nOnly chains that have token contracts (EVM chains, Solana, Tron) are supported here. For UTXO assets like Bitcoin, use `/token/price/history/{id}` with the token's pricing ID (e.g. `bitcoin`).", "operationId": "GetTokenHistory", "parameters": [ { "name": "daily", "in": "query", "description": "If 'true', returns the full daily price history for the token. Otherwise returns every quote recorded in the last 24 hours.", "schema": { "type": "string", "description": "If 'true', returns the full daily price history for the token. Otherwise returns every quote recorded in the last 24 hours.", "example": "true" } }, { "name": "chain", "in": "path", "description": "Blockchain network where the token is deployed.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "address", "in": "path", "description": "The token contract address.", "required": true, "schema": { "type": "string", "description": "The token contract address.", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenHistoricalQuote" }, "example": [ { "marketCap": 73287761995, "time": "2026-07-13T10:26:27.747Z", "usd": 0.999798, "volume24h": 8228653724 }, { "marketCap": 73290240682, "time": "2026-07-13T10:27:12.877Z", "usd": 0.9998, "volume24h": 8232347779 }, { "marketCap": 73286652112, "time": "2026-07-13T10:29:22.977Z", "usd": 0.999766, "volume24h": 8252952310 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/price/history/{id}": { "get": { "summary": "Get token price history by pricing ID", "description": "Returns historical price data for a token identified by its pricing ID (e.g., 'bitcoin', 'ethereum'). Returns an array of timestamped price quotes.", "operationId": "GetTokenHistoryFromPricingID", "parameters": [ { "name": "daily", "in": "query", "description": "If 'true', returns the full daily price history for the token. Otherwise returns every quote recorded in the last 24 hours.", "schema": { "type": "string", "description": "If 'true', returns the full daily price history for the token. Otherwise returns every quote recorded in the last 24 hours.", "example": "true" } }, { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenHistoricalQuote" }, "example": [ { "marketCap": 73287761995, "time": "2026-07-13T10:26:27.747Z", "usd": 0.999798, "volume24h": 8228653724 }, { "marketCap": 73290240682, "time": "2026-07-13T10:27:12.877Z", "usd": 0.9998, "volume24h": 8232347779 }, { "marketCap": 73286652112, "time": "2026-07-13T10:29:22.977Z", "usd": 0.999766, "volume24h": 8252952310 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/price_change/{id}": { "get": { "summary": "Get token price change since a timestamp", "description": "Returns the token's current price and its historical price at the requested past timestamp. The absolute or percentage change can be computed from the two values.", "operationId": "GetTokenPriceChangeSinceHandler", "parameters": [ { "name": "pastTime", "in": "query", "description": "Past timestamp in RFC3339 format to calculate price change from.", "required": true, "schema": { "type": "string", "description": "Past timestamp in RFC3339 format to calculate price change from.", "example": "2024-01-01T00:00:00Z" } }, { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenPriceChange" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/top": { "get": { "summary": "Get top tokens by exchange activity", "description": "Analyzes token activity across centralized and decentralized exchanges. Ranks tokens by volume, inflows, outflows, netflows, and other metrics over customizable time intervals.\n\nSupports filtering by chain, market cap, and specific tokens.\n\nEach result reports 'current' (metrics over the selected timeframe) and 'previous' (the same metrics averaged across the numReferencePeriods prior windows, each the length of the timeframe); the two are compared to produce the change and percentage rankings.", "operationId": "GetTopTokens", "parameters": [ { "name": "timeframe", "in": "query", "description": "Time interval for aggregation.", "required": true, "schema": { "$ref": "#/components/schemas/TopTokenTimeFrame" } }, { "name": "orderByAgg", "in": "query", "description": "Metric to sort by.", "required": true, "schema": { "$ref": "#/components/schemas/TopTokensOrderByAgg" } }, { "name": "orderByDesc", "in": "query", "description": "Sort order. Use 'true' for descending, 'false' for ascending.", "required": true, "schema": { "type": "boolean", "description": "Sort order. Use 'true' for descending, 'false' for ascending.", "nullable": true, "example": true } }, { "name": "orderByPercent", "in": "query", "description": "If 'true', sort by percentage change rather than absolute values.", "required": true, "schema": { "type": "boolean", "description": "If 'true', sort by percentage change rather than absolute values.", "nullable": true, "example": true } }, { "name": "from", "in": "query", "description": "Pagination offset (starting index).", "required": true, "schema": { "type": "string", "description": "Pagination offset (starting index).", "example": "0" } }, { "name": "size", "in": "query", "description": "Number of results to return per page.", "required": true, "schema": { "type": "string", "description": "Number of results to return per page.", "example": "50" } }, { "name": "minVolume", "in": "query", "description": "Minimum volume filter in USD.", "schema": { "type": "string", "description": "Minimum volume filter in USD.", "example": "1000000" } }, { "name": "maxVolume", "in": "query", "description": "Maximum volume filter in USD.", "schema": { "type": "string", "description": "Maximum volume filter in USD.", "example": "1000000000" } }, { "name": "minMarketCap", "in": "query", "description": "Minimum market cap filter in USD.", "schema": { "type": "string", "description": "Minimum market cap filter in USD.", "example": "1000000" } }, { "name": "maxMarketCap", "in": "query", "description": "Maximum market cap filter in USD.", "schema": { "type": "string", "description": "Maximum market cap filter in USD.", "example": "10000000000000" } }, { "name": "numReferencePeriods", "in": "query", "description": "Number of prior periods (each the length of the timeframe) used as the historical baseline the current period is compared against. Default: auto (6 periods for 1h, 1 for longer timeframes). Max: 10.", "schema": { "type": "string", "description": "Number of prior periods (each the length of the timeframe) used as the historical baseline the current period is compared against. Default: auto (6 periods for 1h, 1 for longer timeframes). Max: 10.", "example": "auto" } }, { "name": "tokenIds", "in": "query", "description": "Comma-separated list of CoinGecko token IDs to filter results.", "schema": { "type": "string", "description": "Comma-separated list of CoinGecko token IDs to filter results.", "example": "usd-coin,tether" } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated string, e.g. 'ethereum,bsc' (not a JSON array). If omitted, returns all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTopTokensResponse" }, "example": { "tokens": [ { "current": { "inflowCexVolume": 181200000, "inflowDexVolume": 152300000, "outflowCexVolume": 179400000, "outflowDexVolume": 151800000, "price": 0.999831 }, "previous": { "inflowCexVolume": 176500000, "inflowDexVolume": 148100000, "outflowCexVolume": 175300000, "outflowDexVolume": 149200000, "price": 0.999797 }, "token": { "id": "usd-coin", "marketCap": 73340976893, "symbol": "USDC" } } ], "total": 8189 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/top_flow/{chain}/{address}": { "get": { "summary": "Get top token flow", "description": "Retrieves the top token flow (in USD and value) for the specified chain and address over a given duration.\n\nOnly chains with token contracts (EVM chains, Solana, Tron) return token flows here. For UTXO assets like Bitcoin, use the pricing-ID form (/token/top_flow/{id}) for native flows.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.", "operationId": "GetTopTokenFlowByChainAddress", "parameters": [ { "name": "timeLast", "in": "query", "description": "Time range filter using relative durations.", "required": true, "schema": { "type": "string", "description": "Time range filter using relative durations.", "example": "24h" } }, { "name": "limit", "in": "query", "description": "Maximum number of addresses to return per flow direction. Default: 50. Max: 100.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Maximum number of addresses to return per flow direction. Default: 50. Max: 100.", "default": 50, "example": 5 } }, { "name": "chains", "in": "query", "description": "Ignored on this endpoint form — the chain is already fixed by the path. Use the pricing-ID form of this endpoint to filter flows by chain.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "chain", "in": "path", "description": "Blockchain network where the token is deployed.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "address", "in": "path", "description": "The token contract address.", "required": true, "schema": { "type": "string", "description": "The token contract address.", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopFlow" }, "example": [ { "address": { "address": "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/morpho-labs", "id": "morpho", "linkedin": "https://www.linkedin.com/company/morpho-labs", "name": "Morpho", "note": "", "service": null, "twitter": "https://twitter.com/MorphoLabs", "type": "lending-decentralized", "website": "https://morpho.org" }, "arkhamLabel": { "address": "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb", "chainType": "evm", "name": "Morpho Blue" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "inUSD": 8464010273.634033, "inValue": 8464010259.6050005, "outUSD": 8467229188.141229, "outValue": 8467229174.00334 }, { "address": { "address": "0x06CFf7088619C7178F5e14f0B119458d08d2f5ef", "arkhamLabel": { "address": "0x06CFf7088619C7178F5e14f0B119458d08d2f5ef", "chainType": "evm", "name": "MEV Bot" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "inUSD": 2757517313.9577456, "inValue": 2757517326.099296, "outUSD": 2757671412.9492354, "outValue": 2757671425.122005 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/top_flow/{id}": { "get": { "summary": "Get top flow for a token by pricing ID", "description": "Returns the top inflows/outflows for the specified token ID, aggregated by address.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.", "operationId": "GetTopTokenFlowByPricingId", "parameters": [ { "name": "timeLast", "in": "query", "description": "Time range filter using relative durations.", "required": true, "schema": { "type": "string", "description": "Time range filter using relative durations.", "example": "24h" } }, { "name": "limit", "in": "query", "description": "Maximum number of addresses to return per flow direction. Default: 50. Max: 100.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Maximum number of addresses to return per flow direction. Default: 50. Max: 100.", "default": 50, "example": 5 } }, { "name": "chains", "in": "query", "description": "Chains to filter by, as a single comma-separated string, e.g. 'ethereum,bsc' (not a JSON array). If omitted, returns all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopFlow" }, "example": [ { "address": { "address": "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb", "arkhamEntity": { "crunchbase": "https://www.crunchbase.com/organization/morpho-labs", "id": "morpho", "linkedin": "https://www.linkedin.com/company/morpho-labs", "name": "Morpho", "note": "", "service": null, "twitter": "https://twitter.com/MorphoLabs", "type": "lending-decentralized", "website": "https://morpho.org" }, "arkhamLabel": { "address": "0xBBBBBbbBBb9cC5e90e3b3Af64bdAF62C37EEFFCb", "chainType": "evm", "name": "Morpho Blue" }, "chain": "ethereum", "contract": true, "isUserAddress": false }, "inUSD": 12979047524.191177, "inValue": 12979047525.961317, "outUSD": 12971777421.736961, "outValue": 12971777423.626078 }, { "address": { "address": "0x61040E143A77F165Ba44543AF4A079F2C809D14b", "arkhamLabel": { "address": "0x61040E143A77F165Ba44543AF4A079F2C809D14b", "chainType": "evm", "name": "Proxy (EIP-1967 Transparent)" }, "chain": "base", "contract": true, "isUserAddress": false }, "inUSD": 4866908061.438353, "inValue": 4866908062.542056, "outUSD": 4866351186.855593, "outValue": 4866351187.380329 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/trending": { "get": { "summary": "Get trending tokens", "description": "Returns a list of currently trending tokens across multiple chains.", "operationId": "GetTrendingTokens", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Token" }, "example": [ { "identifier": { "pricingID": "bitcoin" }, "name": "Bitcoin", "symbol": "btc" }, { "identifier": { "pricingID": "ethereum" }, "name": "Ethereum", "symbol": "eth" } ] } } } }, "500": { "description": "Internal Server Error" } } } }, "/token/trending/{id}": { "get": { "summary": "Get a single trending token by ID", "description": "Returns a single trending token, identified by a specific ID (e.g., \"bitcoin\", \"ethereum\").", "operationId": "GetTrendingToken", "parameters": [ { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrendingToken" }, "example": { "allTimeHigh": 1.043, "allTimeLow": 0.877647, "circulatingSupply": 73354602419.50252, "name": "USDC", "price": 0.999831, "price24hAgo": 0.999825, "pricingID": "usd-coin", "symbol": "usdc", "totalSupply": 73355068862.08713, "volume24h": 7539296441 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/volume/{chain}/{address}": { "get": { "summary": "Get volume for a token by chain/address", "description": "Returns exchange flow for the specified token contract on a given chain, bucketed by time.\n\nEach bucket reports the token's flows to and from the largest exchanges: inUSD and inValue are the amounts moving into exchanges, outUSD and outValue the amounts moving back out, denominated in USD and in token units respectively.\n\nThis form looks the token up by its contract address, so it only covers chains that have token contracts (EVM chains, Solana, Tron). UTXO assets such as Bitcoin and Dogecoin have no token contract and return no data here; use the pricing-ID form (/token/volume/{id}) for their native flows.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.", "operationId": "GetTokenVolumeByChainAddress", "parameters": [ { "name": "granularity", "in": "query", "description": "Bucket size for the histogram. Use a whole number of hours, from 1h up to 7d (e.g. 1h, 2h, 6h, 12h, 1d, 2d, 3d, 7d); sub-hour values and durations over 7d are rejected. Only applied when timeLast is under 30 days; for longer or omitted ranges, results are always returned in daily buckets.", "required": true, "schema": { "type": "string", "description": "Bucket size for the histogram. Use a whole number of hours, from 1h up to 7d (e.g. 1h, 2h, 6h, 12h, 1d, 2d, 3d, 7d); sub-hour values and durations over 7d are rejected. Only applied when timeLast is under 30 days; for longer or omitted ranges, results are always returned in daily buckets.", "nullable": true, "example": "1h" } }, { "name": "timeLast", "in": "query", "description": "Time range to return, as a relative duration such as '24h', '7d', or '60d'. Under 30 days, results honor granularity; 30 days or longer returns daily buckets. If omitted, returns all-time data in daily buckets.", "schema": { "type": "string", "description": "Time range to return, as a relative duration such as '24h', '7d', or '60d'. Under 30 days, results honor granularity; 30 days or longer returns daily buckets. If omitted, returns all-time data in daily buckets.", "nullable": true, "example": "24h" } }, { "name": "chain", "in": "path", "description": "Blockchain network where the token is deployed.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "address", "in": "path", "description": "The token contract address.", "required": true, "schema": { "type": "string", "description": "The token contract address.", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenHistogramSnapshot" }, "example": [ { "inUSD": 968891.0319822108, "inValue": 968891.037339, "outUSD": 1233415.5464420319, "outValue": 1233415.563605, "time": "2026-07-12T16:00:00Z" }, { "inUSD": 1187226.4781189265, "inValue": 1187226.461162, "outUSD": 1275054.663351059, "outValue": 1275054.650006, "time": "2026-07-12T17:00:00Z" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/token/volume/{id}": { "get": { "summary": "Get volume for a token by pricing ID", "description": "Returns exchange flow for the specified token, bucketed by time.\n\nEach bucket reports the token's flows to and from the largest exchanges: inUSD and inValue are the amounts moving into exchanges, outUSD and outValue the amounts moving back out, denominated in USD and in token units respectively.\n\nThis form resolves the token by pricing ID, so it also covers native assets such as Bitcoin and Dogecoin.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.", "operationId": "GetTokenVolumeByID", "parameters": [ { "name": "granularity", "in": "query", "description": "Bucket size for the histogram. Use a whole number of hours, from 1h up to 7d (e.g. 1h, 2h, 6h, 12h, 1d, 2d, 3d, 7d); sub-hour values and durations over 7d are rejected. Only applied when timeLast is under 30 days; for longer or omitted ranges, results are always returned in daily buckets.", "required": true, "schema": { "type": "string", "description": "Bucket size for the histogram. Use a whole number of hours, from 1h up to 7d (e.g. 1h, 2h, 6h, 12h, 1d, 2d, 3d, 7d); sub-hour values and durations over 7d are rejected. Only applied when timeLast is under 30 days; for longer or omitted ranges, results are always returned in daily buckets.", "nullable": true, "example": "1h" } }, { "name": "timeLast", "in": "query", "description": "Time range to return, as a relative duration such as '24h', '7d', or '60d'. Under 30 days, results honor granularity; 30 days or longer returns daily buckets. If omitted, returns all-time data in daily buckets.", "schema": { "type": "string", "description": "Time range to return, as a relative duration such as '24h', '7d', or '60d'. Under 30 days, results honor granularity; 30 days or longer returns daily buckets. If omitted, returns all-time data in daily buckets.", "nullable": true, "example": "24h" } }, { "name": "id", "in": "path", "description": "The CoinGecko pricing ID of the token.", "required": true, "schema": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "bitcoin" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenHistogramSnapshot" }, "example": [ { "inUSD": 2399721.9841460586, "inValue": 37.44615725, "outUSD": 6826024.15839386, "outValue": 106.51191897, "time": "2026-07-12T16:00:00Z" }, { "inUSD": 3211115.482628137, "inValue": 50.12274685, "outUSD": 4771902.633152008, "outValue": 74.42026910000001, "time": "2026-07-12T17:00:00Z" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/transfers": { "get": { "summary": "Get transfers", "description": "Retrieves a list of transfers based on various query filters.\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.\n\n**Filter parameters:**\n- **base**: Filter by specific entity or address. For example, \"0x123abc\" or \"binance\".\n- **chains**: Specify a comma-separated list of chains (e.g. \"ethereum,bsc\").\n- **flow**: Direction of the transfer. Valid values are \"in\" (incoming), \"out\" (outgoing), \"self\" (self-transfers), or \"all\".\n- **from**: Comma-separated list of addresses, entities, or deposit services for the 'from' side of a transfer. You can also use special syntax like \"type:cex\" to filter on entity types or \"deposit:binance\" to filter on deposit addresses.\n- **to**: Comma-separated list of addresses, entities, or deposit services for the 'to' side.\n- **tokens**: Comma-separated list of token addresses or token IDs. E.g. \"ethereum\", \"usd-coin\", or \"0x...tokenAddress\".\n- **counterparties**: Comma-separated list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).\n- **timeLast**: Filter transfers from a recent duration. For example, \"24h\" returns transfers from the last 24 hours.\n- **timeGte/timeLte**: Filter from/to a specific timestamp in milliseconds.\n- **valueGte/valueLte**: Numeric filters on the raw token amount (on-chain units).\n- **usdGte/usdLte**: Numeric filters on the historical USD value of the transfer.\n- **sortKey**: Field by which to sort the results. Options include \"time\", \"value\", or \"usd\".\n- **sortDir**: Sorting direction. Use \"asc\" for ascending or \"desc\" for descending.\n- **limit**: Maximum number of results to return (default is 20).\n- **offset**: Pagination offset (default is 0).\n\n**Real-time streaming:** For live transfer notifications instead of polling, use the WebSocket API. See GET /ws/transfers for real-time streaming with the same filtering capabilities.", "operationId": "GetTransfers", "parameters": [ { "name": "base", "in": "query", "description": "Filter from or to any of a comma separated list of entities or addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from or to any of a comma separated list of entities or addresses.", "example": [ "binance", "!wintermute" ] } }, { "name": "chains", "in": "query", "description": "List of chains to filter by.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "flow", "in": "query", "description": "Transfer direction.", "schema": { "$ref": "#/components/schemas/TransferFlow" } }, { "name": "from", "in": "query", "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "to", "in": "query", "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "counterparties", "in": "query", "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "schema": { "type": "array", "items": { "type": "string" }, "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "example": [ "binance" ] } }, { "name": "tokens", "in": "query", "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "timeGte", "in": "query", "description": "Filter after a specific time.", "schema": { "type": "string", "description": "Filter after a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Filter before a specific time.", "schema": { "type": "string", "description": "Filter before a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Filter using a duration string.", "schema": { "type": "string", "description": "Filter using a duration string.", "example": "24h" } }, { "name": "valueGte", "in": "query", "description": "Filter above a minimum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum token value.", "nullable": true, "example": "100.23" } }, { "name": "valueLte", "in": "query", "description": "Filter below a maximum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum token value.", "nullable": true, "example": "100.23" } }, { "name": "usdGte", "in": "query", "description": "Filter above a minimum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum USD value.", "nullable": true, "example": "100.23" } }, { "name": "usdLte", "in": "query", "description": "Filter below a maximum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum USD value.", "nullable": true, "example": "100.23" } }, { "name": "sortKey", "in": "query", "description": "Field by which to sort the results. Custom sorting requires authentication; anonymous requests are always sorted by time, descending.", "schema": { "$ref": "#/components/schemas/TransferSortKey" } }, { "name": "sortDir", "in": "query", "description": "Direction for sorting results.", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return. Default: 20. Max: 1650.", "schema": { "type": "integer", "description": "Maximum number of results to return. Default: 20. Max: 1650.", "example": 10 } }, { "name": "offset", "in": "query", "description": "Pagination offset. offset + limit must not exceed 10000.", "schema": { "type": "integer", "description": "Pagination offset. offset + limit must not exceed 10000.", "example": 0 } }, { "name": "includeCursors", "in": "query", "description": "Include per-chain as-of cursors in the response. Default: false.", "schema": { "type": "boolean", "description": "Include per-chain as-of cursors in the response. Default: false.", "example": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichedTransfers" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/transfers/histogram": { "get": { "summary": "Get a detailed histogram of transfers (API Only)", "description": "Returns an aggregated histogram of transfers over time (count and USD values) based on the same filter parameters used in /transfers.\n\n**Requires an API key** (browser-session and anonymous access are not permitted).\n\n**Rate Limit**: This endpoint has a stricter rate limit of 1 request per second.\n\n**Additional parameter**:\n- **granularity**: \"1h\" or \"1d\" (if the range exceeds 30 days, \"1h\" is invalid).\n\n**Filter parameters** (same as /transfers, minus pagination/sorting):\n- **base**: Filter by specific entity or address. For example, \"0x123abc\" or \"binance\".\n- **chains**: Specify a comma-separated list of chains (e.g. \"ethereum,bsc\").\n- **flow**: Direction of the transfer. Valid values are \"in\", \"out\", \"self\", or \"all\".\n- **timeLast**: Filter from a recent duration (e.g. \"24h\", \"7d\", \"30d\", etc.).\n- **timeGte/timeLte**: Filter from/to a specific timestamp in milliseconds.\n- **valueGte/valueLte**: Numeric filters on the raw token amount.\n- **usdGte/usdLte**: Numeric filters on the historical USD value of the transfer.\n- **from**: Comma-separated list of addresses, entities, or deposit services for the 'from' side.\n- **to**: Comma-separated list of addresses, entities, or deposit services for the 'to' side.\n- **tokens**: Comma-separated list of token addresses or token IDs.\n- **counterparties**: Comma-separated list of addresses or entities to treat strictly as counterparties.", "operationId": "GetTransfersHistogram", "parameters": [ { "name": "base", "in": "query", "description": "Filter from or to any of a comma separated list of entities or addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from or to any of a comma separated list of entities or addresses.", "example": [ "binance", "!wintermute" ] } }, { "name": "chains", "in": "query", "description": "List of chains to filter by.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "flow", "in": "query", "description": "Transfer direction.", "schema": { "$ref": "#/components/schemas/TransferFlow" } }, { "name": "from", "in": "query", "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "to", "in": "query", "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "counterparties", "in": "query", "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "schema": { "type": "array", "items": { "type": "string" }, "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "example": [ "binance" ] } }, { "name": "tokens", "in": "query", "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "timeGte", "in": "query", "description": "Filter after a specific time.", "schema": { "type": "string", "description": "Filter after a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Filter before a specific time.", "schema": { "type": "string", "description": "Filter before a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Filter using a duration string.", "schema": { "type": "string", "description": "Filter using a duration string.", "example": "24h" } }, { "name": "valueGte", "in": "query", "description": "Filter above a minimum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum token value.", "nullable": true, "example": "100.23" } }, { "name": "valueLte", "in": "query", "description": "Filter below a maximum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum token value.", "nullable": true, "example": "100.23" } }, { "name": "usdGte", "in": "query", "description": "Filter above a minimum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum USD value.", "nullable": true, "example": "100.23" } }, { "name": "usdLte", "in": "query", "description": "Filter below a maximum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum USD value.", "nullable": true, "example": "100.23" } }, { "name": "granularity", "in": "query", "description": "Granularity of histogram buckets. For time ranges over 30 days, only '1d' is valid.", "schema": { "$ref": "#/components/schemas/Granularity" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountSnapshot" }, "example": [ { "count": 1, "time": "2024-01-01T00:00:00Z", "usd": 1.23 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/transfers/histogram/simple": { "get": { "summary": "Get a simple histogram of transfers", "description": "Returns a simplified aggregated histogram of transfers over time.\n\n**Note**: For the full-featured histogram endpoint with all filter options, use /transfers/histogram which requires API authentication.", "operationId": "GetTransfersHistogramSimple", "parameters": [ { "name": "base", "in": "query", "description": "Filter from or to any of a comma separated list of entities or addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from or to any of a comma separated list of entities or addresses.", "example": [ "binance", "!wintermute" ] } }, { "name": "chains", "in": "query", "description": "List of chains to filter by.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "flow", "in": "query", "description": "Transfer direction.", "schema": { "$ref": "#/components/schemas/TransferFlow" } }, { "name": "from", "in": "query", "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "to", "in": "query", "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "counterparties", "in": "query", "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "schema": { "type": "array", "items": { "type": "string" }, "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "example": [ "binance" ] } }, { "name": "tokens", "in": "query", "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "timeGte", "in": "query", "description": "Filter after a specific time.", "schema": { "type": "string", "description": "Filter after a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Filter before a specific time.", "schema": { "type": "string", "description": "Filter before a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Filter using a duration string.", "schema": { "type": "string", "description": "Filter using a duration string.", "example": "24h" } }, { "name": "valueGte", "in": "query", "description": "Filter above a minimum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum token value.", "nullable": true, "example": "100.23" } }, { "name": "valueLte", "in": "query", "description": "Filter below a maximum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum token value.", "nullable": true, "example": "100.23" } }, { "name": "usdGte", "in": "query", "description": "Filter above a minimum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum USD value.", "nullable": true, "example": "100.23" } }, { "name": "usdLte", "in": "query", "description": "Filter below a maximum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum USD value.", "nullable": true, "example": "100.23" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountSnapshot" }, "example": [ { "count": 1, "time": "2024-01-01T00:00:00Z", "usd": 1.23 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/transfers/tx/{hash}": { "get": { "summary": "Get transfers for a transaction", "description": "Returns the transfers of a given type (external, internal, or token) within a single transaction, identified by its hash. Supported on EVM chains and Tron; other chains return an empty list. For Solana and other non-EVM transactions, use GET /tx/{hash} to retrieve the transaction's details instead.", "operationId": "GetTransfersForTransaction", "parameters": [ { "name": "transferType", "in": "query", "description": "Type of transfers to return. 'external' = native value transfers, 'internal' = trace calls, 'token' = ERC-20/TRC-20 transfers.", "required": true, "schema": { "enum": [ "external", "internal", "token" ], "type": "string", "description": "Type of transfers to return. 'external' = native value transfers, 'internal' = trace calls, 'token' = ERC-20/TRC-20 transfers.", "example": "token" } }, { "name": "chain", "in": "query", "description": "The blockchain network the transaction is on.", "required": true, "schema": { "$ref": "#/components/schemas/Chain" } }, { "name": "hash", "in": "path", "description": "The transaction hash to retrieve transfers for.", "required": true, "schema": { "type": "string", "description": "The transaction hash to retrieve transfers for.", "example": "0xf141a777ec5211657989b167d137dbc74f1a97984ba8ce3925bd640b78702587" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichedTransfer" }, "example": [ { "blockHash": "0x3dac10e206e1da667c23f11ed8e2bca60bcc3bfc63890ae01c28c011ded90dda", "blockNumber": 25294069, "blockTimestamp": "2026-06-11T11:58:35Z", "chain": "ethereum", "fromAddress": { "address": "0x628E97b796c7186a16d372d2a0717De2d1DB1Cf9", "arkhamLabel": { "address": "0x628E97b796c7186a16d372d2a0717De2d1DB1Cf9", "chainType": "evm", "name": "Bitget Deposit" }, "chain": "ethereum", "contract": false, "depositServiceID": "bitget", "isUserAddress": false }, "fromIsContract": false, "historicalUSD": 100, "id": "0xf141a777ec5211657989b167d137dbc74f1a97984ba8ce3925bd640b78702587_472", "toAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "id": "binance", "name": "Binance", "note": "", "service": null, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Hot Wallet" }, "chain": "ethereum", "contract": false, "isUserAddress": false }, "toIsContract": false, "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "tokenDecimals": 6, "tokenId": "usd-coin", "tokenName": "USD Coin", "tokenSymbol": "USDC", "transactionHash": "0xf141a777ec5211657989b167d137dbc74f1a97984ba8ce3925bd640b78702587", "type": "token", "unitValue": 100 } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/transfers/unenriched": { "get": { "summary": "Get unenriched transfers", "description": "Retrieves a list of transfers based on the same query filters as GET /transfers, but returns raw addresses without Arkham address intelligence.\n\nThis endpoint uses the transfer search index and token/transaction metadata enrichment, but it does not enrich transfer counterparties with Arkham entities, labels, deposit services, or predicted entities.", "operationId": "GetUnenrichedTransfers", "parameters": [ { "name": "base", "in": "query", "description": "Filter from or to any of a comma separated list of entities or addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from or to any of a comma separated list of entities or addresses.", "example": [ "binance", "!wintermute" ] } }, { "name": "chains", "in": "query", "description": "List of chains to filter by.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "flow", "in": "query", "description": "Transfer direction.", "schema": { "$ref": "#/components/schemas/TransferFlow" } }, { "name": "from", "in": "query", "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter from any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "to", "in": "query", "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter to any of a comma separated list of addresses, entities, or deposit services. You can also use special syntax like 'type:cex' to filter on entity types or 'deposit:binance' to filter on deposit addresses.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] } }, { "name": "counterparties", "in": "query", "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "schema": { "type": "array", "items": { "type": "string" }, "description": "list of addresses or entities to treat strictly as counterparties (only base \u003c-\u003e counterparty transfers).", "example": [ "binance" ] } }, { "name": "tokens", "in": "query", "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter involving any of a comma separated list of token addresses or token IDs.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] } }, { "name": "timeGte", "in": "query", "description": "Filter after a specific time.", "schema": { "type": "string", "description": "Filter after a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLte", "in": "query", "description": "Filter before a specific time.", "schema": { "type": "string", "description": "Filter before a specific time.", "nullable": true, "example": "2024-01-01T00:00:00Z" } }, { "name": "timeLast", "in": "query", "description": "Filter using a duration string.", "schema": { "type": "string", "description": "Filter using a duration string.", "example": "24h" } }, { "name": "valueGte", "in": "query", "description": "Filter above a minimum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum token value.", "nullable": true, "example": "100.23" } }, { "name": "valueLte", "in": "query", "description": "Filter below a maximum token value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum token value.", "nullable": true, "example": "100.23" } }, { "name": "usdGte", "in": "query", "description": "Filter above a minimum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter above a minimum USD value.", "nullable": true, "example": "100.23" } }, { "name": "usdLte", "in": "query", "description": "Filter below a maximum USD value.", "style": "deepObject", "explode": true, "schema": { "type": "string", "description": "Filter below a maximum USD value.", "nullable": true, "example": "100.23" } }, { "name": "sortKey", "in": "query", "description": "Field by which to sort the results. Custom sorting requires authentication; anonymous requests are always sorted by time, descending.", "schema": { "$ref": "#/components/schemas/TransferSortKey" } }, { "name": "sortDir", "in": "query", "description": "Direction for sorting results.", "schema": { "$ref": "#/components/schemas/SortDir" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return. Default: 20. Max: 1650.", "schema": { "type": "integer", "description": "Maximum number of results to return. Default: 20. Max: 1650.", "example": 10 } }, { "name": "offset", "in": "query", "description": "Pagination offset. offset + limit must not exceed 10000.", "schema": { "type": "integer", "description": "Pagination offset. offset + limit must not exceed 10000.", "example": 0 } }, { "name": "includeCursors", "in": "query", "description": "Include per-chain as-of cursors in the response. Default: false.", "schema": { "type": "boolean", "description": "Include per-chain as-of cursors in the response. Default: false.", "example": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichedTransfers" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/tx/{hash}": { "get": { "summary": "Get transaction details", "description": "Retrieves detailed information about a specific blockchain transaction using its hash.\n\nThe endpoint searches across all supported chains to find the transaction. If it is not found in confirmed transactions, it also checks the mempool for pending transactions.\n\n**Response shape.** The response body is a JSON object keyed by chain identifier (for example \"ethereum\"). Because the same hash format can appear on more than one chain, the object may contain more than one entry, one per chain on which the transaction was found. Each value holds that chain's transaction details. The exact set of fields varies by chain, but consumers can generally expect:\n\n- the block number and block timestamp the transaction was included in,\n- the sender and recipient addresses,\n- gas used and gas-related fields, along with the transaction fee,\n- the value transferred in native units and its USD value at the time,\n- token details for any tokens involved in the transfer.\n\n**Not found.** If the hash is not found on any supported chain (neither confirmed nor pending), the endpoint returns 404.", "operationId": "GetTransaction", "parameters": [ { "name": "hash", "in": "path", "description": "The transaction hash to look up.", "required": true, "schema": { "type": "string", "description": "The transaction hash to look up.", "example": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TxInfo" }, "example": {} } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/user/alerts": { "get": { "summary": "List your alerts", "description": "Returns every alert owned by the authenticated caller as a list of `AlertParam` objects. Results are unpaginated and in no particular order.", "operationId": "GetAlerts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertParam" }, "example": [ { "activelyFeatured": true, "alertMethodId": 1, "base": [ "abc123" ], "chains": [ "ethereum" ], "createdAt": "2024-01-01T00:00:00Z", "description": "abc123", "enabled": true, "from": [ "abc123" ], "id": 1, "name": "abc123", "ownerUID": "abc123", "shareable": true, "to": [ "abc123" ], "tokens": [ "abc123" ], "usdGte": 1.23, "usdLte": 1.23, "valueGte": 1.23, "valueLte": 1.23 } ] } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "summary": "Create an alert", "description": "Creates a new alert that notifies the caller when on-chain transfers match the supplied filter.\n\n**Request body** (`AlertRequest`):\n- **name**: Human-readable alert name.\n- **enabled**: Whether the alert delivers notifications. Disabled alerts are stored but do not notify.\n- **base / from / to**: Comma-separated address, entity, or deposit selectors in the same syntax as `GET /transfers`. Pass `[\"all\"]` on `base` to match every transfer (Pro only).\n- **tokens**: Token IDs or chain:address pairs to filter on.\n- **valueGte / valueLte**: Raw token amount bounds (on-chain units).\n- **usdGte / usdLte**: Historical USD value bounds.\n- **chains**: Optional subset of supported chains to scope the alert to.\n- **alertMethodId**: Required. ID of the notification channel that delivers this alert (see `GET /user/alertmethods`). Must be one of your own alert methods.\n- **description**: Optional free-form note.\n\n**Validation:** `alertMethodId` is required and must reference one of your own alert methods; omitting it or pointing it at a method you do not own returns `400`. Non-Pro users must supply at least one of a non-`\"all\"` `base`, a `from`, a `to`, a `tokens` filter, or a `usdGte \u003e= 10000000`. Pro users may create fully open alerts. Users are hard-capped at 1000 alerts.\n\n**Response:** The numeric ID of the new alert.", "operationId": "CreateAlert", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "example": 1 } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/user/alerts/{id}": { "delete": { "summary": "Delete an alert", "description": "Permanently deletes an alert owned by the caller.\n\n**Path parameter:**\n- **id**: The numeric ID of the alert to delete.\n\n**Response:** `204 No Content` on success.", "operationId": "DeleteAlert", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } }, "get": { "summary": "Get a single alert", "description": "Returns the `AlertParam` for one alert owned by the caller.\n\n**Path parameter:**\n- **id**: The numeric ID of the alert.\n\n**Response:** `404 Not Found` if the alert does not exist or is owned by a different user.", "operationId": "GetAlert", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertParam" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } }, "put": { "summary": "Update an alert", "description": "Replaces the configuration of an existing alert. The caller must own the alert — 404 is returned otherwise.\n\n**Path parameter:**\n- **id**: The numeric ID of the alert to update.\n\n**Request body:** An `AlertRequest` with the desired new configuration — same shape as `POST /user/alerts`.\n\n**Validation:** Same Pro / non-Pro rules as `POST /user/alerts` — non-Pro users must still supply a restrictive filter or `usdGte \u003e= 10000000`.\n\n**Response:** `204 No Content` on success.", "operationId": "UpdateAlert", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAlertRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/user/entities": { "get": { "summary": "List all private entities", "description": "Retrieves all private entities for the authenticated user. Returns both user-created private entities and customized Arkham entities.\n\nUse the includeAddresses parameter to control whether address lists are included in the response (default: true).", "operationId": "ReadUserEntities", "parameters": [ { "name": "includeAddresses", "in": "query", "description": "Whether to include address lists in the response. Accepts 'true' or 'false'. Defaults to 'true'.", "schema": { "type": "string", "description": "Whether to include address lists in the response. Accepts 'true' or 'false'. Defaults to 'true'.", "example": "abc123" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UserEntity" }, { "$ref": "#/components/schemas/ArkhamEntity" } ], "example": { "addresses": { "abc123": [ "abc123" ] }, "createdAt": "2024-01-01T00:00:00Z", "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "updatedAt": "2024-01-01T00:00:00Z", "website": "https://binance.com" } }, "example": [ { "addresses": { "abc123": [ "abc123" ] }, "createdAt": "2024-01-01T00:00:00Z", "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "updatedAt": "2024-01-01T00:00:00Z", "website": "https://binance.com" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/user/entities/only_add/{id}": { "put": { "summary": "Update a private entity", "description": "Updates an existing private entity. Allows modification of the entity name, note, and associated addresses.\n\nFor user-created entities, the full entity is updated. For Arkham entities, only the user's custom address associations are updated. Maximum of 5000 addresses can be updated at once.", "operationId": "UpdateUserEntityOnlyAddAddresses", "parameters": [ { "name": "id", "in": "path", "description": "The entity ID to update. Can be a user-created entity ID or an Arkham entity ID.", "required": true, "schema": { "type": "string", "description": "The entity ID to update. Can be a user-created entity ID or an Arkham entity ID.", "example": "abc123" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserEntityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/user/entities/{id}": { "get": { "summary": "Get a private entity by ID", "description": "Retrieves a specific private entity by its ID. Returns the entity details including name, note, and associated addresses.\n\nSupports both user-created private entities and customized Arkham entities.", "operationId": "ReadUserEntity", "parameters": [ { "name": "id", "in": "path", "description": "The entity ID to retrieve. Can be a user-created entity ID or an Arkham entity ID.", "required": true, "schema": { "type": "string", "description": "The entity ID to retrieve. Can be a user-created entity ID or an Arkham entity ID.", "example": "binance" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/user/labels": { "get": { "summary": "Get user labels", "description": "Retrieves a list of labels for the authenticated user.", "operationId": "GetLabels", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "example": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } ] } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "summary": "Create labels", "description": "Creates one or more labels for the authenticated user.", "operationId": "PostLabels", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "nullable": true, "example": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "example": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } ] } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/volume/address/{address}": { "get": { "summary": "Get transfer volume for an address", "description": "Returns transfer volume snapshots for the specified address, broken down by chain.", "operationId": "GetAddressVolume", "parameters": [ { "name": "chains", "in": "query", "description": "List of chains to filter by. If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "address", "in": "path", "description": "The blockchain address to query transfer volume for.", "required": true, "schema": { "type": "string", "description": "The blockchain address to query transfer volume for.", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/VolumeSnapshot" }, "example": [ { "time": "2024-01-01T00:00:00Z", "volumes": [ { "depositedUSD": 1.23, "exchangeID": "binance", "exchangeName": "binance", "withdrawnUSD": 1.23 } ] } ] }, "example": { "abc123": [ { "time": "2024-01-01T00:00:00Z", "volumes": [ { "depositedUSD": 1.23, "exchangeID": "binance", "exchangeName": "binance", "withdrawnUSD": 1.23 } ] } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/volume/entity/{entity}": { "get": { "summary": "Get transfer volume for an entity", "description": "Returns transfer volume snapshots for the specified entity, broken down by chain.", "operationId": "GetEntityVolume", "parameters": [ { "name": "chains", "in": "query", "description": "List of chains to filter by. If omitted, returns data across all supported chains.", "schema": { "$ref": "#/components/schemas/Chains" } }, { "name": "entity", "in": "path", "description": "The entity ID to query transfer volume for.", "required": true, "schema": { "type": "string", "description": "The entity ID to query transfer volume for.", "example": "binance" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/VolumeSnapshot" }, "example": [ { "time": "2024-01-01T00:00:00Z", "volumes": [ { "depositedUSD": 1.23, "exchangeID": "binance", "exchangeName": "binance", "withdrawnUSD": 1.23 } ] } ] }, "example": { "abc123": [ { "time": "2024-01-01T00:00:00Z", "volumes": [ { "depositedUSD": 1.23, "exchangeID": "binance", "exchangeName": "binance", "withdrawnUSD": 1.23 } ] } ] } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/ws/active_connections": { "get": { "summary": "Get active WebSocket connections (deprecated — use v2)", "description": "**Deprecated:** Use the v2 WebSocket stream endpoints instead (see GET /ws/v2/streams).\n\nReturns the number of active WebSocket connections for the authenticated user.", "operationId": "GetActiveWebSocketConnections", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActiveWebSocketConnectionsResponse" } } } }, "500": { "description": "Internal Server Error" } } } }, "/ws/session-info": { "get": { "summary": "Get WebSocket pricing info (deprecated — use v2)", "description": "**Deprecated:** v1 session pricing. Use the v2 WebSocket stream endpoints instead (see GET /ws/v2/streams) — v2 has no per-session fee.\n\nReturns the current pricing information for WebSocket sessions, including the credit cost per session creation and per transfer received.", "operationId": "GetWebSocketSessionInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSocketSessionInfoResponse" } } } }, "500": { "description": "Internal Server Error" } } } }, "/ws/sessions": { "get": { "summary": "List WebSocket sessions (deprecated — use v2)", "description": "**Deprecated:** Use the v2 WebSocket stream endpoints instead (see GET /ws/v2/streams).\n\nReturns all WebSocket sessions for the authenticated user, including usage statistics and connection status.", "operationId": "GetWebSocketSessions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebSocketSessionResponse" }, "example": [ { "createdAt": "2026-07-14T09:12:43Z", "isActive": true, "isConnected": true, "sessionId": "ws_Ab3xK9pQ_1782149114960780310", "transfersUsed": 1 } ] } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "summary": "Create WebSocket session (deprecated — use v2)", "description": "**Deprecated:** Use the v2 WebSocket stream endpoints instead. See GET /ws/v2/streams for details. V2 offers lower cost (no session creation fee) and better performance.\n\nCreates a new WebSocket session for real-time transfer streaming.\n\nYou must create a session before connecting to the WebSocket stream. The returned sessionId should be passed as a query parameter when connecting: wss://api.arkm.com/ws/transfers?session_id=\u003csessionId\u003e\n\n**Billing:** Session creation costs API credits. Check GET /ws/session-info for current pricing.", "operationId": "CreateWebSocketSession", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebSocketSessionResponse" } } } }, "500": { "description": "Internal Server Error" } } } }, "/ws/sessions/{id}": { "delete": { "summary": "Delete WebSocket session (deprecated — use v2)", "description": "**Deprecated:** Use the v2 WebSocket stream endpoints instead (see GET /ws/v2/streams).\n\nDeletes a WebSocket session. Any active connection using this session will be disconnected.", "operationId": "DeleteWebSocketSession", "parameters": [ { "name": "id", "in": "path", "description": "The session ID to delete", "required": true, "schema": { "type": "string", "description": "The session ID to delete", "example": "ws_Ab3xK9pQ_1782149114960780310" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string", "example": "abc123" }, "example": { "message": "session deleted successfully" } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } }, "get": { "summary": "Get WebSocket session status (deprecated — use v2)", "description": "**Deprecated:** Use the v2 WebSocket stream endpoints instead (see GET /ws/v2/streams).\n\nReturns the status and usage details for a specific WebSocket session, including transfer count and connection status.", "operationId": "GetWebSocketSessionStatus", "parameters": [ { "name": "id", "in": "path", "description": "The session ID to retrieve", "required": true, "schema": { "type": "string", "description": "The session ID to retrieve", "example": "ws_Ab3xK9pQ_1782149114960780310" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSocketSessionResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/ws/transfers": { "get": { "summary": "WebSocket transfer streaming (deprecated — use v2)", "description": "**Deprecated:** This is the v1 WebSocket endpoint. Use the v2 WebSocket stream endpoints for improved cost and performance. See GET /ws/v2/streams for details.\n\nWebSocket endpoint for streaming real-time blockchain transfers.\n\n**Getting Started:**\n1. Create a session by calling POST /ws/sessions - this returns a sessionId\n2. Connect to wss://api.arkm.com/ws/transfers?session_id=\u003cyour-session-id\u003e with your API-Key header\n3. Send a subscribe message with your transfer filters to start receiving data\n\n**Query Parameters:**\n- session_id (required) - Your session ID from POST /ws/sessions\n- fresh (optional) - Set to true to clear pending notifications from a previous connection\n\n**Client Messages:**\n- subscribe: Create a filter to receive matching transfers (1 per session)\n- unsubscribe: Remove your filter by ID\n\n**Server Messages:**\n- transfer: Real-time transfer notification matching your filters\n- ack: Acknowledgment for successful operations\n- error: Error notifications (codes: INVALID_PAYLOAD, INVALID_FILTER, FILTER_EXISTS, NO_SESSION, INTERNAL_ERROR)\n\nEach message is a JSON envelope of the form {\"type\":\"transfer\",\"payload\":{\"transfer\":{...},\"alertId\":123}}. Read payload.transfer for the transfer object; its fields match a GET /transfers row and vary by chain (UTXO chains such as bitcoin omit tokenSymbol and use fromAddresses).\n\n**Filter Requirements:**\n- Must include at least one of: base, from, to, tokens, or usdGte \u003e= 250,000\n\n**Billing:** Each transfer received consumes API credits.", "operationId": "HandleWebSocketTransfers", "responses": { "101": { "description": "Switching Protocols" }, "500": { "description": "Internal Server Error" } } } }, "/ws/v2/streams": { "get": { "summary": "List WebSocket v2 streams", "description": "Returns all WebSocket v2 streams for the authenticated user.\n\n**How v2 works (3 steps):**\n1. **Create** a stream with your transfer filter via POST /ws/v2/streams — the filter uses the same fields as GET /transfers, sent as a JSON request body\n2. **Connect** via WebSocket: wss://api.arkm.com/ws/v2/transfers?stream_id=\u003cstreamId\u003e with your API-Key header\n3. **Receive** transfers automatically — no subscribe/unsubscribe messages needed\n\n**Key differences from v1:** In v2, each stream has exactly one filter set at creation time via a JSON request body on POST /ws/v2/streams. There is no need to send subscribe/unsubscribe messages over the WebSocket — transfers are delivered automatically as soon as you connect. The filter fields are the same as GET /transfers (base, from, to, chains, tokens, usdGte, etc.).\n\n**Reconnection:** Streams expire after 10 minutes of inactivity. Reconnecting within 10 minutes reactivates the stream and delivers any transfers that occurred while disconnected.\n\n**Limits:** Maximum 10 active streams per user (contact sales for higher limits).\n\n**Billing:** 2 credits per transfer delivered. Stream creation, listing, and deletion are free.", "operationId": "GetWebSocketStreamsV2", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StreamV2Response" }, "example": [ { "createdAt": "2026-07-14T09:12:43Z", "id": 173943, "isConnected": true, "lastActive": "2026-07-15T10:16:35Z", "streamId": "e561dd5b-a24d-4669-bbba-9e5cf37d5125", "transfersUsed": 1 } ] } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "summary": "Create a WebSocket v2 stream", "description": "Creates a new WebSocket v2 stream with the given transfer filter, sent as a JSON request body.\n\nThe filter is set at creation time and cannot be changed. To use a different filter, delete this stream and create a new one.\n\n**Filter requirements:** Must include at least one of: base, from, to, tokens, or usdGte \u003e= 250,000.\n\n**Filter parameters:**\n- **base** — Entity name or wallet address to monitor. Shows transfers where this appears as sender or receiver. E.g. \"binance\" or \"0x123abc\".\n- **chains** — List of blockchains to filter by. E.g. [\"ethereum\", \"bsc\"]. Omit to include all chains.\n- **flow** — Transfer direction relative to the base. Values: \"in\" (incoming), \"out\" (outgoing), \"self\" (self-transfers), \"all\" (default).\n- **from** — List of addresses, entities, or deposit services for the sender side. Supports special syntax: \"type:cex\" for all CEX addresses, \"deposit:binance\" for Binance deposit addresses.\n- **to** — List of addresses, entities, or deposit services for the receiver side. Same syntax as from.\n- **tokens** — List of token symbols or contract addresses. E.g. [\"ethereum\", \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\"].\n- **counterparties** — List of addresses or entities to treat strictly as counterparties. When set with base, only delivers transfers that flow directly between base and counterparty (base→counterparty or counterparty→base).\n- **usdGte** / **usdLte** — Minimum/maximum USD value of the transfer. usdGte can satisfy the filter requirement on its own if \u003e= 250,000.\n- **valueGte** / **valueLte** — Minimum/maximum raw token amount (not USD).\n\nAll address/entity parameters (base, from, to, counterparties) accept both raw wallet addresses and Arkham entity names. You do not need to use labeled entities — any wallet address works.\n\n**Billing:** Free. You are only charged when transfers are delivered (2 credits per transfer).", "operationId": "CreateWebSocketStreamV2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferFilter" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStreamV2Response" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/ws/v2/streams/{id}": { "delete": { "summary": "Delete a WebSocket v2 stream", "description": "Deletes a WebSocket v2 stream. Any active connection using this stream will be disconnected.\n\n**Billing:** Free.", "operationId": "DeleteWebSocketStreamV2", "parameters": [ { "name": "id", "in": "path", "description": "The streamId of the stream to delete, as returned by POST /ws/v2/streams. The numeric id from that response is not accepted here.", "required": true, "schema": { "type": "string", "description": "The streamId of the stream to delete, as returned by POST /ws/v2/streams. The numeric id from that response is not accepted here.", "example": "e561dd5b-a24d-4669-bbba-9e5cf37d5125" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStreamV2Response" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/ws/v2/transfers": { "get": { "summary": "WebSocket v2 transfer streaming", "description": "Connect to a v2 stream to receive real-time transfer notifications.\n\n**Query Parameters:**\n- stream_id (required) — The stream ID from POST /ws/v2/streams\n\nTransfers matching the stream's filter are delivered automatically — no subscribe/unsubscribe messages needed. Each message is a JSON envelope: {\"type\":\"transfer\",\"payload\":{\"transfer\":{...},\"alertId\":N}}. The payload.transfer object has the same schema as GET /transfers responses.\n\n**Reconnection and replay:** Streams expire after 10 minutes of inactivity. If you reconnect within 10 minutes, the stream reactivates and any transfers that matched your filter while disconnected are delivered immediately. After 10 minutes of inactivity the stream is cleaned up and you must create a new one.\n\n**Billing:** 2 credits per transfer delivered.", "operationId": "HandleWebSocketTransfersV2", "responses": { "101": { "description": "Switching Protocols" }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "Address": { "required": [ "address", "chain" ], "type": "object", "properties": { "address": { "type": "string", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" }, "arkhamEntity": { "$ref": "#/components/schemas/Entity" }, "arkhamLabel": { "$ref": "#/components/schemas/Label" }, "chain": { "$ref": "#/components/schemas/Chain" }, "contract": { "type": "boolean", "nullable": true, "example": false }, "depositServiceID": { "type": "string", "nullable": true, "example": "binance" }, "isShielded": { "type": "boolean", "nullable": true, "example": true }, "isUserAddress": { "type": "boolean", "nullable": true, "example": false }, "ownerAddress": { "$ref": "#/components/schemas/Address" }, "predictedEntity": { "$ref": "#/components/schemas/Entity" }, "program": { "type": "boolean", "nullable": true, "example": true }, "service": { "type": "boolean", "nullable": true, "example": true }, "userEntity": { "$ref": "#/components/schemas/Entity" }, "userLabel": { "$ref": "#/components/schemas/Label" } }, "example": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } }, "AddressEnriched": { "required": [ "address", "chain" ], "type": "object", "properties": { "address": { "type": "string", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" }, "arkhamEntity": { "$ref": "#/components/schemas/Entity" }, "arkhamLabel": { "$ref": "#/components/schemas/Label" }, "chain": { "$ref": "#/components/schemas/Chain" }, "clusterIds": { "type": "array", "items": { "type": "string" }, "description": "Clusters are groups of addresses that have been linked together through on-chain heuristics (e.g., Bitcoin input clustering). Pass a value to GET /cluster/{id}/summary.", "nullable": true, "example": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ] }, "contract": { "type": "boolean", "nullable": true, "example": false }, "depositServiceID": { "type": "string", "nullable": true, "example": "binance" }, "isShielded": { "type": "boolean", "nullable": true, "example": true }, "isUserAddress": { "type": "boolean", "nullable": true, "example": false }, "ownerAddress": { "$ref": "#/components/schemas/Address" }, "populatedTags": { "type": "array", "items": { "$ref": "#/components/schemas/PopulatedTag" }, "example": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] }, "predictedEntity": { "$ref": "#/components/schemas/Entity" }, "program": { "type": "boolean", "nullable": true, "example": true }, "service": { "type": "boolean", "nullable": true, "example": true }, "userEntity": { "$ref": "#/components/schemas/Entity" }, "userLabel": { "$ref": "#/components/schemas/Label" } }, "example": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "clusterIds": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } }, "AddressLoanBalancesResponse": { "required": [ "addresses", "totalPositions", "balances" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Address" }, "example": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } }, "nullable": true, "example": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } }, "balances": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/LoanBalance" }, "example": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "balance": 1.23, "balanceExact": "abc123", "id": "usd-coin", "market": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USD Coin", "price": 1.23, "price24hAgo": 1.23, "protocol": "aave", "proxy": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "underlyingAssetSymbol": "USDC", "usd": 1.23 } ] }, "nullable": true, "example": { "abc123": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "balance": 1.23, "balanceExact": "abc123", "id": "usd-coin", "market": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USD Coin", "price": 1.23, "price24hAgo": 1.23, "protocol": "aave", "proxy": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "underlyingAssetSymbol": "USDC", "usd": 1.23 } ] } }, "totalPositions": { "type": "object", "additionalProperties": { "type": "number", "example": 1.23 }, "nullable": true, "example": { "abc123": 1.23 } } }, "example": { "addresses": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } }, "balances": { "abc123": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "balance": 1.23, "balanceExact": "abc123", "id": "usd-coin", "market": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USD Coin", "price": 1.23, "price24hAgo": 1.23, "protocol": "aave", "proxy": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "underlyingAssetSymbol": "USDC", "usd": 1.23 } ] }, "totalPositions": { "abc123": 1.23 } } }, "AddressMetrics": { "required": [ "balance_usd", "volume_usd", "transfers" ], "type": "object", "properties": { "balance_usd": { "type": "number", "description": "Current balance in USD.", "example": 1399819400.52 }, "first_tx": { "type": "string", "description": "Timestamp of first known transaction.", "format": "date-time", "nullable": true, "example": "2024-11-25T06:53:23Z" }, "last_tx": { "type": "string", "description": "Timestamp of most recent transaction.", "format": "date-time", "nullable": true, "example": "2026-02-01T14:59:35Z" }, "transfers": { "type": "integer", "description": "Total number of transfers.", "example": 33 }, "volume_usd": { "type": "number", "description": "Total transfer volume in USD.", "example": 1399862803.52 } }, "example": { "balance_usd": 1399819400.52, "first_tx": "2024-11-25T06:53:23Z", "last_tx": "2026-02-01T14:59:35Z", "transfers": 33, "volume_usd": 1399862803.52 } }, "AddressTagUpdate": { "required": [ "chain", "address", "tag_id", "status", "diff_ts", "diff_seq" ], "type": "object", "properties": { "address": { "type": "string", "description": "The blockchain address.", "example": "0x18e226459CCf0Eec276514a4fd3b226D8961e4d1" }, "category": { "type": "string", "description": "Tag category.", "nullable": true, "example": "Other" }, "chain": { "$ref": "#/components/schemas/Chain" }, "diff_seq": { "type": "integer", "description": "Sequence number for ordering changes within the same timestamp.", "example": 1930533 }, "diff_ts": { "type": "string", "description": "Timestamp when this change was detected.", "format": "date-time", "example": "2026-02-03T06:49:00Z" }, "entity_id": { "type": "string", "description": "Entity ID of the address owner, if identified.", "nullable": true, "example": "binance" }, "entity_name": { "type": "string", "description": "Display name of the entity.", "nullable": true, "example": "Binance" }, "entity_type": { "type": "string", "description": "Type of entity.", "nullable": true, "example": "cex" }, "label": { "type": "string", "description": "Rendered tag display name (template with parameters filled in).", "nullable": true, "example": "Early CATCOIN Holder" }, "rank": { "type": "integer", "description": "Tag priority rank (lower is higher priority).", "nullable": true, "example": 540 }, "status": { "type": "string", "description": "Change type: 'new' or 'deleted' (address tags are binary, no 'updated').", "example": "new" }, "tag_id": { "type": "string", "description": "Unique tag identifier.", "example": "early-token-holder" }, "tag_name": { "type": "string", "description": "Display name of the tag.", "nullable": true, "example": "Early Token Holder" }, "tag_params": { "type": "string", "description": "Tag-specific parameters (format varies by tag).", "nullable": true, "example": "{\"pricing_id\":\"catcoin-3\",\"symbol\":\"CATCOIN\"}" }, "template": { "type": "string", "description": "Tag template string for rendering the label.", "nullable": true, "example": "Early %s Holder" } }, "example": { "address": "0x18e226459CCf0Eec276514a4fd3b226D8961e4d1", "category": "Other", "chain": "ethereum", "diff_seq": 1930533, "diff_ts": "2026-02-03T06:49:00Z", "entity_id": "binance", "entity_name": "Binance", "entity_type": "cex", "label": "Early CATCOIN Holder", "rank": 540, "status": "new", "tag_id": "early-token-holder", "tag_name": "Early Token Holder", "tag_params": "{\"pricing_id\":\"catcoin-3\",\"symbol\":\"CATCOIN\"}", "template": "Early %s Holder" } }, "AddressTopHolder": { "required": [ "balance", "usd" ], "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "balance": { "type": "number", "example": 1500000000.5 }, "pctOfCap": { "type": "number", "nullable": true, "example": 0.025 }, "unrealizedPnlUsd": { "type": "number", "nullable": true, "example": 12345.67 }, "usd": { "type": "number", "example": 1500000000.5 } }, "example": { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "balance": 1500000000.5, "pctOfCap": 0.025, "unrealizedPnlUsd": 12345.67, "usd": 1500000000.5 } }, "AddressUpdate": { "required": [ "chain", "address", "label", "entity_id", "entity_name", "entity_type", "deposit_exchange_id", "service", "status", "diff_ts", "diff_seq" ], "type": "object", "properties": { "address": { "type": "string", "description": "The blockchain address.", "example": "0xaD354CfBAa4A8572DD6Df021514a3931A8329Ef5" }, "chain": { "$ref": "#/components/schemas/Chain" }, "cluster_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of address clusters this address belongs to.", "example": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ] }, "deposit_exchange_id": { "type": "string", "description": "Entity ID of the exchange this deposit address belongs to.", "nullable": true, "example": "binance" }, "diff_seq": { "type": "integer", "description": "Sequence number for ordering changes within the same timestamp.", "example": 16381934 }, "diff_ts": { "type": "string", "description": "Timestamp when this change was detected.", "format": "date-time", "example": "2025-04-09T00:00:00Z" }, "entity_id": { "type": "string", "description": "ID of the entity this address belongs to, if identified.", "nullable": true, "example": "binance" }, "entity_name": { "type": "string", "description": "Display name of the associated entity.", "nullable": true, "example": "Binance" }, "entity_type": { "type": "string", "description": "Type of entity.", "nullable": true, "example": "cex" }, "label": { "type": "string", "description": "Arkham label for this address.", "nullable": true, "example": "SingleOwnerMSCA (Proxy)" }, "metrics": { "$ref": "#/components/schemas/AddressMetrics" }, "populated_tags": { "type": "array", "items": { "$ref": "#/components/schemas/PopulatedTag" }, "description": "Tags applied to this address with full details.", "example": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] }, "predicted_entity": { "$ref": "#/components/schemas/PredictedEntity" }, "service": { "type": "boolean", "description": "Whether this is an exchange hot wallet address.", "example": true }, "status": { "type": "string", "description": "Change type: 'new', 'updated', or 'deleted'.", "example": "updated" } }, "example": { "address": "0xaD354CfBAa4A8572DD6Df021514a3931A8329Ef5", "chain": "ethereum", "cluster_ids": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "deposit_exchange_id": "binance", "diff_seq": 16381934, "diff_ts": "2025-04-09T00:00:00Z", "entity_id": "binance", "entity_name": "Binance", "entity_type": "cex", "label": "SingleOwnerMSCA (Proxy)", "metrics": { "balance_usd": 1399819400.52, "first_tx": "2024-11-25T06:53:23Z", "last_tx": "2026-02-01T14:59:35Z", "transfers": 33, "volume_usd": 1399862803.52 }, "populated_tags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predicted_entity": { "id": "binance", "name": "Binance", "type": "cex" }, "service": true, "status": "updated" } }, "AdminIntelUsageChainResult": { "required": [ "count" ], "type": "object", "properties": { "count": { "type": "integer", "description": "Intel data points consumed on this chain during the current billing period.", "example": 1284 } } }, "AlertParam": { "required": [ "id", "name", "enabled", "base", "createdAt", "shareable" ], "type": "object", "properties": { "activelyFeatured": { "type": "boolean", "nullable": true, "example": true }, "alertMethodId": { "type": "integer", "nullable": true, "example": 1 }, "base": { "type": "array", "items": { "type": "string", "example": "abc123" }, "nullable": true, "example": [ "abc123" ] }, "chains": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" }, "nullable": true, "example": [ "ethereum" ] }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "description": { "type": "string", "nullable": true, "example": "abc123" }, "enabled": { "type": "boolean", "example": true }, "from": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "abc123" }, "ownerUID": { "type": "string", "nullable": true, "example": "abc123" }, "shareable": { "type": "boolean", "example": true }, "to": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "tokens": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "usdGte": { "type": "number", "nullable": true, "example": 1.23 }, "usdLte": { "type": "number", "nullable": true, "example": 1.23 }, "valueGte": { "type": "number", "nullable": true, "example": 1.23 }, "valueLte": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "activelyFeatured": true, "alertMethodId": 1, "base": [ "abc123" ], "chains": [ "ethereum" ], "createdAt": "2024-01-01T00:00:00Z", "description": "abc123", "enabled": true, "from": [ "abc123" ], "id": 1, "name": "abc123", "ownerUID": "abc123", "shareable": true, "to": [ "abc123" ], "tokens": [ "abc123" ], "usdGte": 1.23, "usdLte": 1.23, "valueGte": 1.23, "valueLte": 1.23 } }, "AlertRequest": { "required": [ "name", "enabled", "base", "alertMethodId" ], "type": "object", "properties": { "alertMethodId": { "type": "integer", "example": 1 }, "base": { "type": "array", "items": { "type": "string", "example": "abc123" }, "nullable": true, "example": [ "abc123" ] }, "chains": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" }, "nullable": true, "example": [ "ethereum" ] }, "description": { "type": "string", "nullable": true, "example": "abc123" }, "enabled": { "type": "boolean", "example": true }, "from": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "name": { "type": "string", "example": "abc123" }, "to": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "tokens": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "usdGte": { "type": "number", "nullable": true, "example": 1.23 }, "usdLte": { "type": "number", "nullable": true, "example": 1.23 }, "valueGte": { "type": "number", "nullable": true, "example": 1.23 }, "valueLte": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "alertMethodId": 1, "base": [ "abc123" ], "chains": [ "ethereum" ], "description": "abc123", "enabled": true, "from": [ "abc123" ], "name": "abc123", "to": [ "abc123" ], "tokens": [ "abc123" ], "usdGte": 1.23, "usdLte": 1.23, "valueGte": 1.23, "valueLte": 1.23 } }, "AnalyticsDataPoint": { "required": [ "hour", "totalCalls", "totalCredits", "totalCostUnits", "callBreakdown", "creditBreakdown" ], "type": "object", "properties": { "callBreakdown": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Per-endpoint call counts for this hour.", "nullable": true, "example": { "/intelligence/address/{address}": 864, "/transfers": 420 } }, "creditBreakdown": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Per-endpoint credits consumed for this hour.", "nullable": true, "example": { "/intelligence/address/{address}": 5220, "/transfers": 2100 } }, "hour": { "type": "string", "description": "Bucket start time (UTC, truncated to the hour).", "format": "date-time", "example": "2026-05-26T14:00:00Z" }, "totalCalls": { "type": "integer", "description": "Total API calls made in this hour.", "example": 1284 }, "totalCostUnits": { "type": "integer", "description": "Total cost units in this hour (calls + row-billed units).", "example": 7320 }, "totalCredits": { "type": "integer", "description": "Total credits consumed in this hour.", "example": 7320 } }, "example": { "callBreakdown": { "/intelligence/address/{address}": 864, "/transfers": 420 }, "creditBreakdown": { "/intelligence/address/{address}": 5220, "/transfers": 2100 }, "hour": "2026-05-26T14:00:00Z", "totalCalls": 1284, "totalCostUnits": 7320, "totalCredits": 7320 } }, "AnalyticsResponse": { "required": [ "period", "startTime", "endTime", "dataPoints", "endpointInfos" ], "type": "object", "properties": { "dataPoints": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsDataPoint" }, "description": "Hourly data points covering the window.", "nullable": true, "example": [ { "callBreakdown": { "/intelligence/address/{address}": 864, "/transfers": 420 }, "creditBreakdown": { "/intelligence/address/{address}": 5220, "/transfers": 2100 }, "hour": "2026-05-26T14:00:00Z", "totalCalls": 1284, "totalCostUnits": 7320, "totalCredits": 7320 } ] }, "endTime": { "type": "string", "description": "End of the returned window (UTC).", "format": "date-time", "example": "2026-05-26T00:00:00Z" }, "endpointInfos": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointInfo" }, "description": "Metadata for each endpoint referenced in the breakdowns (display color, credit weight, billing unit).", "nullable": true, "example": [ { "color": "#4f46e5", "pattern": "/transfers", "unitType": "call", "weight": 5 } ] }, "period": { "type": "string", "description": "Time window the response covers. One of \"24h\", \"7d\", or \"30d\".", "example": "7d" }, "startTime": { "type": "string", "description": "Start of the returned window (UTC).", "format": "date-time", "example": "2026-05-19T00:00:00Z" } }, "example": { "dataPoints": [ { "callBreakdown": { "/intelligence/address/{address}": 864, "/transfers": 420 }, "creditBreakdown": { "/intelligence/address/{address}": 5220, "/transfers": 2100 }, "hour": "2026-05-26T14:00:00Z", "totalCalls": 1284, "totalCostUnits": 7320, "totalCredits": 7320 } ], "endTime": "2026-05-26T00:00:00Z", "endpointInfos": [ { "color": "#4f46e5", "pattern": "/transfers", "unitType": "call", "weight": 5 } ], "period": "7d", "startTime": "2026-05-19T00:00:00Z" } }, "ArkhamEntity": { "required": [ "name", "note", "id", "type", "service", "description" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "example": { "abc123": [ "abc123" ] } }, "crunchbase": { "type": "string", "nullable": true, "example": "https://www.crunchbase.com/organization/binance" }, "customImageSlug": { "type": "string", "nullable": true, "example": "binance" }, "customized": { "type": "boolean", "nullable": true, "example": true }, "description": { "type": "string", "example": "Binance is a global cryptocurrency exchange." }, "id": { "type": "string", "example": "binance" }, "instagram": { "type": "string", "nullable": true, "example": "https://www.instagram.com/binance" }, "linkShareable": { "type": "boolean", "nullable": true, "example": true }, "linkedin": { "type": "string", "nullable": true, "example": "https://www.linkedin.com/company/binance" }, "name": { "type": "string", "example": "Binance" }, "note": { "type": "string", "example": "" }, "ownerUID": { "type": "string", "example": "a1b2c3d4-5678-90ab-cdef-1234567890ab" }, "populatedTags": { "type": "array", "items": { "$ref": "#/components/schemas/PopulatedTag" }, "example": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] }, "service": { "type": "boolean", "nullable": true, "example": true }, "twitter": { "type": "string", "nullable": true, "example": "https://twitter.com/binance" }, "type": { "type": "string", "nullable": true, "example": "cex" }, "website": { "type": "string", "nullable": true, "example": "https://binance.com" } }, "example": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } }, "ArkhamTokensResponse": { "required": [ "spotTokens", "perpTokens" ], "type": "object", "properties": { "perpTokens": { "type": "array", "items": { "$ref": "#/components/schemas/Token" }, "nullable": true, "example": [ { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" } ] }, "spotTokens": { "type": "array", "items": { "$ref": "#/components/schemas/Token" }, "nullable": true, "example": [ { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" } ] } }, "example": { "perpTokens": [ { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" } ], "spotTokens": [ { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" } ] } }, "Balance": { "required": [ "name", "symbol", "id", "balance", "usd", "price", "quoteTime", "priceChange24hPercent", "priceChange24h" ], "type": "object", "properties": { "balance": { "type": "number", "example": 1250.75 }, "balanceExact": { "type": "string", "nullable": true, "example": "abc123" }, "ethereumAddress": { "type": "string", "nullable": true, "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7" }, "id": { "type": "string", "example": "tether" }, "name": { "type": "string", "example": "Tether" }, "price": { "type": "number", "example": 1 }, "priceChange24h": { "type": "number", "example": 1.23 }, "priceChange24hPercent": { "type": "number", "example": 1.23 }, "quoteTime": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "symbol": { "type": "string", "example": "USDT" }, "usd": { "type": "number", "example": 1250.75 } }, "example": { "balance": 1250.75, "balanceExact": "abc123", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 1.23, "priceChange24hPercent": 1.23, "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDT", "usd": 1250.75 } }, "BatchAddressEnrichedRequest": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "Array of blockchain addresses to query (max 1000). Supports EVM, Solana, Bitcoin, Tron, and other address formats.", "nullable": true, "example": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, "example": { "addresses": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, "BatchAddressEnrichedResponse": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AddressEnriched" }, "nullable": true, "example": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "clusterIds": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } }, "example": { "addresses": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "clusterIds": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } }, "BatchAddressRequest": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "Array of blockchain addresses to query (max 1000). Supports EVM, Solana, Bitcoin, Tron, and other address formats.", "nullable": true, "example": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, "example": { "addresses": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, "BatchAddressResponse": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Address" }, "nullable": true, "example": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } }, "example": { "addresses": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } }, "BatchAllAddressEnrichedRequest": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "Array of blockchain addresses to query (max 1000). Supports EVM, Solana, Bitcoin, Tron, and other address formats.", "nullable": true, "example": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, "example": { "addresses": [ "0x28C6c06298d514Db089934071355E5743bf21d60" ] } }, "BatchAllAddressEnrichedResponse": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AddressEnriched" }, "example": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "clusterIds": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } }, "nullable": true, "example": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "clusterIds": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } } }, "example": { "addresses": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "clusterIds": [ "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" ], "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } } }, "BatchAllAddressResponse": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Address" }, "example": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } }, "nullable": true, "example": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } } }, "example": { "addresses": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } } }, "Chain": { "enum": [ "ethereum", "polygon", "bsc", "optimism", "avalanche", "arbitrum_one", "base", "bitcoin", "tron", "flare", "solana", "dogecoin", "zcash", "hyperevm", "hypercore" ], "type": "string", "example": "ethereum" }, "Chains": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" }, "example": [ "ethereum", "bsc", "polygon" ] }, "ClusterSummary": { "required": [ "clusterId", "numAddresses", "volumeUsd", "balanceUsd", "firstTx", "lastTx" ], "type": "object", "properties": { "balanceUsd": { "type": "number", "example": 270448104.02 }, "clusterId": { "type": "string", "example": "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca" }, "firstTx": { "type": "string", "format": "date-time", "nullable": true, "example": "2018-11-12T14:22:37Z" }, "lastTx": { "type": "string", "format": "date-time", "nullable": true, "example": "2026-06-19T00:58:41Z" }, "numAddresses": { "type": "integer", "example": 1894908 }, "volumeUsd": { "type": "number", "example": 1782634995673.44 } }, "example": { "balanceUsd": 270448104.02, "clusterId": "00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca", "firstTx": "2018-11-12T14:22:37Z", "lastTx": "2026-06-19T00:58:41Z", "numAddresses": 1894908, "volumeUsd": 1782634995673.44 } }, "CountSnapshot": { "required": [ "time", "count" ], "type": "object", "properties": { "count": { "type": "integer", "example": 1 }, "time": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "usd": { "type": "number", "example": 1.23 } }, "example": { "count": 1, "time": "2024-01-01T00:00:00Z", "usd": 1.23 } }, "Counterparty": { "required": [ "address", "usd", "transactionCount", "flow", "chains" ], "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "chains": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" }, "description": "Chains on which this counterparty interacted with the queried subject.", "nullable": true, "example": [ "ethereum" ] }, "flow": { "type": "string", "description": "Direction of value flow relative to the queried address, e.g. in or out.", "example": "in" }, "transactionCount": { "minimum": 0, "type": "integer", "description": "Number of transfers between the queried subject and this counterparty.", "example": 223156 }, "usd": { "type": "number", "description": "Aggregated USD value of transfers between the queried subject and this counterparty.", "example": 331013556816.85 } }, "example": { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "chains": [ "ethereum" ], "flow": "in", "transactionCount": 223156, "usd": 331013556816.85 } }, "CounterpartyFlow": { "enum": [ "in", "out" ], "type": "string", "example": "in" }, "CreateStreamV2Response": { "required": [ "streamId", "id", "createdAt" ], "type": "object", "properties": { "createdAt": { "type": "string", "description": "Timestamp when the stream was created.", "format": "date-time", "example": "2026-07-14T09:12:43Z" }, "id": { "type": "integer", "description": "Internal database identifier for the stream. No endpoint accepts it — use streamId to connect to the WebSocket or to delete the stream.", "example": 173943 }, "streamId": { "type": "string", "description": "Identifier for the stream. Pass it as the stream_id query parameter on wss://api.arkm.com/ws/v2/transfers to connect, and as the path parameter on DELETE /ws/v2/streams/{id} to delete.", "example": "e561dd5b-a24d-4669-bbba-9e5cf37d5125" } }, "example": { "createdAt": "2026-07-14T09:12:43Z", "id": 173943, "streamId": "e561dd5b-a24d-4669-bbba-9e5cf37d5125" } }, "CreateWebSocketSessionResponse": { "required": [ "sessionId", "transfersUsed", "createdAt", "isActive" ], "type": "object", "properties": { "createdAt": { "type": "string", "description": "When the session was created", "format": "date-time", "example": "2026-07-14T09:12:43Z" }, "isActive": { "type": "boolean", "description": "Whether the session is active", "example": true }, "sessionId": { "type": "string", "description": "Unique session identifier to use with the WebSocket connection", "example": "ws_Ab3xK9pQ_1782149114960780310" }, "transfersUsed": { "type": "integer", "description": "Number of transfers received in this session", "example": 1 } }, "example": { "createdAt": "2026-07-14T09:12:43Z", "isActive": true, "sessionId": "ws_Ab3xK9pQ_1782149114960780310", "transfersUsed": 1 } }, "CreditUsagePeriod": { "required": [ "entityType", "entityId", "periodStart", "periodEnd", "creditsUsed", "creditsIncluded", "extraCredits", "status", "computedAt" ], "type": "object", "properties": { "computedAt": { "type": "string", "description": "When this usage snapshot was computed.", "format": "date-time", "example": "2026-05-01T00:05:12Z" }, "creditsIncluded": { "type": "integer", "description": "Plan credits included in the period.", "example": 500000 }, "creditsUsed": { "type": "integer", "description": "Total credits consumed during the period.", "example": 482350 }, "entityId": { "type": "string", "description": "Identifier of the billing entity (org ID or Firebase UID).", "example": "org_01HF8X3J0KQZ2N7T6P9YV4WB5R" }, "entityType": { "type": "string", "description": "Billing entity type: \"org\" or \"individual\".", "example": "org" }, "extraCredits": { "type": "integer", "description": "Overage credits purchased or accrued during the period.", "example": 0 }, "periodEnd": { "type": "string", "description": "Exclusive end of the billing period.", "format": "date-time", "example": "2026-05-01T00:00:00Z" }, "periodStart": { "type": "string", "description": "Inclusive start of the billing period.", "format": "date-time", "example": "2026-04-01T00:00:00Z" }, "status": { "type": "string", "description": "Period status: \"current\" or \"closed\".", "example": "closed" } }, "example": { "computedAt": "2026-05-01T00:05:12Z", "creditsIncluded": 500000, "creditsUsed": 482350, "entityId": "org_01HF8X3J0KQZ2N7T6P9YV4WB5R", "entityType": "org", "extraCredits": 0, "periodEnd": "2026-05-01T00:00:00Z", "periodStart": "2026-04-01T00:00:00Z", "status": "closed" } }, "DeleteStreamV2Response": { "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string", "description": "Confirmation message indicating the stream was deleted.", "example": "stream deleted" } }, "example": { "message": "stream deleted" } }, "EndpointInfo": { "required": [ "pattern", "color", "weight", "unitType" ], "type": "object", "properties": { "color": { "type": "string", "description": "Color used to render this endpoint in stacked-bar visualizations.", "example": "#4f46e5" }, "pattern": { "type": "string", "description": "Endpoint path pattern.", "example": "/transfers" }, "unitType": { "type": "string", "description": "Billing unit type: \"call\" (charged per request) or \"row\" (charged per returned row).", "example": "call" }, "weight": { "type": "integer", "description": "Credit weight per call for this endpoint.", "example": 5 } }, "example": { "color": "#4f46e5", "pattern": "/transfers", "unitType": "call", "weight": 5 } }, "EnrichedContract": { "required": [ "address", "bytecode", "functionSighashes", "isProxy", "proxyAddress", "blockTimestamp", "deployer", "internalDeployer", "transactionHash" ], "type": "object", "properties": { "address": { "type": "string", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "blockTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "bytecode": { "type": "string", "example": "0x608060405234801561001057600080fd5b50" }, "deployer": { "$ref": "#/components/schemas/Address" }, "functionSighashes": { "type": "array", "items": { "type": "string" }, "nullable": true, "example": [ "0xa9059cbb", "0x70a08231" ] }, "internalDeployer": { "$ref": "#/components/schemas/Address" }, "isProxy": { "type": "boolean", "example": true }, "proxyAddress": { "type": "string", "nullable": true, "example": "0x43506849D7C04F9138D1A2050bbF3A0c054402dd" }, "transactionHash": { "type": "string", "example": "0x2f1c5c2b44f771e942a8506148e256f94f1a464babc938ae0690c6e34cd79190" } }, "example": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "blockTimestamp": "2024-01-01T00:00:00Z", "bytecode": "0x608060405234801561001057600080fd5b50", "deployer": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "functionSighashes": [ "0xa9059cbb", "0x70a08231" ], "internalDeployer": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "isProxy": true, "proxyAddress": "0x43506849D7C04F9138D1A2050bbF3A0c054402dd", "transactionHash": "0x2f1c5c2b44f771e942a8506148e256f94f1a464babc938ae0690c6e34cd79190" } }, "EnrichedSwap": { "required": [ "id", "chain", "blockTimestamp", "blockNumber", "blockHash", "contractAddress", "sender", "receiver", "unitValue0", "unitValue1", "historicalUSD", "token0", "token0Id", "token0Name", "token0Symbol", "token0Decimals", "token1", "token1Id", "token1Name", "token1Symbol", "token1Decimals", "valid", "contractEntityId" ], "type": "object", "properties": { "blockHash": { "type": "string", "example": "0xafee41e450d43ff73ee299df5ebf74be3312938169bceb8fc5a62e851dbf469c" }, "blockNumber": { "minimum": 0, "type": "integer", "example": 25372029 }, "blockTimestamp": { "type": "string", "format": "date-time", "example": "2026-06-22T08:45:23Z" }, "chain": { "$ref": "#/components/schemas/Chain" }, "contractAddress": { "$ref": "#/components/schemas/Address" }, "contractEntityId": { "type": "string", "nullable": true, "example": "uniswap" }, "historicalUSD": { "type": "number", "example": 2309.996491 }, "id": { "type": "string", "example": "0x2f94ff18acfc3b2d55bfb1ed7b7cd995dab10dee7ee40863590dfd6b0ffd183b_25" }, "receiver": { "$ref": "#/components/schemas/Address" }, "sender": { "$ref": "#/components/schemas/Address" }, "token0": { "type": "string", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "token0Decimals": { "minimum": 0, "type": "integer", "nullable": true, "example": 6 }, "token0Id": { "type": "string", "nullable": true, "example": "usd-coin" }, "token0Name": { "type": "string", "nullable": true, "example": "USD Coin" }, "token0Symbol": { "type": "string", "nullable": true, "example": "USDC" }, "token1": { "type": "string", "example": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2" }, "token1Decimals": { "minimum": 0, "type": "integer", "nullable": true, "example": 18 }, "token1Id": { "type": "string", "nullable": true, "example": "weth" }, "token1Name": { "type": "string", "nullable": true, "example": "Wrapped Ether" }, "token1Symbol": { "type": "string", "nullable": true, "example": "WETH" }, "unitValue0": { "type": "number", "example": 2309.996491 }, "unitValue1": { "type": "number", "example": -1.3211934789020474 }, "valid": { "type": "boolean", "example": true } }, "example": { "blockHash": "0xafee41e450d43ff73ee299df5ebf74be3312938169bceb8fc5a62e851dbf469c", "blockNumber": 25372029, "blockTimestamp": "2026-06-22T08:45:23Z", "chain": "ethereum", "contractAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "contractEntityId": "uniswap", "historicalUSD": 2309.996491, "id": "0x2f94ff18acfc3b2d55bfb1ed7b7cd995dab10dee7ee40863590dfd6b0ffd183b_25", "receiver": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "sender": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "token0": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "token0Decimals": 6, "token0Id": "usd-coin", "token0Name": "USD Coin", "token0Symbol": "USDC", "token1": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", "token1Decimals": 18, "token1Id": "weth", "token1Name": "Wrapped Ether", "token1Symbol": "WETH", "unitValue0": 2309.996491, "unitValue1": -1.3211934789020474, "valid": true } }, "EnrichedSwaps": { "required": [ "swaps", "count" ], "type": "object", "properties": { "count": { "type": "integer", "example": 10000 }, "swaps": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichedSwap" }, "nullable": true, "example": [ { "blockHash": "0xafee41e450d43ff73ee299df5ebf74be3312938169bceb8fc5a62e851dbf469c", "blockNumber": 25372029, "blockTimestamp": "2026-06-22T08:45:23Z", "chain": "ethereum", "contractAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "contractEntityId": "uniswap", "historicalUSD": 2309.996491, "id": "0x2f94ff18acfc3b2d55bfb1ed7b7cd995dab10dee7ee40863590dfd6b0ffd183b_25", "receiver": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "sender": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "token0": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "token0Decimals": 6, "token0Id": "usd-coin", "token0Name": "USD Coin", "token0Symbol": "USDC", "token1": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", "token1Decimals": 18, "token1Id": "weth", "token1Name": "Wrapped Ether", "token1Symbol": "WETH", "unitValue0": 2309.996491, "unitValue1": -1.3211934789020474, "valid": true } ] } }, "example": { "count": 10000, "swaps": [ { "blockHash": "0xafee41e450d43ff73ee299df5ebf74be3312938169bceb8fc5a62e851dbf469c", "blockNumber": 25372029, "blockTimestamp": "2026-06-22T08:45:23Z", "chain": "ethereum", "contractAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "contractEntityId": "uniswap", "historicalUSD": 2309.996491, "id": "0x2f94ff18acfc3b2d55bfb1ed7b7cd995dab10dee7ee40863590dfd6b0ffd183b_25", "receiver": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "sender": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "token0": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "token0Decimals": 6, "token0Id": "usd-coin", "token0Name": "USD Coin", "token0Symbol": "USDC", "token1": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", "token1Decimals": 18, "token1Id": "weth", "token1Name": "Wrapped Ether", "token1Symbol": "WETH", "unitValue0": 2309.996491, "unitValue1": -1.3211934789020474, "valid": true } ] } }, "EnrichedTransfer": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TronEnrichedAnyTransfer" }, { "$ref": "#/components/schemas/EvmEnrichedAnyTransfer" }, { "$ref": "#/components/schemas/SolanaEnrichedAnyTransfer" } ], "example": { "assetId": "usd-coin", "blockID": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "blockNumber": 1, "blockTimestamp": "2024-01-01T00:00:00Z", "chain": "ethereum", "fromAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "fromIsContract": true, "historicalUSD": 1.23, "id": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "toAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "toIsContract": true, "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "tokenDecimals": 1, "tokenId": "usd-coin", "tokenName": "USD Coin", "tokenSymbol": "USDC", "transactionHash": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "unitValue": 1.23 } }, "EnrichedTransfers": { "required": [ "transfers", "count" ], "type": "object", "properties": { "count": { "type": "integer", "example": 10 }, "cursors": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Last durably committed and searchable enriched-transfer cursor for each chain in the query scope. Values may be slightly stale.", "example": { "ethereum": 454726633 } }, "transfers": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichedTransfer" }, "nullable": true, "example": [ { "assetId": "usd-coin", "blockID": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "blockNumber": 1, "blockTimestamp": "2024-01-01T00:00:00Z", "chain": "ethereum", "fromAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "fromIsContract": true, "historicalUSD": 1.23, "id": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "toAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "toIsContract": true, "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "tokenDecimals": 1, "tokenId": "usd-coin", "tokenName": "USD Coin", "tokenSymbol": "USDC", "transactionHash": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "unitValue": 1.23 } ] } }, "example": { "count": 10, "cursors": { "ethereum": 454726633 }, "transfers": [ { "assetId": "usd-coin", "blockID": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "blockNumber": 1, "blockTimestamp": "2024-01-01T00:00:00Z", "chain": "ethereum", "fromAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "fromIsContract": true, "historicalUSD": 1.23, "id": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "toAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "toIsContract": true, "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "tokenDecimals": 1, "tokenId": "usd-coin", "tokenName": "USD Coin", "tokenSymbol": "USDC", "transactionHash": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "unitValue": 1.23 } ] } }, "Entity": { "required": [ "name", "note", "id", "type", "service" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "example": { "abc123": [ "abc123" ] } }, "crunchbase": { "type": "string", "nullable": true, "example": "https://www.crunchbase.com/organization/binance" }, "customImageSlug": { "type": "string", "nullable": true, "example": "binance" }, "customized": { "type": "boolean", "nullable": true, "example": true }, "id": { "type": "string", "example": "binance" }, "instagram": { "type": "string", "nullable": true, "example": "https://www.instagram.com/binance" }, "linkShareable": { "type": "boolean", "nullable": true, "example": true }, "linkedin": { "type": "string", "nullable": true, "example": "https://www.linkedin.com/company/binance" }, "name": { "type": "string", "example": "Binance" }, "note": { "type": "string", "example": "" }, "ownerUID": { "type": "string", "example": "a1b2c3d4-5678-90ab-cdef-1234567890ab" }, "populatedTags": { "type": "array", "items": { "$ref": "#/components/schemas/PopulatedTag" }, "example": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] }, "service": { "type": "boolean", "nullable": true, "example": true }, "twitter": { "type": "string", "nullable": true, "example": "https://twitter.com/binance" }, "type": { "type": "string", "nullable": true, "example": "cex" }, "website": { "type": "string", "nullable": true, "example": "https://binance.com" } }, "example": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } }, "EntityBalanceChanges": { "required": [ "entityId", "entityName", "entityType", "balanceUnit", "prevBalanceUnit", "balanceUsd", "prevBalanceUsd", "tokenBalances" ], "type": "object", "properties": { "balanceUnit": { "type": "number", "example": 1.23 }, "balanceUsd": { "type": "number", "example": 1.23 }, "entityId": { "type": "string", "example": "binance" }, "entityName": { "type": "string", "example": "Binance" }, "entityType": { "type": "string", "example": "cex" }, "prevBalanceUnit": { "type": "number", "example": 1.23 }, "prevBalanceUsd": { "type": "number", "example": 1.23 }, "tokenBalances": { "type": "array", "items": { "required": [ "tokenId", "tokenSymbol", "balanceUnit", "prevBalanceUnit", "balanceUsd", "prevBalanceUsd" ], "type": "object", "properties": { "balanceUnit": { "type": "number", "example": 1.23 }, "balanceUsd": { "type": "number", "example": 1.23 }, "prevBalanceUnit": { "type": "number", "example": 1.23 }, "prevBalanceUsd": { "type": "number", "example": 1.23 }, "tokenId": { "type": "string", "example": "usd-coin" }, "tokenSymbol": { "type": "string", "example": "USDC" } }, "example": { "balanceUnit": 1.23, "balanceUsd": 1.23, "prevBalanceUnit": 1.23, "prevBalanceUsd": 1.23, "tokenId": "usd-coin", "tokenSymbol": "USDC" } }, "nullable": true, "example": [ { "balanceUnit": 1.23, "balanceUsd": 1.23, "prevBalanceUnit": 1.23, "prevBalanceUsd": 1.23, "tokenId": "usd-coin", "tokenSymbol": "USDC" } ] } }, "example": { "balanceUnit": 1.23, "balanceUsd": 1.23, "entityId": "binance", "entityName": "Binance", "entityType": "cex", "prevBalanceUnit": 1.23, "prevBalanceUsd": 1.23, "tokenBalances": [ { "balanceUnit": 1.23, "balanceUsd": 1.23, "prevBalanceUnit": 1.23, "prevBalanceUsd": 1.23, "tokenId": "usd-coin", "tokenSymbol": "USDC" } ] } }, "EntityBalanceChangesInterval": { "enum": [ "7d", "14d", "30d" ], "type": "string", "example": "7d" }, "EntityBalanceChangesOrderBy": { "enum": [ "balanceUsd", "balanceUsdChange", "balanceUsdPctChange", "balanceUnit", "balanceUnitChange", "balanceUnitPctChange" ], "type": "string", "example": "balanceUsd" }, "EntityBalanceChangesOrderDir": { "enum": [ "asc", "desc" ], "type": "string", "example": "asc" }, "EntityBalancesResponse": { "required": [ "entities", "totalBalance", "totalBalance24hAgo", "balances" ], "type": "object", "properties": { "balances": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Balance" }, "example": [ { "balance": 1250.75, "balanceExact": "abc123", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 1.23, "priceChange24hPercent": 1.23, "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDT", "usd": 1250.75 } ] }, "nullable": true, "example": { "abc123": [ { "balance": 1250.75, "balanceExact": "abc123", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 1.23, "priceChange24hPercent": 1.23, "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDT", "usd": 1250.75 } ] } }, "entities": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ArkhamEntity" }, "nullable": true, "example": { "abc123": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } } }, "totalBalance": { "type": "object", "additionalProperties": { "type": "number", "example": 1.23 }, "nullable": true, "example": { "abc123": 1.23 } }, "totalBalance24hAgo": { "type": "object", "additionalProperties": { "type": "number", "example": 1.23 }, "nullable": true, "example": { "abc123": 1.23 } } }, "example": { "balances": { "abc123": [ { "balance": 1250.75, "balanceExact": "abc123", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 1.23, "priceChange24hPercent": 1.23, "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDT", "usd": 1250.75 } ] }, "entities": { "abc123": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } }, "totalBalance": { "abc123": 1.23 }, "totalBalance24hAgo": { "abc123": 1.23 } } }, "EntityLoansBalancesResponse": { "required": [ "entities", "totalPositions", "balances" ], "type": "object", "properties": { "balances": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/LoanBalance" }, "example": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "balance": 1.23, "balanceExact": "abc123", "id": "usd-coin", "market": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USD Coin", "price": 1.23, "price24hAgo": 1.23, "protocol": "aave", "proxy": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "underlyingAssetSymbol": "USDC", "usd": 1.23 } ] }, "nullable": true, "example": { "abc123": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "balance": 1.23, "balanceExact": "abc123", "id": "usd-coin", "market": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USD Coin", "price": 1.23, "price24hAgo": 1.23, "protocol": "aave", "proxy": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "underlyingAssetSymbol": "USDC", "usd": 1.23 } ] } }, "entities": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ArkhamEntity" }, "nullable": true, "example": { "abc123": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } } }, "totalPositions": { "type": "object", "additionalProperties": { "type": "number", "example": 1.23 }, "nullable": true, "example": { "abc123": 1.23 } } }, "example": { "balances": { "abc123": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "balance": 1.23, "balanceExact": "abc123", "id": "usd-coin", "market": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USD Coin", "price": 1.23, "price24hAgo": 1.23, "protocol": "aave", "proxy": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "underlyingAssetSymbol": "USDC", "usd": 1.23 } ] }, "entities": { "abc123": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } }, "totalPositions": { "abc123": 1.23 } } }, "EntityMetrics": { "required": [ "address_count", "balance_usd", "volume_usd" ], "type": "object", "properties": { "address_count": { "type": "integer", "description": "Number of addresses associated with this entity.", "example": 60377768 }, "balance_usd": { "type": "number", "description": "Total balance across all addresses in USD.", "example": 248837164196.3 }, "first_tx": { "type": "string", "description": "Timestamp of first known transaction.", "format": "date-time", "nullable": true, "example": "2017-06-19T06:17:43Z" }, "last_tx": { "type": "string", "description": "Timestamp of most recent transaction.", "format": "date-time", "nullable": true, "example": "2026-02-12T23:59:59Z" }, "volume_usd": { "type": "number", "description": "Total transfer volume in USD.", "example": 43905586610785.82 } }, "example": { "address_count": 60377768, "balance_usd": 248837164196.3, "first_tx": "2017-06-19T06:17:43Z", "last_tx": "2026-02-12T23:59:59Z", "volume_usd": 43905586610785.82 } }, "EntityPrediction": { "required": [ "address", "entityID", "usdBalance" ], "type": "object", "properties": { "address": { "type": "string", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" }, "entityID": { "type": "string", "example": "binance" }, "usdBalance": { "type": "number", "example": 938079658.6 } }, "example": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "entityID": "binance", "usdBalance": 938079658.6 } }, "EntitySummary": { "required": [ "entityId", "numAddresses", "volumeUsd", "balanceUsd", "firstTx", "lastTx" ], "type": "object", "properties": { "balanceUsd": { "type": "number", "example": 237610738754.25 }, "entityId": { "type": "string", "example": "binance" }, "firstTx": { "type": "string", "format": "date-time", "nullable": true, "example": "2017-06-19T06:17:43Z" }, "lastTx": { "type": "string", "format": "date-time", "nullable": true, "example": "2026-06-19T00:58:41Z" }, "numAddresses": { "type": "integer", "example": 63893485 }, "volumeUsd": { "type": "number", "example": 48418640768311.48 } }, "example": { "balanceUsd": 237610738754.25, "entityId": "binance", "firstTx": "2017-06-19T06:17:43Z", "lastTx": "2026-06-19T00:58:41Z", "numAddresses": 63893485, "volumeUsd": 48418640768311.48 } }, "EntityTopHolder": { "required": [ "entity", "balance", "usd" ], "type": "object", "properties": { "balance": { "type": "number", "example": 1500000000.5 }, "entity": { "$ref": "#/components/schemas/Entity" }, "pctOfCap": { "type": "number", "nullable": true, "example": 0.025 }, "usd": { "type": "number", "example": 1500000000.5 } }, "example": { "balance": 1500000000.5, "entity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "pctOfCap": 0.025, "usd": 1500000000.5 } }, "EntityUpdate": { "required": [ "id", "name", "type", "status", "diff_ts", "diff_seq" ], "type": "object", "properties": { "city": { "type": "string", "description": "City of entity headquarters.", "nullable": true, "example": "Abu Dhabi" }, "country": { "type": "string", "description": "Country of entity headquarters (ISO 3166-1 alpha-3).", "nullable": true, "example": "ARE" }, "crunchbase_url": { "type": "string", "description": "Crunchbase profile URL.", "nullable": true, "example": "https://www.crunchbase.com/organization/binance" }, "diff_seq": { "type": "integer", "description": "Sequence number for ordering changes within the same timestamp.", "example": 103484 }, "diff_ts": { "type": "string", "description": "Timestamp when this change was detected.", "format": "date-time", "example": "2026-02-06T02:40:38Z" }, "id": { "type": "string", "description": "Unique entity identifier.", "example": "binance" }, "instagram_url": { "type": "string", "description": "Instagram profile URL.", "nullable": true, "example": "https://www.instagram.com/binance" }, "linkedin_url": { "type": "string", "description": "LinkedIn profile URL.", "nullable": true, "example": "https://www.linkedin.com/company/binance" }, "metrics": { "$ref": "#/components/schemas/EntityMetrics" }, "name": { "type": "string", "description": "Display name of the entity.", "nullable": true, "example": "Binance" }, "region": { "type": "string", "description": "Region/state of entity headquarters.", "nullable": true, "example": "Abu Dhabi" }, "shortname": { "type": "string", "description": "Short display name.", "nullable": true, "example": "Binance" }, "status": { "type": "string", "description": "Change type: 'new', 'updated', or 'deleted'.", "example": "new" }, "twitter_url": { "type": "string", "description": "Entity Twitter/X profile URL.", "nullable": true, "example": "https://twitter.com/binance" }, "type": { "type": "string", "description": "Entity type.", "nullable": true, "example": "cex" }, "website_url": { "type": "string", "description": "Entity website URL.", "nullable": true, "example": "https://binance.com" } }, "example": { "city": "Abu Dhabi", "country": "ARE", "crunchbase_url": "https://www.crunchbase.com/organization/binance", "diff_seq": 103484, "diff_ts": "2026-02-06T02:40:38Z", "id": "binance", "instagram_url": "https://www.instagram.com/binance", "linkedin_url": "https://www.linkedin.com/company/binance", "metrics": { "address_count": 60377768, "balance_usd": 248837164196.3, "first_tx": "2017-06-19T06:17:43Z", "last_tx": "2026-02-12T23:59:59Z", "volume_usd": 43905586610785.82 }, "name": "Binance", "region": "Abu Dhabi", "shortname": "Binance", "status": "new", "twitter_url": "https://twitter.com/binance", "type": "cex", "website_url": "https://binance.com" } }, "EvmEnrichedAnyTransfer": { "required": [ "id", "transactionHash", "fromAddress", "fromIsContract", "toAddress", "toIsContract", "tokenAddress", "type", "blockTimestamp", "blockNumber", "blockHash", "tokenName", "tokenSymbol", "tokenDecimals", "unitValue", "tokenId", "historicalUSD", "chain" ], "type": "object", "properties": { "blockHash": { "type": "string", "example": "0xb73b329bad7428bdace6623dcd18743fca05b136116c261b63224176d831d" }, "blockNumber": { "minimum": 0, "type": "integer", "example": 22630280 }, "blockTimestamp": { "type": "string", "format": "date-time", "example": "2025-06-04T09:07:47Z" }, "chain": { "$ref": "#/components/schemas/Chain" }, "fromAddress": { "$ref": "#/components/schemas/Address" }, "fromIsContract": { "type": "boolean", "example": false }, "historicalUSD": { "type": "number", "example": 685673.692 }, "id": { "type": "string", "example": "0xded143b3e5dd3c9f6987783d0f0f2af1cec746553113a015a23f1213038b3972" }, "toAddress": { "$ref": "#/components/schemas/Address" }, "toIsContract": { "type": "boolean", "example": false }, "tokenAddress": { "type": "string", "nullable": true, "example": "null" }, "tokenDecimals": { "minimum": 0, "type": "integer", "nullable": true, "example": 18 }, "tokenId": { "type": "string", "nullable": true, "example": "ethereum" }, "tokenName": { "type": "string", "nullable": true, "example": "Ethereum" }, "tokenSymbol": { "type": "string", "nullable": true, "example": "ETH" }, "transactionHash": { "type": "string", "example": "0xded143b3e5dd3c9f6987783d0f0f2af1cec746553113a015a23f121" }, "type": { "type": "string", "example": "external" }, "unitValue": { "type": "number", "example": 259.6 } } }, "FlowSnapshot": { "required": [ "time", "inflow", "outflow", "cumulativeInflow", "cumulativeOutflow" ], "type": "object", "properties": { "cumulativeInflow": { "type": "number", "example": 1.23 }, "cumulativeOutflow": { "type": "number", "example": 1.23 }, "inflow": { "type": "number", "example": 1.23 }, "outflow": { "type": "number", "example": 1.23 }, "time": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "example": { "cumulativeInflow": 1.23, "cumulativeOutflow": 1.23, "inflow": 1.23, "outflow": 1.23, "time": "2024-01-01T00:00:00Z" } }, "GetARKMCirculatingResponse": { "required": [ "amount" ], "type": "object", "properties": { "amount": { "type": "integer", "description": "Circulating supply, in whole ARKM tokens.", "example": 658912429 } }, "example": { "amount": 658912429 } }, "GetActiveWebSocketConnectionsResponse": { "required": [ "activeConnections" ], "type": "object", "properties": { "activeConnections": { "type": "integer", "description": "Number of currently active WebSocket connections", "example": 1 } }, "example": { "activeConnections": 1 } }, "GetAddressBalancesResponse": { "required": [ "addresses", "totalBalance", "totalBalance24hAgo", "balances" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Address" }, "example": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } }, "nullable": true, "example": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } } }, "balances": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Balance" }, "example": [ { "balance": 1250.75, "balanceExact": "abc123", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 1.23, "priceChange24hPercent": 1.23, "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDT", "usd": 1250.75 } ] }, "nullable": true, "example": { "abc123": [ { "balance": 1250.75, "balanceExact": "abc123", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 1.23, "priceChange24hPercent": 1.23, "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDT", "usd": 1250.75 } ] } }, "totalBalance": { "type": "object", "additionalProperties": { "type": "number", "example": 1.23 }, "nullable": true, "example": { "abc123": 1.23 } }, "totalBalance24hAgo": { "type": "object", "additionalProperties": { "type": "number", "example": 1.23 }, "nullable": true, "example": { "abc123": 1.23 } } }, "example": { "addresses": { "abc123": { "abc123": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } } }, "balances": { "abc123": [ { "balance": 1250.75, "balanceExact": "abc123", "ethereumAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "id": "tether", "name": "Tether", "price": 1, "priceChange24h": 1.23, "priceChange24hPercent": 1.23, "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDT", "usd": 1250.75 } ] }, "totalBalance": { "abc123": 1.23 }, "totalBalance24hAgo": { "abc123": 1.23 } } }, "GetAltcoinIndexResponse": { "required": [ "altcoinIndex" ], "type": "object", "properties": { "altcoinIndex": { "type": "integer", "description": "Altcoin Index value from 0 to 100. Higher values indicate altcoins are outperforming Bitcoin.", "example": 63 } }, "example": { "altcoinIndex": 63 } }, "GetRiskScoreAddressBatchRequest": { "required": [ "addresses" ], "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "example": "abc123" }, "description": "List of blockchain addresses to fetch risk scores for (max 200).", "nullable": true, "example": [ "abc123" ] } }, "example": { "addresses": [ "abc123" ] } }, "GetRiskScoreAddressPathsResponse": { "required": [ "address", "paths" ], "type": "object", "properties": { "address": { "type": "string", "description": "The queried address.", "example": "0x6068A806a62DBb6a42E1A83e17E249bF4f8dB3aB" }, "paths": { "type": "array", "items": { "$ref": "#/components/schemas/RiskScorePathAPIType" }, "description": "Top-contributing seed paths to this address, ordered by contribution USD.", "nullable": true, "example": [ { "chain_type": "evm", "contribution_usd": 1.23, "direction": "forward", "hop_distance": 1, "path_nodes": [ { "address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A", "hop_distance": 0 } ], "risk_category": "hacker", "score": 1, "seed_address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A" } ] } }, "example": { "address": "0x6068A806a62DBb6a42E1A83e17E249bF4f8dB3aB", "paths": [ { "chain_type": "evm", "contribution_usd": 1.23, "direction": "forward", "hop_distance": 1, "path_nodes": [ { "address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A", "hop_distance": 0 } ], "risk_category": "hacker", "score": 1, "seed_address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A" } ] } }, "GetRiskScoreEntityBatchRequest": { "required": [ "entity_ids" ], "type": "object", "properties": { "entity_ids": { "type": "array", "items": { "type": "string", "example": "abc123" }, "description": "List of entity IDs to fetch risk scores for (max 200).", "nullable": true, "example": [ "abc123" ] } }, "example": { "entity_ids": [ "abc123" ] } }, "GetTopTokensResponse": { "required": [ "tokens", "total" ], "type": "object", "properties": { "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/TopToken" }, "nullable": true, "example": [ { "current": { "inflowCexVolume": 1.23, "inflowDexVolume": 1.23, "outflowCexVolume": 1.23, "outflowDexVolume": 1.23, "price": 1.23 }, "previous": { "inflowCexVolume": 1.23, "inflowDexVolume": 1.23, "outflowCexVolume": 1.23, "outflowDexVolume": 1.23, "price": 1.23 }, "token": { "id": "usd-coin", "marketCap": 1.23, "symbol": "USDC" } } ] }, "total": { "type": "integer", "example": 1 } }, "example": { "tokens": [ { "current": { "inflowCexVolume": 1.23, "inflowDexVolume": 1.23, "outflowCexVolume": 1.23, "outflowDexVolume": 1.23, "price": 1.23 }, "previous": { "inflowCexVolume": 1.23, "inflowDexVolume": 1.23, "outflowCexVolume": 1.23, "outflowDexVolume": 1.23, "price": 1.23 }, "token": { "id": "usd-coin", "marketCap": 1.23, "symbol": "USDC" } } ], "total": 1 } }, "Granularity": { "enum": [ "1h", "1d" ], "type": "string", "example": "1h" }, "HistorySnapshot": { "required": [ "time", "usd" ], "type": "object", "properties": { "time": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "usd": { "type": "number", "example": 1.23 } }, "example": { "time": "2024-01-01T00:00:00Z", "usd": 1.23 } }, "HypercoreAccountActiveResponse": { "required": [ "address", "active" ], "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "address": { "type": "string", "example": "abc123" } }, "example": { "active": true, "address": "abc123" } }, "HypercoreAccountSummaryResponse": { "required": [ "address", "addresses", "subAccountCount", "spotUsdValue", "perpUsdValue", "perpUsdcBalance", "perpUnrealizedPnl", "stakedUsdValue", "totalUsdValue", "spotBalanceCount", "perpPositionCount", "pricingAvailable" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "addresses": { "type": "array", "items": { "type": "string", "example": "abc123" }, "nullable": true, "example": [ "abc123" ] }, "perpPositionCount": { "type": "integer", "example": 1 }, "perpUnrealizedPnl": { "type": "number", "example": 1.23 }, "perpUsdValue": { "type": "number", "example": 1.23 }, "perpUsdcBalance": { "type": "number", "example": 1.23 }, "pricingAvailable": { "type": "boolean", "example": true }, "spotBalanceCount": { "type": "integer", "example": 1 }, "spotUsdValue": { "type": "number", "example": 1.23 }, "stakedUsdValue": { "type": "number", "example": 1.23 }, "subAccountCount": { "type": "integer", "example": 1 }, "totalUsdValue": { "type": "number", "example": 1.23 } }, "example": { "address": "abc123", "addresses": [ "abc123" ], "perpPositionCount": 1, "perpUnrealizedPnl": 1.23, "perpUsdValue": 1.23, "perpUsdcBalance": 1.23, "pricingAvailable": true, "spotBalanceCount": 1, "spotUsdValue": 1.23, "stakedUsdValue": 1.23, "subAccountCount": 1, "totalUsdValue": 1.23 } }, "HypercoreCumFundingDTO": { "required": [ "allTime", "sinceOpen", "sinceChange" ], "type": "object", "properties": { "allTime": { "type": "number", "example": 1.23 }, "sinceChange": { "type": "number", "example": 1.23 }, "sinceOpen": { "type": "number", "example": 1.23 } }, "example": { "allTime": 1.23, "sinceChange": 1.23, "sinceOpen": 1.23 } }, "HypercoreEntityActiveResponse": { "required": [ "entity", "active" ], "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "entity": { "type": "string", "example": "abc123" } }, "example": { "active": true, "entity": "abc123" } }, "HypercoreEntityPortfolioHistoryResponse": { "required": [ "entity", "periods" ], "type": "object", "properties": { "entity": { "type": "string", "example": "abc123" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/HypercorePortfolioPeriodDTO" }, "nullable": true, "example": [ { "accountValue": [ { "time": 1, "value": 1.23 } ], "period": "abc123", "pnl": [ { "time": 1, "value": 1.23 } ] } ] } }, "example": { "entity": "abc123", "periods": [ { "accountValue": [ { "time": 1, "value": 1.23 } ], "period": "abc123", "pnl": [ { "time": 1, "value": 1.23 } ] } ] } }, "HypercoreEntitySummaryResponse": { "required": [ "entity", "addressCount", "subAccountCount", "spotUsdValue", "perpUsdValue", "perpUsdcBalance", "perpUnrealizedPnl", "stakedUsdValue", "totalUsdValue", "spotBalanceCount", "perpPositionCount", "pricingAvailable" ], "type": "object", "properties": { "addressCount": { "type": "integer", "example": 1 }, "entity": { "type": "string", "example": "abc123" }, "perpPositionCount": { "type": "integer", "example": 1 }, "perpUnrealizedPnl": { "type": "number", "example": 1.23 }, "perpUsdValue": { "type": "number", "example": 1.23 }, "perpUsdcBalance": { "type": "number", "example": 1.23 }, "pricingAvailable": { "type": "boolean", "example": true }, "spotBalanceCount": { "type": "integer", "example": 1 }, "spotUsdValue": { "type": "number", "example": 1.23 }, "stakedUsdValue": { "type": "number", "example": 1.23 }, "subAccountCount": { "type": "integer", "example": 1 }, "totalUsdValue": { "type": "number", "example": 1.23 } }, "example": { "addressCount": 1, "entity": "abc123", "perpPositionCount": 1, "perpUnrealizedPnl": 1.23, "perpUsdValue": 1.23, "perpUsdcBalance": 1.23, "pricingAvailable": true, "spotBalanceCount": 1, "spotUsdValue": 1.23, "stakedUsdValue": 1.23, "subAccountCount": 1, "totalUsdValue": 1.23 } }, "HypercoreMarketDTO": { "required": [ "pricingId", "symbol" ], "type": "object", "properties": { "name": { "type": "string", "example": "abc123" }, "pricingId": { "type": "string", "example": "abc123" }, "symbol": { "type": "string", "example": "abc123" } }, "example": { "name": "abc123", "pricingId": "abc123", "symbol": "abc123" } }, "HypercoreMarketsResponse": { "required": [ "markets" ], "type": "object", "properties": { "markets": { "type": "array", "items": { "$ref": "#/components/schemas/HypercoreMarketDTO" }, "nullable": true, "example": [ { "name": "abc123", "pricingId": "abc123", "symbol": "abc123" } ] } }, "example": { "markets": [ { "name": "abc123", "pricingId": "abc123", "symbol": "abc123" } ] } }, "HypercorePerpDexBalanceDTO": { "required": [ "dex", "usdcBalance" ], "type": "object", "properties": { "dex": { "type": "string", "example": "abc123" }, "usdcBalance": { "type": "number", "example": 1.23 } }, "example": { "dex": "abc123", "usdcBalance": 1.23 } }, "HypercorePerpPositionDTO": { "required": [ "address", "coin", "szi", "direction" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "coin": { "type": "string", "example": "abc123" }, "cumFunding": { "$ref": "#/components/schemas/HypercoreCumFundingDTO" }, "direction": { "type": "string", "example": "abc123" }, "entryPx": { "type": "number", "nullable": true, "example": 1.23 }, "leverageType": { "type": "string", "example": "abc123" }, "leverageValue": { "type": "integer", "example": 1 }, "markPx": { "type": "number", "nullable": true, "example": 1.23 }, "marketLabel": { "type": "string", "nullable": true, "example": "abc123" }, "marketUrl": { "type": "string", "nullable": true, "example": "abc123" }, "maxLeverage": { "type": "integer", "example": 1 }, "positionValue": { "type": "number", "nullable": true, "example": 1.23 }, "szi": { "type": "number", "example": 1.23 }, "underlyingPricingId": { "type": "string", "nullable": true, "example": "abc123" }, "underlyingSymbol": { "type": "string", "nullable": true, "example": "abc123" }, "unrealizedPnl": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "address": "abc123", "coin": "abc123", "cumFunding": { "allTime": 1.23, "sinceChange": 1.23, "sinceOpen": 1.23 }, "direction": "abc123", "entryPx": 1.23, "leverageType": "abc123", "leverageValue": 1, "markPx": 1.23, "marketLabel": "abc123", "marketUrl": "abc123", "maxLeverage": 1, "positionValue": 1.23, "szi": 1.23, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "unrealizedPnl": 1.23 } }, "HypercorePerpPositionsResponse": { "required": [ "addresses", "positions", "dexBalances", "usdcBalance", "unrealizedPnl", "accountUsdValue" ], "type": "object", "properties": { "accountUsdValue": { "type": "number", "example": 1.23 }, "addresses": { "type": "array", "items": { "type": "string", "example": "abc123" }, "nullable": true, "example": [ "abc123" ] }, "dexBalances": { "type": "array", "items": { "$ref": "#/components/schemas/HypercorePerpDexBalanceDTO" }, "nullable": true, "example": [ { "dex": "abc123", "usdcBalance": 1.23 } ] }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/HypercorePerpPositionDTO" }, "nullable": true, "example": [ { "address": "abc123", "coin": "abc123", "cumFunding": { "allTime": 1.23, "sinceChange": 1.23, "sinceOpen": 1.23 }, "direction": "abc123", "entryPx": 1.23, "leverageType": "abc123", "leverageValue": 1, "markPx": 1.23, "marketLabel": "abc123", "marketUrl": "abc123", "maxLeverage": 1, "positionValue": 1.23, "szi": 1.23, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "unrealizedPnl": 1.23 } ] }, "unrealizedPnl": { "type": "number", "example": 1.23 }, "usdcBalance": { "type": "number", "example": 1.23 } }, "example": { "accountUsdValue": 1.23, "addresses": [ "abc123" ], "dexBalances": [ { "dex": "abc123", "usdcBalance": 1.23 } ], "positions": [ { "address": "abc123", "coin": "abc123", "cumFunding": { "allTime": 1.23, "sinceChange": 1.23, "sinceOpen": 1.23 }, "direction": "abc123", "entryPx": 1.23, "leverageType": "abc123", "leverageValue": 1, "markPx": 1.23, "marketLabel": "abc123", "marketUrl": "abc123", "maxLeverage": 1, "positionValue": 1.23, "szi": 1.23, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "unrealizedPnl": 1.23 } ], "unrealizedPnl": 1.23, "usdcBalance": 1.23 } }, "HypercorePortfolioHistoryResponse": { "required": [ "address", "periods" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/HypercorePortfolioPeriodDTO" }, "nullable": true, "example": [ { "accountValue": [ { "time": 1, "value": 1.23 } ], "period": "abc123", "pnl": [ { "time": 1, "value": 1.23 } ] } ] } }, "example": { "address": "abc123", "periods": [ { "accountValue": [ { "time": 1, "value": 1.23 } ], "period": "abc123", "pnl": [ { "time": 1, "value": 1.23 } ] } ] } }, "HypercorePortfolioPeriodDTO": { "required": [ "period", "accountValue", "pnl" ], "type": "object", "properties": { "accountValue": { "type": "array", "items": { "$ref": "#/components/schemas/HypercorePortfolioPointDTO" }, "nullable": true, "example": [ { "time": 1, "value": 1.23 } ] }, "period": { "type": "string", "example": "abc123" }, "pnl": { "type": "array", "items": { "$ref": "#/components/schemas/HypercorePortfolioPointDTO" }, "nullable": true, "example": [ { "time": 1, "value": 1.23 } ] } }, "example": { "accountValue": [ { "time": 1, "value": 1.23 } ], "period": "abc123", "pnl": [ { "time": 1, "value": 1.23 } ] } }, "HypercorePortfolioPointDTO": { "required": [ "time", "value" ], "type": "object", "properties": { "time": { "type": "integer", "example": 1 }, "value": { "type": "number", "example": 1.23 } }, "example": { "time": 1, "value": 1.23 } }, "HypercoreSpotBalanceDTO": { "required": [ "address", "coin", "total", "hold" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "coin": { "type": "string", "example": "abc123" }, "entryPx": { "type": "number", "nullable": true, "example": 1.23 }, "hold": { "type": "number", "example": 1.23 }, "marketLabel": { "type": "string", "nullable": true, "example": "abc123" }, "marketUrl": { "type": "string", "nullable": true, "example": "abc123" }, "token": { "type": "integer", "nullable": true, "example": 1 }, "total": { "type": "number", "example": 1.23 }, "underlyingPricingId": { "type": "string", "nullable": true, "example": "abc123" }, "underlyingSymbol": { "type": "string", "nullable": true, "example": "abc123" }, "unrealizedPnl": { "type": "number", "nullable": true, "example": 1.23 }, "usdPrice": { "type": "number", "nullable": true, "example": 1.23 }, "usdValue": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "address": "abc123", "coin": "abc123", "entryPx": 1.23, "hold": 1.23, "marketLabel": "abc123", "marketUrl": "abc123", "token": 1, "total": 1.23, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "unrealizedPnl": 1.23, "usdPrice": 1.23, "usdValue": 1.23 } }, "HypercoreSpotBalancesResponse": { "required": [ "addresses", "balances", "totalUsdValue" ], "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "example": "abc123" }, "nullable": true, "example": [ "abc123" ] }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/HypercoreSpotBalanceDTO" }, "nullable": true, "example": [ { "address": "abc123", "coin": "abc123", "entryPx": 1.23, "hold": 1.23, "marketLabel": "abc123", "marketUrl": "abc123", "token": 1, "total": 1.23, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "unrealizedPnl": 1.23, "usdPrice": 1.23, "usdValue": 1.23 } ] }, "totalUsdValue": { "type": "number", "example": 1.23 } }, "example": { "addresses": [ "abc123" ], "balances": [ { "address": "abc123", "coin": "abc123", "entryPx": 1.23, "hold": 1.23, "marketLabel": "abc123", "marketUrl": "abc123", "token": 1, "total": 1.23, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "unrealizedPnl": 1.23, "usdPrice": 1.23, "usdValue": 1.23 } ], "totalUsdValue": 1.23 } }, "HypercoreSubAccountDTO": { "required": [ "name", "address", "master", "isVault" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "isVault": { "type": "boolean", "example": true }, "master": { "type": "string", "example": "abc123" }, "name": { "type": "string", "example": "abc123" } }, "example": { "address": "abc123", "isVault": true, "master": "abc123", "name": "abc123" } }, "HypercoreSubAccountsResponse": { "required": [ "address", "subAccounts" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "subAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/HypercoreSubAccountDTO" }, "nullable": true, "example": [ { "address": "abc123", "isVault": true, "master": "abc123", "name": "abc123" } ] } }, "example": { "address": "abc123", "subAccounts": [ { "address": "abc123", "isVault": true, "master": "abc123", "name": "abc123" } ] } }, "HypercoreTokenPositionDTO": { "required": [ "coin", "direction", "szi" ], "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "addressCount": { "type": "integer", "example": 1 }, "coin": { "type": "string", "example": "abc123" }, "cumFundingSinceOpen": { "type": "number", "nullable": true, "example": 1.23 }, "direction": { "type": "string", "example": "abc123" }, "entity": { "$ref": "#/components/schemas/ArkhamEntity" }, "entryPx": { "type": "number", "nullable": true, "example": 1.23 }, "leverageType": { "type": "string", "example": "abc123" }, "leverageValue": { "type": "integer", "example": 1 }, "markPx": { "type": "number", "nullable": true, "example": 1.23 }, "maxLeverage": { "type": "integer", "example": 1 }, "positionValue": { "type": "number", "nullable": true, "example": 1.23 }, "szi": { "type": "number", "example": 1.23 }, "unrealizedPnl": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "addressCount": 1, "coin": "abc123", "cumFundingSinceOpen": 1.23, "direction": "abc123", "entity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "entryPx": 1.23, "leverageType": "abc123", "leverageValue": 1, "markPx": 1.23, "maxLeverage": 1, "positionValue": 1.23, "szi": 1.23, "unrealizedPnl": 1.23 } }, "HypercoreTokenPositionsResponse": { "required": [ "hasPerp", "total", "positions" ], "type": "object", "properties": { "hasPerp": { "type": "boolean", "example": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/HypercoreTokenPositionDTO" }, "nullable": true, "example": [ { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "addressCount": 1, "coin": "abc123", "cumFundingSinceOpen": 1.23, "direction": "abc123", "entity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "entryPx": 1.23, "leverageType": "abc123", "leverageValue": 1, "markPx": 1.23, "maxLeverage": 1, "positionValue": 1.23, "szi": 1.23, "unrealizedPnl": 1.23 } ] }, "total": { "type": "integer", "example": 1 } }, "example": { "hasPerp": true, "positions": [ { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "addressCount": 1, "coin": "abc123", "cumFundingSinceOpen": 1.23, "direction": "abc123", "entity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "description": "Binance is a global cryptocurrency exchange.", "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "entryPx": 1.23, "leverageType": "abc123", "leverageValue": 1, "markPx": 1.23, "maxLeverage": 1, "positionValue": 1.23, "szi": 1.23, "unrealizedPnl": 1.23 } ], "total": 1 } }, "HypercoreTradeDTO": { "required": [ "kind", "address", "coin", "side", "price", "size", "time", "hash" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "closedPnl": { "type": "number", "nullable": true, "example": 1.23 }, "coin": { "type": "string", "example": "abc123" }, "direction": { "type": "string", "nullable": true, "example": "abc123" }, "fee": { "type": "number", "nullable": true, "example": 1.23 }, "feeToken": { "type": "string", "nullable": true, "example": "abc123" }, "hash": { "type": "string", "example": "abc123" }, "kind": { "type": "string", "example": "abc123" }, "price": { "type": "number", "example": 1.23 }, "side": { "type": "string", "example": "abc123" }, "size": { "type": "number", "example": 1.23 }, "time": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "example": { "address": "abc123", "closedPnl": 1.23, "coin": "abc123", "direction": "abc123", "fee": 1.23, "feeToken": "abc123", "hash": "abc123", "kind": "abc123", "price": 1.23, "side": "abc123", "size": 1.23, "time": "2024-01-01T00:00:00Z" } }, "HypercoreTradeFeedDTO": { "required": [ "kind", "blockNumber", "eventIndex", "time", "userAddress", "coin", "side", "price", "size", "value", "crossed" ], "type": "object", "properties": { "addressTags": { "type": "array", "items": { "type": "string", "example": "abc123" }, "description": "Tags on the trader's address.", "example": [ "abc123" ] }, "blockNumber": { "type": "integer", "description": "HyperCore block the fill was included in.", "example": 1 }, "closedPnl": { "type": "number", "description": "Perp fills only. Realized profit or loss on the portion of the position this fill closed.", "nullable": true, "example": 1.23 }, "coin": { "type": "string", "description": "Raw HyperCore coin identifier for the market that was traded.", "example": "abc123" }, "crossed": { "type": "boolean", "description": "Whether the fill crossed the book, i.e. the trader was the taker.", "example": true }, "direction": { "type": "string", "description": "Perp fills only. Position action for the fill, for example 'Open Long' or 'Close Short'.", "nullable": true, "example": "abc123" }, "eventIndex": { "type": "integer", "description": "Position of the fill within its block.", "example": 1 }, "hash": { "type": "string", "description": "Hyperliquid L1 transaction hash of the order that produced this fill.", "nullable": true, "example": "abc123" }, "kind": { "type": "string", "description": "Market type of the fill: 'perp' or 'spot'.", "example": "abc123" }, "marketLabel": { "type": "string", "description": "Name of the outcome market, for HIP-4 outcome markets.", "nullable": true, "example": "abc123" }, "marketUrl": { "type": "string", "description": "Link to the outcome market on Hyperliquid, for HIP-4 outcome markets.", "nullable": true, "example": "abc123" }, "price": { "type": "number", "description": "Price the fill executed at.", "example": 1.23 }, "side": { "type": "string", "description": "Side of the fill: 'buy' or 'sell'.", "example": "abc123" }, "size": { "type": "number", "description": "Size of the fill, in units of the market's base asset.", "example": 1.23 }, "startPosition": { "type": "number", "description": "Perp fills only. The trader's position size in this market immediately before the fill.", "nullable": true, "example": 1.23 }, "time": { "type": "string", "description": "Time the fill executed.", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "trader": { "$ref": "#/components/schemas/Address" }, "underlyingPricingId": { "type": "string", "description": "Pricing id of the resolved underlying token, when one is known.", "nullable": true, "example": "abc123" }, "underlyingSymbol": { "type": "string", "description": "Symbol of the resolved underlying token, when one is known.", "nullable": true, "example": "abc123" }, "userAddress": { "type": "string", "description": "Address of the trader that filled.", "example": "abc123" }, "value": { "type": "number", "description": "Notional value of the fill (price multiplied by size).", "example": 1.23 } }, "example": { "addressTags": [ "abc123" ], "blockNumber": 1, "closedPnl": 1.23, "coin": "abc123", "crossed": true, "direction": "abc123", "eventIndex": 1, "hash": "abc123", "kind": "abc123", "marketLabel": "abc123", "marketUrl": "abc123", "price": 1.23, "side": "abc123", "size": 1.23, "startPosition": 1.23, "time": "2024-01-01T00:00:00Z", "trader": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "userAddress": "abc123", "value": 1.23 } }, "HypercoreTradesFeedResponse": { "required": [ "trades", "count", "limit", "offset", "hasMore" ], "type": "object", "properties": { "count": { "type": "integer", "description": "Total number of matching fills. Caps at 10000.", "example": 1 }, "hasMore": { "type": "boolean", "description": "Whether more fills may be available beyond this page.", "example": true }, "limit": { "type": "integer", "description": "The limit applied to this request.", "example": 1 }, "offset": { "type": "integer", "description": "The offset applied to this request.", "example": 1 }, "trades": { "type": "array", "items": { "$ref": "#/components/schemas/HypercoreTradeFeedDTO" }, "description": "The matching fills, in the requested sort order.", "nullable": true, "example": [ { "addressTags": [ "abc123" ], "blockNumber": 1, "closedPnl": 1.23, "coin": "abc123", "crossed": true, "direction": "abc123", "eventIndex": 1, "hash": "abc123", "kind": "abc123", "marketLabel": "abc123", "marketUrl": "abc123", "price": 1.23, "side": "abc123", "size": 1.23, "startPosition": 1.23, "time": "2024-01-01T00:00:00Z", "trader": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "userAddress": "abc123", "value": 1.23 } ] } }, "example": { "count": 1, "hasMore": true, "limit": 1, "offset": 1, "trades": [ { "addressTags": [ "abc123" ], "blockNumber": 1, "closedPnl": 1.23, "coin": "abc123", "crossed": true, "direction": "abc123", "eventIndex": 1, "hash": "abc123", "kind": "abc123", "marketLabel": "abc123", "marketUrl": "abc123", "price": 1.23, "side": "abc123", "size": 1.23, "startPosition": 1.23, "time": "2024-01-01T00:00:00Z", "trader": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "underlyingPricingId": "abc123", "underlyingSymbol": "abc123", "userAddress": "abc123", "value": 1.23 } ] } }, "HypercoreTradesResponse": { "required": [ "addresses", "trades", "limit", "offset", "hasMore" ], "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "example": "abc123" }, "nullable": true, "example": [ "abc123" ] }, "hasMore": { "type": "boolean", "example": true }, "limit": { "type": "integer", "example": 1 }, "offset": { "type": "integer", "example": 1 }, "trades": { "type": "array", "items": { "$ref": "#/components/schemas/HypercoreTradeDTO" }, "nullable": true, "example": [ { "address": "abc123", "closedPnl": 1.23, "coin": "abc123", "direction": "abc123", "fee": 1.23, "feeToken": "abc123", "hash": "abc123", "kind": "abc123", "price": 1.23, "side": "abc123", "size": 1.23, "time": "2024-01-01T00:00:00Z" } ] } }, "example": { "addresses": [ "abc123" ], "hasMore": true, "limit": 1, "offset": 1, "trades": [ { "address": "abc123", "closedPnl": 1.23, "coin": "abc123", "direction": "abc123", "fee": 1.23, "feeToken": "abc123", "hash": "abc123", "kind": "abc123", "price": 1.23, "side": "abc123", "size": 1.23, "time": "2024-01-01T00:00:00Z" } ] } }, "Identifier": { "type": "object", "properties": { "address": { "type": "string", "nullable": true, "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "chain": { "$ref": "#/components/schemas/Chain" }, "pricingID": { "type": "string", "nullable": true, "example": "usd-coin" } }, "example": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" } }, "IntelUsageResponse": { "required": [ "totalCount", "totalLimit", "chainUsage", "periodStart" ], "type": "object", "properties": { "chainUsage": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdminIntelUsageChainResult" }, "description": "Per-chain-type breakdown of intel data points consumed. Keys are chain types; all EVM chains are grouped under \"evm\".", "nullable": true, "example": { "bitcoin": { "count": 86 }, "dogecoin": { "count": 0 }, "evm": { "count": 11113 }, "solana": { "count": 1020 }, "tron": { "count": 154 }, "zcash": { "count": 0 } } }, "periodStart": { "type": "string", "description": "Start of the current billing period (UTC). Null if no period is active.", "format": "date-time", "nullable": true, "example": "2026-06-01T00:00:00Z" }, "totalCount": { "type": "integer", "description": "Total intel data points consumed in the current billing period across all chains.", "example": 12373 }, "totalLimit": { "type": "integer", "description": "Per-seat intel data point limit for the current billing period.", "example": 1000000 } }, "example": { "chainUsage": { "bitcoin": { "count": 86 }, "dogecoin": { "count": 0 }, "evm": { "count": 11113 }, "solana": { "count": 1020 }, "tron": { "count": 154 }, "zcash": { "count": 0 } }, "periodStart": "2026-06-01T00:00:00Z", "totalCount": 12373, "totalLimit": 1000000 } }, "Label": { "required": [ "name", "address", "chainType" ], "type": "object", "properties": { "address": { "type": "string", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" }, "chainType": { "type": "string", "example": "evm" }, "name": { "type": "string", "example": "Cold Wallet" }, "note": { "type": "string", "example": "" } }, "example": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "LoanBalance": { "required": [ "name", "symbol", "id", "balance", "usd", "price", "price24hAgo", "quoteTime" ], "type": "object", "properties": { "address": { "type": "string", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "balance": { "type": "number", "example": 1.23 }, "balanceExact": { "type": "string", "nullable": true, "example": "abc123" }, "id": { "type": "string", "nullable": true, "example": "usd-coin" }, "market": { "type": "string", "nullable": true, "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "name": { "type": "string", "nullable": true, "example": "USD Coin" }, "price": { "type": "number", "example": 1.23 }, "price24hAgo": { "type": "number", "example": 1.23 }, "protocol": { "type": "string", "example": "aave" }, "proxy": { "type": "string", "nullable": true, "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "quoteTime": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "symbol": { "type": "string", "nullable": true, "example": "USDC" }, "type": { "type": "string", "example": "supplied" }, "underlyingAssetAddress": { "type": "string", "nullable": true, "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "underlyingAssetID": { "type": "string", "nullable": true, "example": "usd-coin" }, "underlyingAssetSymbol": { "type": "string", "nullable": true, "example": "USDC" }, "usd": { "type": "number", "example": 1.23 } }, "example": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "balance": 1.23, "balanceExact": "abc123", "id": "usd-coin", "market": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "USD Coin", "price": 1.23, "price24hAgo": 1.23, "protocol": "aave", "proxy": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "quoteTime": "2024-01-01T00:00:00Z", "symbol": "USDC", "type": "supplied", "underlyingAssetAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "underlyingAssetID": "usd-coin", "underlyingAssetSymbol": "USDC", "usd": 1.23 } }, "NetworkStatus": { "required": [ "chain", "active", "price", "priceChange24h", "priceChange24hPercent", "volume", "marketCap", "tip", "tps", "transfers", "gasFee", "satFee", "asOf" ], "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "asOf": { "$ref": "#/components/schemas/NetworkStatusAsOf" }, "chain": { "$ref": "#/components/schemas/Chain" }, "gasFee": { "type": "number", "description": "Current gas fee. Populated for EVM chains only; null for non-EVM chains.", "nullable": true, "example": 0.79 }, "marketCap": { "type": "number", "example": 203611334984 }, "price": { "type": "number", "example": 1686.97 }, "priceChange24h": { "type": "number", "example": -52.71 }, "priceChange24hPercent": { "type": "number", "example": -3.03 }, "satFee": { "type": "integer", "description": "Current fee rate in satoshis per byte. Populated only for Bitcoin-family (UTXO) chains — Bitcoin, Dogecoin, and Zcash; null for all other chains.", "nullable": true, "example": 1 }, "tip": { "minimum": 0, "type": "integer", "example": 25351093 }, "tps": { "type": "number", "example": 0 }, "transfers": { "type": "integer", "example": 5988140415 }, "volume": { "type": "number", "example": 11859071343 } }, "example": { "active": true, "asOf": { "fee": "2024-01-01T00:00:00Z", "price": "2024-01-01T00:00:00Z", "tip": "2024-01-01T00:00:00Z", "transfers": "2024-01-01T00:00:00Z" }, "chain": "ethereum", "gasFee": 0.79, "marketCap": 203611334984, "price": 1686.97, "priceChange24h": -52.71, "priceChange24hPercent": -3.03, "satFee": 1, "tip": 25351093, "tps": 0, "transfers": 5988140415, "volume": 11859071343 } }, "NetworkStatusAsOf": { "required": [ "price", "tip", "transfers" ], "type": "object", "properties": { "fee": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00Z" }, "price": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "tip": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "transfers": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "example": { "fee": "2024-01-01T00:00:00Z", "price": "2024-01-01T00:00:00Z", "tip": "2024-01-01T00:00:00Z", "transfers": "2024-01-01T00:00:00Z" } }, "OpenSea": { "required": [ "address", "username", "profileImage" ], "type": "object", "properties": { "address": { "type": "string", "example": "0x28C6c06298d514Db089934071355E5743bf21d60" }, "profileImage": { "type": "string", "nullable": true, "example": "abc123" }, "username": { "type": "string", "example": "Binance" } }, "example": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "profileImage": "abc123", "username": "Binance" } }, "PolymarketActivityAction": { "enum": [ "buy", "sell", "split", "merge", "convert" ], "type": "string", "example": "buy" }, "PolymarketActivityDirection": { "enum": [ "buy", "sell" ], "type": "string", "example": "buy" }, "PolymarketActivityEventType": { "enum": [ "trade", "split", "merge", "convert" ], "type": "string", "example": "trade" }, "PolymarketActivityItem": { "required": [ "blockTimestamp", "transactionHash", "logIndex", "tokenAddress", "conditionId", "eventType", "userAddress", "size", "notional" ], "type": "object", "properties": { "blockTimestamp": { "type": "string", "format": "date-time", "example": "2026-06-22T13:29:41Z" }, "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x38e99171e9124c355447b04ff5cfa38d6c3ebaf9a1daed629cfcdd6fff175878" }, "direction": { "$ref": "#/components/schemas/PolymarketActivityDirection" }, "eventId": { "type": "integer", "nullable": true, "example": 618839 }, "eventType": { "$ref": "#/components/schemas/PolymarketActivityEventType" }, "imageUrl": { "type": "string", "description": "Polymarket market image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/ETH+fullsize.jpg" }, "logIndex": { "type": "integer", "example": 489 }, "notional": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "10.692" }, "outcome": { "type": "string", "description": "Polymarket outcome token label (e.g. \"Yes\", \"No\").", "example": "Up" }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Ethereum Up or Down - June 22, 9:30AM-9:35AM ET" }, "size": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "23.76" }, "tokenAddress": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x9a1e6e413d83cfafee559d0e9d712c4aa64e93a8ad194d7cba115d9a6d78fc35" }, "transactionHash": { "type": "string", "description": "Polygon transaction hash.", "example": "0xbbe268603c723149ee622d7d506ea8ed51bec4f2a230fdf0f31947a7981012ad" }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0x15cf1841c9A9F9aB5E1065ef7db255DEfcADd12c" } }, "example": { "blockTimestamp": "2026-06-22T13:29:41Z", "conditionId": "0x38e99171e9124c355447b04ff5cfa38d6c3ebaf9a1daed629cfcdd6fff175878", "direction": "buy", "eventId": 618839, "eventType": "trade", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/ETH+fullsize.jpg", "logIndex": 489, "notional": "10.692", "outcome": "Up", "question": "Ethereum Up or Down - June 22, 9:30AM-9:35AM ET", "size": "23.76", "tokenAddress": "0x9a1e6e413d83cfafee559d0e9d712c4aa64e93a8ad194d7cba115d9a6d78fc35", "transactionHash": "0xbbe268603c723149ee622d7d506ea8ed51bec4f2a230fdf0f31947a7981012ad", "userAddress": "0x15cf1841c9A9F9aB5E1065ef7db255DEfcADd12c" } }, "PolymarketActivityResponse": { "required": [ "events", "totalCount" ], "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketActivityItem" }, "nullable": true, "example": [ { "blockTimestamp": "2026-06-22T13:29:41Z", "conditionId": "0x38e99171e9124c355447b04ff5cfa38d6c3ebaf9a1daed629cfcdd6fff175878", "direction": "buy", "eventId": 618839, "eventType": "trade", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/ETH+fullsize.jpg", "logIndex": 489, "notional": "10.692", "outcome": "Up", "question": "Ethereum Up or Down - June 22, 9:30AM-9:35AM ET", "size": "23.76", "tokenAddress": "0x9a1e6e413d83cfafee559d0e9d712c4aa64e93a8ad194d7cba115d9a6d78fc35", "transactionHash": "0xbbe268603c723149ee622d7d506ea8ed51bec4f2a230fdf0f31947a7981012ad", "userAddress": "0x15cf1841c9A9F9aB5E1065ef7db255DEfcADd12c" } ] }, "totalCount": { "type": "integer", "description": "Pagination count. It may be inexact when fastPagination is enabled and is only guaranteed to determine whether another page exists.", "example": 10000 } }, "example": { "events": [ { "blockTimestamp": "2026-06-22T13:29:41Z", "conditionId": "0x38e99171e9124c355447b04ff5cfa38d6c3ebaf9a1daed629cfcdd6fff175878", "direction": "buy", "eventId": 618839, "eventType": "trade", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/ETH+fullsize.jpg", "logIndex": 489, "notional": "10.692", "outcome": "Up", "question": "Ethereum Up or Down - June 22, 9:30AM-9:35AM ET", "size": "23.76", "tokenAddress": "0x9a1e6e413d83cfafee559d0e9d712c4aa64e93a8ad194d7cba115d9a6d78fc35", "transactionHash": "0xbbe268603c723149ee622d7d506ea8ed51bec4f2a230fdf0f31947a7981012ad", "userAddress": "0x15cf1841c9A9F9aB5E1065ef7db255DEfcADd12c" } ], "totalCount": 10000 } }, "PolymarketActivitySortBy": { "enum": [ "time", "size", "price", "usd" ], "type": "string", "example": "time" }, "PolymarketEventCardResponse": { "required": [ "eventId", "title", "marketCount", "marketPreviews", "active", "closed", "restricted", "ended", "live" ], "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "category": { "type": "string", "description": "Polymarket event category.", "example": "crypto" }, "closed": { "type": "boolean", "example": true }, "description": { "type": "string", "description": "Polymarket event description.", "example": "This market will resolve according to the national team that wins the 2026 FIFA World Cup." }, "endDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00Z" }, "ended": { "type": "boolean", "example": true }, "eventId": { "type": "integer", "example": 1 }, "eventIds": { "type": "array", "items": { "type": "integer", "example": 1 }, "description": "Event IDs collapsed into this card: the card's own eventId first, the rest highest-volume first. Present on collapsed cards (games listing, today module).", "example": [ 1 ] }, "gameId": { "type": "integer", "description": "Gamma game ID shared by all events of the same fixture. Group events by this value.", "nullable": true, "example": 18432 }, "iconUrl": { "type": "string", "description": "Polymarket event icon URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg" }, "imageUrl": { "type": "string", "description": "Polymarket event image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg" }, "live": { "type": "boolean", "example": true }, "marketCount": { "type": "integer", "example": 1 }, "marketPreviews": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketEventMarketPreview" }, "nullable": true, "example": [ { "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "groupItemMeta": { "primaryColor": "#00FF00", "shortName": "Yes" }, "groupItemTitle": "France", "outcomeMeta": [ { "primaryColor": "#00FF00", "shortName": "Yes" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "volume24hUsdc": "1250", "winningOutcome": "Yes", "yesPrice": 0.1975, "yesPriceChange24h": 1.23 } ] }, "negRisk": { "type": "boolean", "description": "True for neg-risk events (mutually exclusive market group).", "example": true }, "restricted": { "type": "boolean", "example": true }, "slug": { "type": "string", "description": "Polymarket event slug.", "example": "world-cup-winner" }, "startTime": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00Z" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketEventTag" }, "description": "Event category tags with resolved labels. Returned by the single-event endpoint only.", "example": [ { "label": "NBA", "tag": "nba" } ] }, "title": { "type": "string", "description": "Polymarket event title.", "example": "World Cup Winner " }, "volume24hChangePct": { "type": "number", "nullable": true, "example": 1.23 }, "volume24hUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "320" }, "volumeUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "4582.1" } }, "example": { "active": true, "category": "crypto", "closed": true, "description": "This market will resolve according to the national team that wins the 2026 FIFA World Cup.", "endDate": "2024-01-01T00:00:00Z", "ended": true, "eventId": 1, "eventIds": [ 1 ], "gameId": 18432, "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "live": true, "marketCount": 1, "marketPreviews": [ { "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "groupItemMeta": { "primaryColor": "#00FF00", "shortName": "Yes" }, "groupItemTitle": "France", "outcomeMeta": [ { "primaryColor": "#00FF00", "shortName": "Yes" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "volume24hUsdc": "1250", "winningOutcome": "Yes", "yesPrice": 0.1975, "yesPriceChange24h": 1.23 } ], "negRisk": true, "restricted": true, "slug": "world-cup-winner", "startTime": "2024-01-01T00:00:00Z", "tags": [ { "label": "NBA", "tag": "nba" } ], "title": "World Cup Winner ", "volume24hChangePct": 1.23, "volume24hUsdc": "320", "volumeUsdc": "4582.1" } }, "PolymarketEventMarketPreview": { "required": [ "conditionId", "question", "resolved" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894" }, "groupItemMeta": { "$ref": "#/components/schemas/PolymarketOutcomeMeta" }, "groupItemTitle": { "type": "string", "description": "Polymarket grouped-market item title.", "example": "France" }, "outcomeMeta": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketOutcomeMeta" }, "example": [ { "primaryColor": "#00FF00", "shortName": "Yes" } ] }, "outcomes": { "type": "array", "items": { "type": "string", "description": "Polymarket outcome token label.", "example": "Yes" }, "example": [ "Yes", "No" ] }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will France win the 2026 FIFA World Cup?" }, "resolved": { "type": "boolean", "example": true }, "volume24hUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1250" }, "winningOutcome": { "type": "string", "description": "Winning outcome label for resolved markets.", "example": "Yes" }, "yesPrice": { "type": "number", "nullable": true, "example": 0.1975 }, "yesPriceChange24h": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "groupItemMeta": { "primaryColor": "#00FF00", "shortName": "Yes" }, "groupItemTitle": "France", "outcomeMeta": [ { "primaryColor": "#00FF00", "shortName": "Yes" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "volume24hUsdc": "1250", "winningOutcome": "Yes", "yesPrice": 0.1975, "yesPriceChange24h": 1.23 } }, "PolymarketEventMarketResponse": { "required": [ "conditionId", "question", "outcomes", "active", "closed", "restricted", "volumeUsdc", "resolved" ], "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "closed": { "type": "boolean", "example": true }, "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894" }, "endDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00Z" }, "groupItemMeta": { "$ref": "#/components/schemas/PolymarketOutcomeMetaType2" }, "groupItemTitle": { "type": "string", "description": "Polymarket grouped-market item title.", "example": "France" }, "iconUrl": { "type": "string", "description": "Polymarket market icon URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png" }, "imageUrl": { "type": "string", "description": "Polymarket market image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png" }, "outcomeMeta": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketOutcomeMetaType2" }, "example": [ { "primaryColor": "#0000FF", "shortName": "FR" } ] }, "outcomes": { "type": "array", "items": { "type": "string", "description": "Polymarket outcome token label.", "example": "Yes" }, "nullable": true, "example": [ "Yes", "No" ] }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will France win the 2026 FIFA World Cup?" }, "resolved": { "type": "boolean", "example": true }, "resolvedAt": { "type": "string", "description": "Timestamp the market was settled on-chain. Set only when resolved.", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00Z" }, "restricted": { "type": "boolean", "example": true }, "slug": { "type": "string", "description": "Polymarket market slug.", "example": "will-france-win-the-2026-fifa-world-cup-924" }, "tokenAddresses": { "type": "array", "items": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" }, "example": [ "0xef4a0c81fb7b6bc701f41c0da766cd0691e38b5dbf9bb6d096e20d986594942c" ] }, "volumeUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "603084.740263" }, "winningOutcome": { "type": "string", "description": "Winning outcome label for resolved markets.", "example": "Yes" }, "yesPrice": { "type": "number", "nullable": true, "example": 0.1975 } }, "example": { "active": true, "closed": true, "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "endDate": "2024-01-01T00:00:00Z", "groupItemMeta": { "primaryColor": "#0000FF", "shortName": "FR" }, "groupItemTitle": "France", "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png", "outcomeMeta": [ { "primaryColor": "#0000FF", "shortName": "FR" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "resolvedAt": "2024-01-01T00:00:00Z", "restricted": true, "slug": "will-france-win-the-2026-fifa-world-cup-924", "tokenAddresses": [ "0xef4a0c81fb7b6bc701f41c0da766cd0691e38b5dbf9bb6d096e20d986594942c" ], "volumeUsdc": "603084.740263", "winningOutcome": "Yes", "yesPrice": 0.1975 } }, "PolymarketEventPositionItem": { "required": [ "userAddress", "tokenAddress", "shares", "price", "value", "pnl", "totalTrades" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" }, "imageUrl": { "type": "string", "description": "Polymarket market image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-netherlands-flag-20260603-192743.png" }, "outcome": { "type": "string", "description": "Polymarket outcome token label (e.g. \"Yes\", \"No\").", "example": "Yes" }, "pnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "183116.690251204" }, "price": { "type": "number", "example": 0.0545 }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will Netherlands win the 2026 FIFA World Cup?" }, "shares": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "6337.619912" }, "tokenAddress": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" }, "totalTrades": { "type": "integer", "example": 5818 }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xB687f00464E33934f5d591F224E71C3559ecAeE5" }, "value": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "345.400285204" } }, "example": { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-netherlands-flag-20260603-192743.png", "outcome": "Yes", "pnl": "183116.690251204", "price": 0.0545, "question": "Will Netherlands win the 2026 FIFA World Cup?", "shares": "6337.619912", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4", "totalTrades": 5818, "userAddress": "0xB687f00464E33934f5d591F224E71C3559ecAeE5", "value": "345.400285204" } }, "PolymarketEventPositionsResponse": { "required": [ "conditionId", "positions", "totalCount" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketEventPositionItem" }, "nullable": true, "example": [ { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-netherlands-flag-20260603-192743.png", "outcome": "Yes", "pnl": "183116.690251204", "price": 0.0545, "question": "Will Netherlands win the 2026 FIFA World Cup?", "shares": "6337.619912", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4", "totalTrades": 5818, "userAddress": "0xB687f00464E33934f5d591F224E71C3559ecAeE5", "value": "345.400285204" } ] }, "totalCount": { "type": "integer", "example": 40468 } }, "example": { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "positions": [ { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-netherlands-flag-20260603-192743.png", "outcome": "Yes", "pnl": "183116.690251204", "price": 0.0545, "question": "Will Netherlands win the 2026 FIFA World Cup?", "shares": "6337.619912", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4", "totalTrades": 5818, "userAddress": "0xB687f00464E33934f5d591F224E71C3559ecAeE5", "value": "345.400285204" } ], "totalCount": 40468 } }, "PolymarketEventPositionsSortBy": { "enum": [ "pnl", "shares", "value" ], "type": "string", "example": "pnl" }, "PolymarketEventResponse": { "required": [ "event", "markets" ], "type": "object", "properties": { "event": { "$ref": "#/components/schemas/PolymarketEventCardResponse" }, "markets": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketEventMarketResponse" }, "nullable": true, "example": [ { "active": true, "closed": true, "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "endDate": "2024-01-01T00:00:00Z", "groupItemMeta": { "primaryColor": "#0000FF", "shortName": "FR" }, "groupItemTitle": "France", "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png", "outcomeMeta": [ { "primaryColor": "#0000FF", "shortName": "FR" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "resolvedAt": "2024-01-01T00:00:00Z", "restricted": true, "slug": "will-france-win-the-2026-fifa-world-cup-924", "tokenAddresses": [ "0xef4a0c81fb7b6bc701f41c0da766cd0691e38b5dbf9bb6d096e20d986594942c" ], "volumeUsdc": "603084.740263", "winningOutcome": "Yes", "yesPrice": 0.1975 } ] }, "series": { "$ref": "#/components/schemas/PolymarketEventSeriesContext" } }, "example": { "event": { "active": true, "category": "crypto", "closed": true, "description": "This market will resolve according to the national team that wins the 2026 FIFA World Cup.", "endDate": "2024-01-01T00:00:00Z", "ended": true, "eventId": 1, "eventIds": [ 1 ], "gameId": 18432, "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "live": true, "marketCount": 1, "marketPreviews": [ { "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "groupItemMeta": { "primaryColor": "#00FF00", "shortName": "Yes" }, "groupItemTitle": "France", "outcomeMeta": [ { "primaryColor": "#00FF00", "shortName": "Yes" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "volume24hUsdc": "1250", "winningOutcome": "Yes", "yesPrice": 0.1975, "yesPriceChange24h": 1.23 } ], "negRisk": true, "restricted": true, "slug": "world-cup-winner", "startTime": "2024-01-01T00:00:00Z", "tags": [ { "label": "NBA", "tag": "nba" } ], "title": "World Cup Winner ", "volume24hChangePct": 1.23, "volume24hUsdc": "320", "volumeUsdc": "4582.1" }, "markets": [ { "active": true, "closed": true, "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "endDate": "2024-01-01T00:00:00Z", "groupItemMeta": { "primaryColor": "#0000FF", "shortName": "FR" }, "groupItemTitle": "France", "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-france-flag-20260603-192743.png", "outcomeMeta": [ { "primaryColor": "#0000FF", "shortName": "FR" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "resolvedAt": "2024-01-01T00:00:00Z", "restricted": true, "slug": "will-france-win-the-2026-fifa-world-cup-924", "tokenAddresses": [ "0xef4a0c81fb7b6bc701f41c0da766cd0691e38b5dbf9bb6d096e20d986594942c" ], "volumeUsdc": "603084.740263", "winningOutcome": "Yes", "yesPrice": 0.1975 } ], "series": { "cadenceSeconds": 300, "liveEventId": 1, "nextEventId": 1, "prevEventId": 1, "recurrence": "5m", "resolutionSource": "chainlink-data-streams:BTC/USD", "slug": "btc-up-or-down-5m", "title": "BTC Up or Down 5m", "underlying": "BTC" } } }, "PolymarketEventSearchResult": { "required": [ "eventId", "title", "marketCount" ], "type": "object", "properties": { "category": { "type": "string", "example": "Crypto" }, "eventId": { "type": "integer", "example": 1 }, "iconUrl": { "type": "string", "example": "abc123" }, "imageUrl": { "type": "string", "example": "abc123" }, "marketCount": { "type": "integer", "example": 1 }, "slug": { "type": "string", "example": "will-bitcoin-hit-100k-2026" }, "title": { "type": "string", "example": "Will Bitcoin hit $100k in 2026?" } }, "example": { "category": "Crypto", "eventId": 1, "iconUrl": "abc123", "imageUrl": "abc123", "marketCount": 1, "slug": "will-bitcoin-hit-100k-2026", "title": "Will Bitcoin hit $100k in 2026?" } }, "PolymarketEventSeriesContext": { "required": [ "slug", "title" ], "type": "object", "properties": { "cadenceSeconds": { "type": "integer", "description": "Length of this event's round window in seconds; for tiling round series this equals the series cadence.", "example": 300 }, "liveEventId": { "type": "integer", "description": "Round whose window contains now, when one exists.", "nullable": true, "example": 1 }, "nextEventId": { "type": "integer", "description": "Next round of the series by end date (may be upcoming).", "nullable": true, "example": 1 }, "prevEventId": { "type": "integer", "description": "Previous round of the series by end date.", "nullable": true, "example": 1 }, "recurrence": { "type": "string", "example": "5m" }, "resolutionSource": { "type": "string", "description": "Settlement feed identifier; differs per series (5m/15m resolve on Chainlink Data Streams, hourly on Binance candles).", "example": "chainlink-data-streams:BTC/USD" }, "slug": { "type": "string", "example": "btc-up-or-down-5m" }, "title": { "type": "string", "example": "BTC Up or Down 5m" }, "underlying": { "type": "string", "description": "Underlying asset symbol for crypto up/down series.", "example": "BTC" } }, "example": { "cadenceSeconds": 300, "liveEventId": 1, "nextEventId": 1, "prevEventId": 1, "recurrence": "5m", "resolutionSource": "chainlink-data-streams:BTC/USD", "slug": "btc-up-or-down-5m", "title": "BTC Up or Down 5m", "underlying": "BTC" } }, "PolymarketEventSortBy": { "enum": [ "volume", "endDate", "createdAt" ], "type": "string", "example": "volume" }, "PolymarketEventTag": { "required": [ "tag", "label" ], "type": "object", "properties": { "label": { "type": "string", "description": "Human-readable tag label.", "example": "NBA" }, "tag": { "type": "string", "description": "Category tag slug.", "example": "nba" } }, "example": { "label": "NBA", "tag": "nba" } }, "PolymarketEventsResponse": { "required": [ "events", "totalCount", "offset", "limit" ], "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketEventCardResponse" }, "nullable": true, "example": [ { "active": true, "category": "crypto", "closed": true, "description": "This market will resolve according to the national team that wins the 2026 FIFA World Cup.", "endDate": "2024-01-01T00:00:00Z", "ended": true, "eventId": 1, "eventIds": [ 1 ], "gameId": 18432, "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "live": true, "marketCount": 1, "marketPreviews": [ { "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "groupItemMeta": { "primaryColor": "#00FF00", "shortName": "Yes" }, "groupItemTitle": "France", "outcomeMeta": [ { "primaryColor": "#00FF00", "shortName": "Yes" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "volume24hUsdc": "1250", "winningOutcome": "Yes", "yesPrice": 0.1975, "yesPriceChange24h": 1.23 } ], "negRisk": true, "restricted": true, "slug": "world-cup-winner", "startTime": "2024-01-01T00:00:00Z", "tags": [ { "label": "NBA", "tag": "nba" } ], "title": "World Cup Winner ", "volume24hChangePct": 1.23, "volume24hUsdc": "320", "volumeUsdc": "4582.1" } ] }, "limit": { "type": "integer", "example": 2 }, "offset": { "type": "integer", "example": 0 }, "totalCount": { "type": "integer", "example": 610092 } }, "example": { "events": [ { "active": true, "category": "crypto", "closed": true, "description": "This market will resolve according to the national team that wins the 2026 FIFA World Cup.", "endDate": "2024-01-01T00:00:00Z", "ended": true, "eventId": 1, "eventIds": [ 1 ], "gameId": 18432, "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-soccer-cup-93e5f1d884.jpg", "live": true, "marketCount": 1, "marketPreviews": [ { "conditionId": "0x9b6fef249040fd17e9c107955b37ac2c3e923509b6b0ff01cc463a331ddeb894", "groupItemMeta": { "primaryColor": "#00FF00", "shortName": "Yes" }, "groupItemTitle": "France", "outcomeMeta": [ { "primaryColor": "#00FF00", "shortName": "Yes" } ], "outcomes": [ "Yes", "No" ], "question": "Will France win the 2026 FIFA World Cup?", "resolved": true, "volume24hUsdc": "1250", "winningOutcome": "Yes", "yesPrice": 0.1975, "yesPriceChange24h": 1.23 } ], "negRisk": true, "restricted": true, "slug": "world-cup-winner", "startTime": "2024-01-01T00:00:00Z", "tags": [ { "label": "NBA", "tag": "nba" } ], "title": "World Cup Winner ", "volume24hChangePct": 1.23, "volume24hUsdc": "320", "volumeUsdc": "4582.1" } ], "limit": 2, "offset": 0, "totalCount": 610092 } }, "PolymarketLeaderboardEntry": { "required": [ "rank", "userAddress", "periodPnl", "tradeCount", "tokensWon", "tokensTotal" ], "type": "object", "properties": { "periodPnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1977499.5723378485" }, "rank": { "type": "integer", "example": 1 }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketWalletTag" }, "example": [ { "events": 1284, "label": "Politics", "tag": "politics", "volume": "45820.12" } ] }, "tokensTotal": { "type": "integer", "example": 216 }, "tokensWon": { "type": "integer", "example": 98 }, "tradeCount": { "type": "integer", "example": 8328 }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xf0318C32136c2dB7feC88B84869aEE6A1106C80c" } }, "example": { "periodPnl": "1977499.5723378485", "rank": 1, "tags": [ { "events": 1284, "label": "Politics", "tag": "politics", "volume": "45820.12" } ], "tokensTotal": 216, "tokensWon": 98, "tradeCount": 8328, "userAddress": "0xf0318C32136c2dB7feC88B84869aEE6A1106C80c" } }, "PolymarketLeaderboardPeriod": { "enum": [ "1d", "1w", "1m", "all" ], "type": "string", "example": "1d" }, "PolymarketLeaderboardResponse": { "required": [ "period", "sort", "entries" ], "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketLeaderboardEntry" }, "nullable": true, "example": [ { "periodPnl": "1977499.5723378485", "rank": 1, "tags": [ { "events": 1284, "label": "Politics", "tag": "politics", "volume": "45820.12" } ], "tokensTotal": 216, "tokensWon": 98, "tradeCount": 8328, "userAddress": "0xf0318C32136c2dB7feC88B84869aEE6A1106C80c" } ] }, "period": { "$ref": "#/components/schemas/PolymarketLeaderboardPeriod" }, "sort": { "$ref": "#/components/schemas/SortDir" }, "userRank": { "type": "integer", "nullable": true, "example": 1 } }, "example": { "entries": [ { "periodPnl": "1977499.5723378485", "rank": 1, "tags": [ { "events": 1284, "label": "Politics", "tag": "politics", "volume": "45820.12" } ], "tokensTotal": 216, "tokensWon": 98, "tradeCount": 8328, "userAddress": "0xf0318C32136c2dB7feC88B84869aEE6A1106C80c" } ], "period": "1d", "sort": "asc", "userRank": 1 } }, "PolymarketOrderBookLevel": { "required": [ "price", "size" ], "type": "object", "properties": { "price": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0.001" }, "size": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "2743420.3" } }, "example": { "price": "0.001", "size": "2743420.3" } }, "PolymarketOrderBookResponse": { "required": [ "conditionId", "sides" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" }, "sides": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketOrderBookSide" }, "nullable": true, "example": [ { "asks": [ { "price": "0.001", "size": "2743420.3" } ], "bids": [ { "price": "0.001", "size": "2743420.3" } ], "lastTradePrice": "0.055", "outcome": "Yes", "tokenId": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } ] } }, "example": { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "sides": [ { "asks": [ { "price": "0.001", "size": "2743420.3" } ], "bids": [ { "price": "0.001", "size": "2743420.3" } ], "lastTradePrice": "0.055", "outcome": "Yes", "tokenId": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } ] } }, "PolymarketOrderBookSide": { "required": [ "tokenId", "outcome", "bids", "asks", "lastTradePrice" ], "type": "object", "properties": { "asks": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketOrderBookLevel" }, "nullable": true, "example": [ { "price": "0.001", "size": "2743420.3" } ] }, "bids": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketOrderBookLevel" }, "nullable": true, "example": [ { "price": "0.001", "size": "2743420.3" } ] }, "lastTradePrice": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0.055" }, "outcome": { "type": "string", "description": "Polymarket outcome token label (e.g. \"Yes\", \"No\").", "example": "Yes" }, "tokenId": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } }, "example": { "asks": [ { "price": "0.001", "size": "2743420.3" } ], "bids": [ { "price": "0.001", "size": "2743420.3" } ], "lastTradePrice": "0.055", "outcome": "Yes", "tokenId": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } }, "PolymarketOutcomeMeta": { "required": [ "shortName", "primaryColor" ], "type": "object", "properties": { "primaryColor": { "type": "string", "example": "#00FF00" }, "shortName": { "type": "string", "example": "Yes" } }, "example": { "primaryColor": "#00FF00", "shortName": "Yes" } }, "PolymarketOutcomeMetaType2": { "required": [ "shortName", "primaryColor" ], "type": "object", "properties": { "primaryColor": { "type": "string", "example": "#0000FF" }, "shortName": { "type": "string", "example": "FR" } }, "example": { "primaryColor": "#0000FF", "shortName": "FR" } }, "PolymarketPnLChartResponse": { "required": [ "userAddress", "interval", "endTime", "points" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" }, "endTime": { "type": "string", "format": "date-time", "example": "2026-06-22T13:29:45.975416489Z" }, "interval": { "type": "string", "example": "4h" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketPnLPoint" }, "description": "PnL points ordered by time. Fixed-window responses may include a final as-of-endTime point from the latest live Polymarket state when available.", "nullable": true, "example": [ { "bucket": "2026-05-23T12:00:00Z", "cumulativeFees": "0", "cumulativePnl": "1510462.284030093", "cumulativePosition": "61565194.136166093", "cumulativeUsdcFlow": "-60054731.852136", "price": 1.23 } ] }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will Netherlands win the 2026 FIFA World Cup?" }, "startTime": { "type": "string", "format": "date-time", "nullable": true, "example": "2026-05-23T13:29:45.975416489Z" }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "endTime": "2026-06-22T13:29:45.975416489Z", "interval": "4h", "points": [ { "bucket": "2026-05-23T12:00:00Z", "cumulativeFees": "0", "cumulativePnl": "1510462.284030093", "cumulativePosition": "61565194.136166093", "cumulativeUsdcFlow": "-60054731.852136", "price": 1.23 } ], "question": "Will Netherlands win the 2026 FIFA World Cup?", "startTime": "2026-05-23T13:29:45.975416489Z", "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketPnLPeriod": { "enum": [ "24h", "7d", "30d", "all" ], "type": "string", "example": "24h" }, "PolymarketPnLPoint": { "required": [ "bucket", "cumulativePosition", "cumulativeUsdcFlow", "cumulativeFees", "cumulativePnl" ], "type": "object", "properties": { "bucket": { "type": "string", "format": "date-time", "example": "2026-05-23T12:00:00Z" }, "cumulativeFees": { "type": "string", "description": "Reserved for compatibility; this endpoint currently returns 0.", "example": "0" }, "cumulativePnl": { "type": "string", "description": "Total PnL in USDC at this bucket.", "example": "1510462.284030093" }, "cumulativePosition": { "type": "string", "description": "Current marked position value in USDC at this bucket.", "example": "61565194.136166093" }, "cumulativeUsdcFlow": { "type": "string", "description": "Cumulative USDC flow net of fees at this bucket.", "example": "-60054731.852136" }, "price": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "bucket": "2026-05-23T12:00:00Z", "cumulativeFees": "0", "cumulativePnl": "1510462.284030093", "cumulativePosition": "61565194.136166093", "cumulativeUsdcFlow": "-60054731.852136", "price": 1.23 } }, "PolymarketPositionItem": { "required": [ "tokenAddress", "conditionId", "netPosition", "netFlowUsdc", "totalTrades", "unrealizedPnl" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0xf950740bc71136155d6525cc0528a582c81f88812bff227803190c32ca25f54d" }, "eventId": { "type": "integer", "nullable": true, "example": 30615 }, "groupItemTitle": { "type": "string", "description": "Polymarket grouped-market item title.", "example": "Scotland" }, "imageUrl": { "type": "string", "description": "Polymarket market image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-scotland-flag-20260603-192743.png" }, "lastPrice": { "type": "number", "example": 0.0015 }, "netFlowUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "-7203.950016" }, "netPosition": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "7328182.072224" }, "outcome": { "type": "string", "description": "Polymarket outcome token label (e.g. \"Yes\", \"No\").", "example": "Yes" }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will Scotland win the 2026 FIFA World Cup?" }, "tokenAddress": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0xe8b2a357b32729bae06a8a3ac122d8202412f84a849a447a6afff7e75fd3d636" }, "totalTrades": { "type": "integer", "example": 11468 }, "unrealizedPnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "3788.323092336" } }, "example": { "conditionId": "0xf950740bc71136155d6525cc0528a582c81f88812bff227803190c32ca25f54d", "eventId": 30615, "groupItemTitle": "Scotland", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-scotland-flag-20260603-192743.png", "lastPrice": 0.0015, "netFlowUsdc": "-7203.950016", "netPosition": "7328182.072224", "outcome": "Yes", "question": "Will Scotland win the 2026 FIFA World Cup?", "tokenAddress": "0xe8b2a357b32729bae06a8a3ac122d8202412f84a849a447a6afff7e75fd3d636", "totalTrades": 11468, "unrealizedPnl": "3788.323092336" } }, "PolymarketPositionsResponse": { "required": [ "userAddress", "positions", "totalCount" ], "type": "object", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketPositionItem" }, "nullable": true, "example": [ { "conditionId": "0xf950740bc71136155d6525cc0528a582c81f88812bff227803190c32ca25f54d", "eventId": 30615, "groupItemTitle": "Scotland", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-scotland-flag-20260603-192743.png", "lastPrice": 0.0015, "netFlowUsdc": "-7203.950016", "netPosition": "7328182.072224", "outcome": "Yes", "question": "Will Scotland win the 2026 FIFA World Cup?", "tokenAddress": "0xe8b2a357b32729bae06a8a3ac122d8202412f84a849a447a6afff7e75fd3d636", "totalTrades": 11468, "unrealizedPnl": "3788.323092336" } ] }, "totalCount": { "type": "integer", "example": 58 }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "positions": [ { "conditionId": "0xf950740bc71136155d6525cc0528a582c81f88812bff227803190c32ca25f54d", "eventId": 30615, "groupItemTitle": "Scotland", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-scotland-flag-20260603-192743.png", "lastPrice": 0.0015, "netFlowUsdc": "-7203.950016", "netPosition": "7328182.072224", "outcome": "Yes", "question": "Will Scotland win the 2026 FIFA World Cup?", "tokenAddress": "0xe8b2a357b32729bae06a8a3ac122d8202412f84a849a447a6afff7e75fd3d636", "totalTrades": 11468, "unrealizedPnl": "3788.323092336" } ], "totalCount": 58, "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketPositionsSortBy": { "enum": [ "trades", "shares", "value", "pnl" ], "type": "string", "example": "trades" }, "PolymarketPredictionHistoryItem": { "required": [ "conditionId", "tokenAddress", "totalTrades", "volume", "value", "currentPrice", "totalBuyUsdc", "avgBuyPrice", "totalSellUsdc", "avgSellPrice", "pnl", "netShares", "sharesHeld", "isResolved" ], "type": "object", "properties": { "avgBuyPrice": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0.34098803308944694087" }, "avgSellPrice": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1.00000000000000000000" }, "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x0433839be2e0889423ff0a0efae939272899d09c284d309b346d3991d003c4c0" }, "currentPrice": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1.00000000000000000000" }, "eventId": { "type": "integer", "nullable": true, "example": 401638 }, "eventTitle": { "type": "string", "description": "Polymarket event title.", "example": "Chelsea FC vs. Nottingham Forest FC" }, "groupItemTitle": { "type": "string", "description": "Polymarket grouped-market item title.", "example": "Chelsea FC" }, "imageUrl": { "type": "string", "description": "Polymarket market image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/Repetitive-markets/premier+league.jpg" }, "isResolved": { "type": "boolean", "example": true }, "netShares": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0" }, "outcome": { "type": "string", "description": "Polymarket outcome token label (e.g. \"Yes\", \"No\").", "example": "No" }, "pnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "643126.136941" }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will Chelsea FC win on 2026-05-04?" }, "resolvedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2026-05-04T20:20:48Z" }, "sharesHeld": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0" }, "tokenAddress": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x5f10f068a11aa7c2f4244d8d71bcfd1ad3f2ed337d916960eb2a660ad380f892" }, "totalBuyUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "332768.337261" }, "totalSellUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "975894.474202" }, "totalTrades": { "type": "integer", "example": 71 }, "value": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0" }, "volume": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "332768.337261" } }, "example": { "avgBuyPrice": "0.34098803308944694087", "avgSellPrice": "1.00000000000000000000", "conditionId": "0x0433839be2e0889423ff0a0efae939272899d09c284d309b346d3991d003c4c0", "currentPrice": "1.00000000000000000000", "eventId": 401638, "eventTitle": "Chelsea FC vs. Nottingham Forest FC", "groupItemTitle": "Chelsea FC", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/Repetitive-markets/premier+league.jpg", "isResolved": true, "netShares": "0", "outcome": "No", "pnl": "643126.136941", "question": "Will Chelsea FC win on 2026-05-04?", "resolvedAt": "2026-05-04T20:20:48Z", "sharesHeld": "0", "tokenAddress": "0x5f10f068a11aa7c2f4244d8d71bcfd1ad3f2ed337d916960eb2a660ad380f892", "totalBuyUsdc": "332768.337261", "totalSellUsdc": "975894.474202", "totalTrades": 71, "value": "0", "volume": "332768.337261" } }, "PolymarketPredictionHistoryResponse": { "required": [ "userAddress", "markets", "totalCount", "totalCountExact", "hasMore" ], "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "True when another page is available.", "example": true }, "markets": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketPredictionHistoryItem" }, "nullable": true, "example": [ { "avgBuyPrice": "0.34098803308944694087", "avgSellPrice": "1.00000000000000000000", "conditionId": "0x0433839be2e0889423ff0a0efae939272899d09c284d309b346d3991d003c4c0", "currentPrice": "1.00000000000000000000", "eventId": 401638, "eventTitle": "Chelsea FC vs. Nottingham Forest FC", "groupItemTitle": "Chelsea FC", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/Repetitive-markets/premier+league.jpg", "isResolved": true, "netShares": "0", "outcome": "No", "pnl": "643126.136941", "question": "Will Chelsea FC win on 2026-05-04?", "resolvedAt": "2026-05-04T20:20:48Z", "sharesHeld": "0", "tokenAddress": "0x5f10f068a11aa7c2f4244d8d71bcfd1ad3f2ed337d916960eb2a660ad380f892", "totalBuyUsdc": "332768.337261", "totalSellUsdc": "975894.474202", "totalTrades": 71, "value": "0", "volume": "332768.337261" } ] }, "totalCount": { "type": "integer", "example": 1428 }, "totalCountExact": { "type": "boolean", "description": "False when totalCount is capped for broad wallet-history queries.", "example": true }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "hasMore": true, "markets": [ { "avgBuyPrice": "0.34098803308944694087", "avgSellPrice": "1.00000000000000000000", "conditionId": "0x0433839be2e0889423ff0a0efae939272899d09c284d309b346d3991d003c4c0", "currentPrice": "1.00000000000000000000", "eventId": 401638, "eventTitle": "Chelsea FC vs. Nottingham Forest FC", "groupItemTitle": "Chelsea FC", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/Repetitive-markets/premier+league.jpg", "isResolved": true, "netShares": "0", "outcome": "No", "pnl": "643126.136941", "question": "Will Chelsea FC win on 2026-05-04?", "resolvedAt": "2026-05-04T20:20:48Z", "sharesHeld": "0", "tokenAddress": "0x5f10f068a11aa7c2f4244d8d71bcfd1ad3f2ed337d916960eb2a660ad380f892", "totalBuyUsdc": "332768.337261", "totalSellUsdc": "975894.474202", "totalTrades": 71, "value": "0", "volume": "332768.337261" } ], "totalCount": 1428, "totalCountExact": true, "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketPriceInterval": { "enum": [ "1m", "1h", "1d", "5s", "1s", "auto" ], "type": "string", "example": "1m" }, "PolymarketPricePoint": { "required": [ "bucketStart", "price" ], "type": "object", "properties": { "bucketStart": { "type": "string", "format": "date-time", "example": "2026-06-22T12:00:00Z" }, "price": { "type": "number", "example": 0.0545 } }, "example": { "bucketStart": "2026-06-22T12:00:00Z", "price": 0.0545 } }, "PolymarketPriceRange": { "enum": [ "1d", "1w", "1m", "all" ], "type": "string", "example": "1d" }, "PolymarketPricesResponse": { "required": [ "tokenAddress", "interval", "endTime", "prices" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" }, "endTime": { "type": "string", "format": "date-time", "example": "2026-06-22T13:29:53.260946519Z" }, "interval": { "type": "string", "example": "1h" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketPricePoint" }, "nullable": true, "example": [ { "bucketStart": "2026-06-22T12:00:00Z", "price": 0.0545 } ] }, "startTime": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00Z" }, "tokenAddress": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } }, "example": { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "endTime": "2026-06-22T13:29:53.260946519Z", "interval": "1h", "prices": [ { "bucketStart": "2026-06-22T12:00:00Z", "price": 0.0545 } ], "startTime": "2024-01-01T00:00:00Z", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } }, "PolymarketStatsResponse": { "required": [ "totalVolume", "volume24h", "totalTraders", "activeMarkets", "resolvedMarkets", "totalTrades" ], "type": "object", "properties": { "activeMarkets": { "type": "integer", "example": 42344 }, "resolvedMarkets": { "type": "integer", "example": 1626032 }, "totalTraders": { "type": "integer", "example": 2955552 }, "totalTrades": { "type": "integer", "example": 1541962785 }, "totalVolume": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "74031837587.746668" }, "volume24h": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "320610637.818212" } }, "example": { "activeMarkets": 42344, "resolvedMarkets": 1626032, "totalTraders": 2955552, "totalTrades": 1541962785, "totalVolume": "74031837587.746668", "volume24h": "320610637.818212" } }, "PolymarketTopEventBreakdownMarket": { "required": [ "conditionId", "periodPnl", "tradeCount" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x881a3ffa618b6ae0ab95a5637e310afb1afc2d99c921bfe3235b15eccfce0344" }, "groupItemTitle": { "type": "string", "description": "Polymarket grouped-market item title.", "example": "Ghana" }, "imageUrl": { "type": "string", "description": "Polymarket market image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-ghana-flag-20260603-192743.png" }, "periodPnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "3748.1328272" }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will Ghana win the 2026 FIFA World Cup?" }, "tradeCount": { "type": "integer", "example": 6 } }, "example": { "conditionId": "0x881a3ffa618b6ae0ab95a5637e310afb1afc2d99c921bfe3235b15eccfce0344", "groupItemTitle": "Ghana", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-ghana-flag-20260603-192743.png", "periodPnl": "3748.1328272", "question": "Will Ghana win the 2026 FIFA World Cup?", "tradeCount": 6 } }, "PolymarketTopEventBreakdownResponse": { "required": [ "eventId", "userAddress", "markets" ], "type": "object", "properties": { "eventId": { "type": "integer", "example": 30615 }, "eventTitle": { "type": "string", "description": "Polymarket event title.", "example": "World Cup Winner" }, "markets": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketTopEventBreakdownMarket" }, "nullable": true, "example": [ { "conditionId": "0x881a3ffa618b6ae0ab95a5637e310afb1afc2d99c921bfe3235b15eccfce0344", "groupItemTitle": "Ghana", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-ghana-flag-20260603-192743.png", "periodPnl": "3748.1328272", "question": "Will Ghana win the 2026 FIFA World Cup?", "tradeCount": 6 } ] }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "eventId": 30615, "eventTitle": "World Cup Winner", "markets": [ { "conditionId": "0x881a3ffa618b6ae0ab95a5637e310afb1afc2d99c921bfe3235b15eccfce0344", "groupItemTitle": "Ghana", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/world-cup-winner-ghana-flag-20260603-192743.png", "periodPnl": "3748.1328272", "question": "Will Ghana win the 2026 FIFA World Cup?", "tradeCount": 6 } ], "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketTopEventEntry": { "required": [ "rank", "userAddress", "eventId", "periodPnl", "tradeCount" ], "type": "object", "properties": { "eventId": { "type": "integer", "example": 511447 }, "eventTitle": { "type": "string", "description": "Polymarket event title.", "example": "Belgium vs. IR Iran - More Markets" }, "iconUrl": { "type": "string", "description": "Polymarket event icon URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/soccer ball-bba4025f77.png" }, "imageUrl": { "type": "string", "description": "Polymarket event image URL.", "example": "https://polymarket-upload.s3.us-east-2.amazonaws.com/soccer ball-bba4025f77.png" }, "periodPnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1242863.7688589205" }, "rank": { "type": "integer", "example": 1 }, "tradeCount": { "type": "integer", "example": 3311 }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0x204f72f35326db932158CBA6AdfF0B9A1DA95e14" } }, "example": { "eventId": 511447, "eventTitle": "Belgium vs. IR Iran - More Markets", "iconUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/soccer ball-bba4025f77.png", "imageUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/soccer ball-bba4025f77.png", "periodPnl": "1242863.7688589205", "rank": 1, "tradeCount": 3311, "userAddress": "0x204f72f35326db932158CBA6AdfF0B9A1DA95e14" } }, "PolymarketTopHolderItem": { "required": [ "userAddress", "netPosition", "netFlowUsdc", "totalTrades", "positions" ], "type": "object", "properties": { "netFlowUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0" }, "netPosition": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "800000" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketTopHolderPositionItem" }, "nullable": true, "example": [ { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "groupItemTitle": "Netherlands", "netFlowUsdc": "0", "netPosition": "800000", "outcome": "Yes", "question": "Will Netherlands win the 2026 FIFA World Cup?", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } ] }, "totalTrades": { "type": "integer", "example": 0 }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0x2c335066FE58fe9237c3d3Dc7b275C2a034a0563" } }, "example": { "netFlowUsdc": "0", "netPosition": "800000", "positions": [ { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "groupItemTitle": "Netherlands", "netFlowUsdc": "0", "netPosition": "800000", "outcome": "Yes", "question": "Will Netherlands win the 2026 FIFA World Cup?", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } ], "totalTrades": 0, "userAddress": "0x2c335066FE58fe9237c3d3Dc7b275C2a034a0563" } }, "PolymarketTopHolderPositionItem": { "required": [ "tokenAddress", "netPosition", "netFlowUsdc" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" }, "groupItemTitle": { "type": "string", "description": "Polymarket grouped-market item title.", "example": "Netherlands" }, "netFlowUsdc": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "0" }, "netPosition": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "800000" }, "outcome": { "type": "string", "description": "Polymarket outcome token label (e.g. \"Yes\", \"No\").", "example": "Yes" }, "question": { "type": "string", "description": "Polymarket market question.", "example": "Will Netherlands win the 2026 FIFA World Cup?" }, "tokenAddress": { "type": "string", "description": "Polymarket outcome token ID encoded as 0x-prefixed uint256 hex.", "example": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } }, "example": { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "groupItemTitle": "Netherlands", "netFlowUsdc": "0", "netPosition": "800000", "outcome": "Yes", "question": "Will Netherlands win the 2026 FIFA World Cup?", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } }, "PolymarketTopHoldersResponse": { "required": [ "conditionId", "holders" ], "type": "object", "properties": { "conditionId": { "type": "string", "description": "Polymarket market condition ID (0x-prefixed bytes32 hex).", "example": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1" }, "holders": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketTopHolderItem" }, "nullable": true, "example": [ { "netFlowUsdc": "0", "netPosition": "800000", "positions": [ { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "groupItemTitle": "Netherlands", "netFlowUsdc": "0", "netPosition": "800000", "outcome": "Yes", "question": "Will Netherlands win the 2026 FIFA World Cup?", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } ], "totalTrades": 0, "userAddress": "0x2c335066FE58fe9237c3d3Dc7b275C2a034a0563" } ] } }, "example": { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "holders": [ { "netFlowUsdc": "0", "netPosition": "800000", "positions": [ { "conditionId": "0x9be56371f6a29d12769b2f196847ee825b9585ebb8bfa042136be031b081eba1", "groupItemTitle": "Netherlands", "netFlowUsdc": "0", "netPosition": "800000", "outcome": "Yes", "question": "Will Netherlands win the 2026 FIFA World Cup?", "tokenAddress": "0x7baa312d6393ea83c631fb77b47061651a2a9992c40fcac017009611d6a03df4" } ], "totalTrades": 0, "userAddress": "0x2c335066FE58fe9237c3d3Dc7b275C2a034a0563" } ] } }, "PolymarketWalletPortfolioResponse": { "required": [ "userAddress", "unrealizedPnl", "openPositionValue", "openPositions", "openMarkets" ], "type": "object", "properties": { "openMarkets": { "type": "integer", "example": 56 }, "openPositionValue": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "503776.5191501625" }, "openPositions": { "type": "integer", "example": 58 }, "unrealizedPnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "-3469.2627198375" }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "openMarkets": 56, "openPositionValue": "503776.5191501625", "openPositions": 58, "unrealizedPnl": "-3469.2627198375", "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketWalletSearchResult": { "required": [ "address", "displayName" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "displayName": { "type": "string", "example": "abc123" } }, "example": { "address": "abc123", "displayName": "abc123" } }, "PolymarketWalletSummaryBalanceResponse": { "required": [ "userAddress", "usdcBalance" ], "type": "object", "properties": { "usdcBalance": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "-15906.549249" }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "usdcBalance": "-15906.549249", "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketWalletSummaryBiggestWinResponse": { "required": [ "userAddress", "biggestWin" ], "type": "object", "properties": { "biggestWin": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "643126.136941" }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "biggestWin": "643126.136941", "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketWalletSummaryPnLResponse": { "required": [ "userAddress", "totalPnl", "realizedPnl", "deployedCapital", "uniqueMarkets", "marketsWon", "marketsTotal" ], "type": "object", "properties": { "deployedCapital": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1200.5" }, "marketsTotal": { "type": "integer", "example": 1428 }, "marketsWon": { "type": "integer", "example": 695 }, "realizedPnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1173358.66161" }, "totalPnl": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "1189259.007401233" }, "uniqueMarkets": { "type": "integer", "example": 1292 }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "deployedCapital": "1200.5", "marketsTotal": 1428, "marketsWon": 695, "realizedPnl": "1173358.66161", "totalPnl": "1189259.007401233", "uniqueMarkets": 1292, "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketWalletSummaryStatsResponse": { "required": [ "userAddress", "totalVolume", "totalFees", "totalTrades", "totalEvents" ], "type": "object", "properties": { "firstActiveAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-11-07T00:00:00Z" }, "totalEvents": { "type": "integer", "example": 390337 }, "totalFees": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "70296.03806" }, "totalTrades": { "type": "integer", "example": 390337 }, "totalVolume": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "89011677.488757" }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "firstActiveAt": "2025-11-07T00:00:00Z", "totalEvents": 390337, "totalFees": "70296.03806", "totalTrades": 390337, "totalVolume": "89011677.488757", "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PolymarketWalletTag": { "required": [ "tag", "label", "events", "volume" ], "type": "object", "properties": { "events": { "type": "integer", "example": 1284 }, "label": { "type": "string", "example": "Politics" }, "tag": { "type": "string", "example": "politics" }, "volume": { "type": "string", "description": "Numeric value serialized as a decimal string. Used for USDC amounts, outcome-token share counts, and per-share prices; the field name disambiguates the unit.", "example": "45820.12" } }, "example": { "events": 1284, "label": "Politics", "tag": "politics", "volume": "45820.12" } }, "PolymarketWalletTagsResponse": { "required": [ "userAddress", "tags" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketWalletTag" }, "nullable": true, "example": [ { "events": 1284, "label": "Politics", "tag": "politics", "volume": "45820.12" } ] }, "userAddress": { "type": "string", "description": "Polymarket trade address (0x + 40 hex chars).", "example": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "example": { "tags": [ { "events": 1284, "label": "Politics", "tag": "politics", "volume": "45820.12" } ], "userAddress": "0xBDDF61Af533fF524D27154e589d2D7A81510C684" } }, "PopulatedTag": { "required": [ "id", "label", "rank", "excludeEntities", "disablePage" ], "type": "object", "properties": { "chain": { "$ref": "#/components/schemas/Chain" }, "disablePage": { "type": "boolean", "description": "Whether the dedicated page for this tag is disabled.", "example": false }, "excludeEntities": { "type": "boolean", "description": "Whether entities are excluded from this tag.", "example": false }, "id": { "type": "string", "description": "The tag identifier.", "example": "proof-of-reserves" }, "label": { "type": "string", "description": "Human-readable label for this tag parameter combination.", "example": "Binance Proof of Reserves" }, "rank": { "type": "integer", "description": "Display rank of the tag.", "example": 20 }, "tagParams": { "type": "string", "description": "The specific parameter value for this tag instance.", "nullable": true, "example": "Binance" } }, "example": { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } }, "PortfolioEntry": { "required": [ "id", "name", "symbol", "balance", "price", "usd" ], "type": "object", "properties": { "balance": { "type": "number", "description": "Token balance in whole units.", "example": 1500.5 }, "id": { "type": "string", "example": "usd-coin" }, "name": { "type": "string", "example": "USD Coin" }, "price": { "type": "number", "description": "Token price in USD.", "example": 1 }, "symbol": { "type": "string", "example": "USDC" }, "usd": { "type": "number", "description": "Balance value in USD.", "example": 1500.5 } }, "example": { "balance": 1500.5, "id": "usd-coin", "name": "USD Coin", "price": 1, "symbol": "USDC", "usd": 1500.5 } }, "PredictedEntity": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Predicted entity identifier.", "example": "binance" }, "name": { "type": "string", "description": "Predicted entity display name.", "example": "Binance" }, "type": { "type": "string", "description": "Predicted entity type.", "nullable": true, "example": "cex" } }, "example": { "id": "binance", "name": "Binance", "type": "cex" } }, "PrimaryName": { "required": [ "name", "address" ], "type": "object", "properties": { "address": { "type": "string", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "name": { "type": "string", "example": "vitalik.eth" } }, "example": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "vitalik.eth" } }, "RiskScoreEntityResponse": { "required": [ "entity_id", "risk_level" ], "type": "object", "properties": { "darkweb_score": { "type": "integer", "description": "Entity-level darkweb score (0-100).", "nullable": true, "example": 1 }, "entity_id": { "type": "string", "description": "The entity identifier.", "example": "binance" }, "entity_name": { "type": "string", "description": "Human-readable entity name.", "nullable": true, "example": "Binance" }, "entity_type": { "type": "string", "description": "Entity classification type.", "nullable": true, "example": "exchange" }, "gambling_score": { "type": "integer", "description": "Entity-level gambling score (0-100).", "nullable": true, "example": 1 }, "greatest_risk_category": { "type": "string", "description": "Category with the highest risk score.", "nullable": true, "example": "hacker" }, "greatest_risk_category_backward": { "type": "string", "description": "Category with the highest backward propagation score.", "nullable": true, "example": "abc123" }, "greatest_risk_category_forward": { "type": "string", "description": "Category with the highest forward propagation score.", "nullable": true, "example": "abc123" }, "hacker_score": { "type": "integer", "description": "Entity-level hacker score (0-100).", "nullable": true, "example": 1 }, "highest_risk_address": { "type": "string", "description": "Address with the highest risk score in this entity.", "nullable": true, "example": "abc123" }, "max_score": { "type": "integer", "description": "Highest weighted entity-level score across all categories.", "nullable": true, "example": 66 }, "max_score_backward": { "type": "integer", "description": "Highest backward propagation score across entity addresses.", "nullable": true, "example": 1 }, "max_score_forward": { "type": "integer", "description": "Highest forward propagation score across entity addresses.", "nullable": true, "example": 1 }, "mixed_kyc_service_score": { "type": "integer", "description": "Entity-level mixed-KYC service score (0-100).", "nullable": true, "example": 1 }, "mixer_score": { "type": "integer", "description": "Entity-level mixer score (0-100).", "nullable": true, "example": 1 }, "non_kyc_service_score": { "type": "integer", "description": "Entity-level non-KYC service score (0-100).", "nullable": true, "example": 1 }, "ponzi_score": { "type": "integer", "description": "Entity-level ponzi score (0-100).", "nullable": true, "example": 1 }, "privacy_score": { "type": "integer", "description": "Entity-level privacy score (0-100).", "nullable": true, "example": 1 }, "ransomware_score": { "type": "integer", "description": "Entity-level ransomware score (0-100).", "nullable": true, "example": 1 }, "risk_level": { "type": "string", "description": "Overall risk level: NONE, LOW, MEDIUM, HIGH, or SEVERE.", "example": "HIGH" }, "risky_addresses": { "type": "integer", "description": "Number of entity addresses with a risk score \u003e= 10.", "nullable": true, "example": 3 }, "risky_addresses_backward": { "type": "integer", "description": "Entity addresses with backward risk score \u003e= 10.", "nullable": true, "example": 1 }, "risky_addresses_forward": { "type": "integer", "description": "Entity addresses with forward risk score \u003e= 10.", "nullable": true, "example": 1 }, "sanctions_score": { "type": "integer", "description": "Entity-level sanctions score (0-100).", "nullable": true, "example": 1 }, "scam_score": { "type": "integer", "description": "Entity-level scam score (0-100).", "nullable": true, "example": 1 }, "seed_addresses": { "type": "integer", "description": "Number of entity addresses that are direct risk sources (seeds from tags/entity type).", "nullable": true, "example": 1 }, "token_blacklist_score": { "type": "integer", "description": "Entity-level token-blacklist score (0-100).", "nullable": true, "example": 1 }, "top_seed_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/RiskScoreEntitySeedAddressAPIType" }, "description": "Top addresses within this entity that are themselves risk seeds, sorted by seed score.", "example": [ { "address": "abc123", "chain_type": "evm", "risk_category": "mixed-kyc-service", "seed_score": 30 } ] }, "top_sources": { "type": "array", "items": { "$ref": "#/components/schemas/RiskScoreEntitySourceAPIType" }, "description": "Top external risk seeds whose funds reached this entity's addresses (or that this entity's addresses funded), aggregated across all entity addresses.", "example": [ { "contribution_usd": 1.23, "direction": "forward", "hop_distance": 1, "risk_category": "hacker", "seed_address": "abc123" } ] }, "updated_at": { "type": "string", "description": "Timestamp of the most recent update (RFC3339).", "nullable": true, "example": "abc123" } }, "example": { "darkweb_score": 1, "entity_id": "binance", "entity_name": "Binance", "entity_type": "exchange", "gambling_score": 1, "greatest_risk_category": "hacker", "greatest_risk_category_backward": "abc123", "greatest_risk_category_forward": "abc123", "hacker_score": 1, "highest_risk_address": "abc123", "max_score": 66, "max_score_backward": 1, "max_score_forward": 1, "mixed_kyc_service_score": 1, "mixer_score": 1, "non_kyc_service_score": 1, "ponzi_score": 1, "privacy_score": 1, "ransomware_score": 1, "risk_level": "HIGH", "risky_addresses": 3, "risky_addresses_backward": 1, "risky_addresses_forward": 1, "sanctions_score": 1, "scam_score": 1, "seed_addresses": 1, "token_blacklist_score": 1, "top_seed_addresses": [ { "address": "abc123", "chain_type": "evm", "risk_category": "mixed-kyc-service", "seed_score": 30 } ], "top_sources": [ { "contribution_usd": 1.23, "direction": "forward", "hop_distance": 1, "risk_category": "hacker", "seed_address": "abc123" } ], "updated_at": "abc123" } }, "RiskScoreEntitySeedAddressAPIType": { "required": [ "chain_type", "address", "risk_category", "seed_score" ], "type": "object", "properties": { "address": { "type": "string", "example": "abc123" }, "chain_type": { "type": "string", "example": "evm" }, "risk_category": { "type": "string", "description": "The category that made this address a seed.", "example": "mixed-kyc-service" }, "seed_score": { "type": "integer", "description": "Raw seed score assigned by the upstream tag/entity-type rule.", "example": 30 } }, "example": { "address": "abc123", "chain_type": "evm", "risk_category": "mixed-kyc-service", "seed_score": 30 } }, "RiskScoreEntitySourceAPIType": { "required": [ "seed_address", "risk_category", "direction", "contribution_usd", "hop_distance" ], "type": "object", "properties": { "contribution_usd": { "type": "number", "description": "Risk-weighted USD attributed to this seed, summed across the entity's addresses.", "example": 1.23 }, "direction": { "type": "string", "description": "'forward' = seed sent into entity addresses; 'backward' = entity addresses funded the seed.", "example": "forward" }, "hop_distance": { "type": "integer", "description": "Shortest hop distance from this seed to any of the entity's addresses.", "example": 1 }, "risk_category": { "type": "string", "description": "Risk category of the seed.", "example": "hacker" }, "seed_address": { "type": "string", "description": "External risk seed address.", "example": "abc123" } }, "example": { "contribution_usd": 1.23, "direction": "forward", "hop_distance": 1, "risk_category": "hacker", "seed_address": "abc123" } }, "RiskScorePathAPIType": { "required": [ "chain_type", "seed_address", "risk_category", "direction", "path_nodes" ], "type": "object", "properties": { "chain_type": { "type": "string", "description": "Chain type (EVM chains collapse to 'evm').", "example": "evm" }, "contribution_usd": { "type": "number", "description": "USD value traced along this path.", "nullable": true, "example": 1.23 }, "direction": { "type": "string", "description": "'forward' = seed sent to target; 'backward' = target sent to seed.", "example": "forward" }, "hop_distance": { "type": "integer", "description": "Number of hops from seed to target.", "nullable": true, "example": 1 }, "path_nodes": { "type": "array", "items": { "$ref": "#/components/schemas/RiskScorePathNodeAPIType" }, "description": "Dominant address chain from seed to target.", "nullable": true, "example": [ { "address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A", "hop_distance": 0 } ] }, "risk_category": { "type": "string", "description": "Risk category of the seed.", "example": "hacker" }, "score": { "type": "integer", "description": "Risk score contributed by this path at the target (0-100).", "nullable": true, "example": 1 }, "seed_address": { "type": "string", "description": "Risky source address this path traces back to.", "example": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A" } }, "example": { "chain_type": "evm", "contribution_usd": 1.23, "direction": "forward", "hop_distance": 1, "path_nodes": [ { "address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A", "hop_distance": 0 } ], "risk_category": "hacker", "score": 1, "seed_address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A" } }, "RiskScorePathNodeAPIType": { "required": [ "address", "hop_distance" ], "type": "object", "properties": { "address": { "type": "string", "description": "Address at this position in the path.", "example": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A" }, "hop_distance": { "type": "integer", "description": "Hop distance from the seed for this node (0 = seed itself).", "example": 0 } }, "example": { "address": "0x40B9b889A21Ff1534d018D71Dc406122EBcf3F5A", "hop_distance": 0 } }, "RiskScoreResponse": { "required": [ "chain_type", "address", "risk_level", "is_seed" ], "type": "object", "properties": { "address": { "type": "string", "description": "The queried address in its canonical format.", "example": "0x6068A806a62DBb6a42E1A83e17E249bF4f8dB3aB" }, "chain_type": { "type": "string", "description": "Blockchain type for the address. May be empty if the address has no risk data.", "example": "evm" }, "darkweb_score": { "type": "integer", "description": "Risk score for darkweb-related exposure (0-100).", "nullable": true, "example": 0 }, "gambling_score": { "type": "integer", "description": "Risk score for gambling-related exposure (0-100).", "nullable": true, "example": 0 }, "greatest_risk_category": { "type": "string", "description": "The category with the highest risk score.", "nullable": true, "example": "hacker" }, "greatest_risk_category_backward": { "type": "string", "description": "Category with the highest backward propagation score.", "nullable": true, "example": "abc123" }, "greatest_risk_category_forward": { "type": "string", "description": "Category with the highest forward propagation score.", "nullable": true, "example": "hacker" }, "hacker_score": { "type": "integer", "description": "Risk score for hacker-related exposure (0-100).", "nullable": true, "example": 66 }, "hop_distance": { "type": "integer", "description": "Number of transaction hops to the nearest risky source.", "nullable": true, "example": 1 }, "is_seed": { "type": "boolean", "description": "True if this address is a direct risk source (seed), not scored via propagation.", "example": false }, "max_hop_reached": { "type": "integer", "description": "Maximum hop distance analyzed in the risk computation.", "nullable": true, "example": 1 }, "max_score": { "type": "integer", "description": "The highest individual category score, used to derive risk_level.", "nullable": true, "example": 66 }, "max_score_backward": { "type": "integer", "description": "Highest risk score from backward propagation (funds sent to risky sources).", "nullable": true, "example": 0 }, "max_score_forward": { "type": "integer", "description": "Highest risk score from forward propagation (funds received from risky sources).", "nullable": true, "example": 66 }, "mixed_kyc_service_score": { "type": "integer", "description": "Risk score for mixed-KYC service exposure (0-100).", "nullable": true, "example": 0 }, "mixer_score": { "type": "integer", "description": "Risk score for mixer-related exposure (0-100).", "nullable": true, "example": 0 }, "non_kyc_service_score": { "type": "integer", "description": "Risk score for non-KYC service exposure (0-100).", "nullable": true, "example": 0 }, "ponzi_score": { "type": "integer", "description": "Risk score for ponzi-related exposure (0-100).", "nullable": true, "example": 0 }, "privacy_score": { "type": "integer", "description": "Risk score for privacy-protocol-related exposure (0-100).", "nullable": true, "example": 0 }, "ransomware_score": { "type": "integer", "description": "Risk score for ransomware-related exposure (0-100).", "nullable": true, "example": 0 }, "risk_level": { "type": "string", "description": "Overall risk level: NONE, LOW, MEDIUM, HIGH, or SEVERE.", "example": "HIGH" }, "risk_weighted_incoming_usd": { "type": "number", "description": "Total risk-weighted USD that reached this address from upstream risky sources (forward propagation).", "nullable": true, "example": 1503.02 }, "risk_weighted_outgoing_usd": { "type": "number", "description": "Total risk-weighted USD this address sent toward downstream risky sources (backward propagation).", "nullable": true, "example": 0 }, "sanctioned_1hop_score": { "type": "integer", "description": "Risk score for direct (1-hop) high-risk entity exposure (0-100).", "nullable": true, "example": 0 }, "sanctions_score": { "type": "integer", "description": "Risk score for sanctions-related exposure (0-100).", "nullable": true, "example": 0 }, "scam_score": { "type": "integer", "description": "Risk score for scam-related exposure (0-100).", "nullable": true, "example": 0 }, "token_blacklist_score": { "type": "integer", "description": "Risk score for blacklisted-token-related exposure (0-100).", "nullable": true, "example": 0 }, "top_sources": { "type": "array", "items": { "$ref": "#/components/schemas/RiskScoreSourceAPIType" }, "description": "Top contributing sources to the risk score, ranked by contribution.", "example": [ { "contribution_pct": 100, "contribution_usd": 1503.02, "direction": "forward", "first_ts": "2019-11-14T00:00:00Z", "hop_distance": 1, "last_ts": "2019-12-13T00:00:00Z", "risk_category": "hacker", "seed_address": "0x851d8fe098341d5592DbBC7bCd4388F73c16291b" } ] }, "updated_at": { "type": "string", "description": "Timestamp of the most recent risk score update (RFC3339).", "nullable": true, "example": "2025-12-16T03:06:14Z" } }, "example": { "address": "0x6068A806a62DBb6a42E1A83e17E249bF4f8dB3aB", "chain_type": "evm", "darkweb_score": 0, "gambling_score": 0, "greatest_risk_category": "hacker", "greatest_risk_category_backward": "abc123", "greatest_risk_category_forward": "hacker", "hacker_score": 66, "hop_distance": 1, "is_seed": false, "max_hop_reached": 1, "max_score": 66, "max_score_backward": 0, "max_score_forward": 66, "mixed_kyc_service_score": 0, "mixer_score": 0, "non_kyc_service_score": 0, "ponzi_score": 0, "privacy_score": 0, "ransomware_score": 0, "risk_level": "HIGH", "risk_weighted_incoming_usd": 1503.02, "risk_weighted_outgoing_usd": 0, "sanctioned_1hop_score": 0, "sanctions_score": 0, "scam_score": 0, "token_blacklist_score": 0, "top_sources": [ { "contribution_pct": 100, "contribution_usd": 1503.02, "direction": "forward", "first_ts": "2019-11-14T00:00:00Z", "hop_distance": 1, "last_ts": "2019-12-13T00:00:00Z", "risk_category": "hacker", "seed_address": "0x851d8fe098341d5592DbBC7bCd4388F73c16291b" } ], "updated_at": "2025-12-16T03:06:14Z" } }, "RiskScoreSourceAPIType": { "required": [ "seed_address", "risk_category", "direction", "contribution_pct", "contribution_usd", "hop_distance" ], "type": "object", "properties": { "contribution_pct": { "type": "number", "description": "Percentage contribution of this source to the risk assessment.", "example": 100 }, "contribution_usd": { "type": "number", "description": "USD value of funds traced to this risky source.", "example": 1503.02 }, "direction": { "type": "string", "description": "Direction of risk flow: 'forward' (seed sent to this address) or 'backward' (this address funded the seed).", "example": "forward" }, "first_ts": { "type": "string", "description": "Timestamp of the first transaction linking to this source (RFC3339).", "nullable": true, "example": "2019-11-14T00:00:00Z" }, "hop_distance": { "type": "integer", "description": "Number of transaction hops from the queried address to this source.", "example": 1 }, "last_ts": { "type": "string", "description": "Timestamp of the last transaction linking to this source (RFC3339).", "nullable": true, "example": "2019-12-13T00:00:00Z" }, "risk_category": { "type": "string", "description": "Risk category of this source.", "example": "hacker" }, "seed_address": { "type": "string", "description": "Address of the risky source entity.", "example": "0x851d8fe098341d5592DbBC7bCd4388F73c16291b" } }, "example": { "contribution_pct": 100, "contribution_usd": 1503.02, "direction": "forward", "first_ts": "2019-11-14T00:00:00Z", "hop_distance": 1, "last_ts": "2019-12-13T00:00:00Z", "risk_category": "hacker", "seed_address": "0x851d8fe098341d5592DbBC7bCd4388F73c16291b" } }, "SearchFilterLimits": { "type": "object", "properties": { "arkhamAddresses": { "type": "integer", "description": "Max Arkham-curated addresses with labels to return (0–50).", "example": 5 }, "arkhamEntities": { "type": "integer", "description": "Max Arkham-curated entities to return (0–50).", "example": 5 }, "ens": { "type": "integer", "description": "Max ENS primary names to return (0–50).", "example": 5 }, "opensea": { "type": "integer", "description": "Max OpenSea usernames to return (0–50).", "example": 5 }, "polymarketEvents": { "type": "integer", "description": "Max Polymarket prediction events to return (0–50). Defaults to 0 (disabled).", "example": 5 }, "pools": { "type": "integer", "description": "Max Solana pools to return (0–50).", "example": 5 }, "services": { "type": "integer", "description": "Max CEX/VASP entities to return (0–50).", "example": 5 }, "tags": { "type": "integer", "description": "Max tag matches to return (0–50). Defaults to 0 (disabled).", "example": 0 }, "tokens": { "type": "integer", "description": "Max tokens to return (0–50).", "example": 10 }, "twitter": { "type": "integer", "description": "Max entities matched by Twitter handle to return (0–50).", "example": 5 }, "types": { "type": "integer", "description": "Max entity-type matches to return (0–50).", "example": 5 }, "userAddresses": { "type": "integer", "description": "Max user-defined addresses with labels to return (0–50). Requires authentication.", "example": 5 }, "userEntities": { "type": "integer", "description": "Max user-defined entities to return (0–50). Requires authentication.", "example": 5 } }, "example": { "arkhamAddresses": 5, "arkhamEntities": 5, "ens": 5, "opensea": 5, "polymarketEvents": 5, "pools": 5, "services": 5, "tags": 0, "tokens": 10, "twitter": 5, "types": 5, "userAddresses": 5, "userEntities": 5 } }, "SearchFilterOffsets": { "type": "object", "properties": { "arkhamAddresses": { "type": "integer", "description": "Skip the first N Arkham addresses with labels (0–500).", "example": 0 }, "arkhamEntities": { "type": "integer", "description": "Skip the first N Arkham entities (0–500).", "example": 0 }, "ens": { "type": "integer", "description": "Skip the first N ENS names (0–500).", "example": 0 }, "opensea": { "type": "integer", "description": "Skip the first N OpenSea usernames (0–500).", "example": 0 }, "polymarketEvents": { "type": "integer", "description": "Skip the first N Polymarket events (0–500).", "example": 0 }, "pools": { "type": "integer", "description": "Skip the first N pools (0–500).", "example": 0 }, "services": { "type": "integer", "description": "Skip the first N CEX/VASP entities (0–500).", "example": 0 }, "tags": { "type": "integer", "description": "Skip the first N tag matches (0–500).", "example": 0 }, "tokens": { "type": "integer", "description": "Skip the first N tokens (0–500).", "example": 0 }, "twitter": { "type": "integer", "description": "Skip the first N Twitter matches (0–500).", "example": 0 }, "types": { "type": "integer", "description": "Skip the first N entity-type matches (0–500).", "example": 0 }, "userAddresses": { "type": "integer", "description": "Skip the first N user addresses with labels (0–500).", "example": 0 }, "userEntities": { "type": "integer", "description": "Skip the first N user entities (0–500).", "example": 0 } }, "example": { "arkhamAddresses": 0, "arkhamEntities": 0, "ens": 0, "opensea": 0, "polymarketEvents": 0, "pools": 0, "services": 0, "tags": 0, "tokens": 0, "twitter": 0, "types": 0, "userAddresses": 0, "userEntities": 0 } }, "SearchResults": { "type": "object", "properties": { "arkhamAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "example": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } ] }, "arkhamEntities": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" }, "example": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ] }, "ens": { "type": "array", "items": { "$ref": "#/components/schemas/PrimaryName" }, "example": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "vitalik.eth" } ] }, "opensea": { "type": "array", "items": { "$ref": "#/components/schemas/OpenSea" }, "example": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "profileImage": "abc123", "username": "Binance" } ] }, "polymarketEvents": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketEventSearchResult" }, "example": [ { "category": "Crypto", "eventId": 1, "iconUrl": "abc123", "imageUrl": "abc123", "marketCount": 1, "slug": "will-bitcoin-hit-100k-2026", "title": "Will Bitcoin hit $100k in 2026?" } ] }, "polymarketWallet": { "$ref": "#/components/schemas/PolymarketWalletSearchResult" }, "polymarketWallets": { "type": "array", "items": { "$ref": "#/components/schemas/PolymarketWalletSearchResult" }, "example": [ { "address": "abc123", "displayName": "abc123" } ] }, "pools": { "type": "array", "items": { "$ref": "#/components/schemas/SolanaPoolSearchResult" }, "example": [ { "liquidityUsd": 1.23, "marketCapUsd": 1.23, "poolAddress": "58oQChx4yWmvKdwLLZzBi4ChoCc2fqCUWBkwMihLYQo2", "priceUsd": 1.23, "pricingID": "usd-coin", "programAddress": "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8", "tokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "tokenImageUrl": "abc123", "tokenName": "USD Coin", "tokenSymbol": "USDC", "volume1h": 1.23 } ] }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" }, "example": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/SearchTag" }, "example": [ { "formatted": "Hot Wallet", "value": "hot-wallet" } ] }, "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/Token" }, "example": [ { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" } ] }, "twitter": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" }, "example": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ] }, "types": { "type": "array", "items": { "type": "string" }, "example": [ "cex" ] }, "userAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "example": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } ] }, "userEntities": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" }, "example": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ] } }, "example": { "arkhamAddresses": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } ], "arkhamEntities": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ], "ens": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "name": "vitalik.eth" } ], "opensea": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "profileImage": "abc123", "username": "Binance" } ], "polymarketEvents": [ { "category": "Crypto", "eventId": 1, "iconUrl": "abc123", "imageUrl": "abc123", "marketCount": 1, "slug": "will-bitcoin-hit-100k-2026", "title": "Will Bitcoin hit $100k in 2026?" } ], "polymarketWallet": { "address": "abc123", "displayName": "abc123" }, "polymarketWallets": [ { "address": "abc123", "displayName": "abc123" } ], "pools": [ { "liquidityUsd": 1.23, "marketCapUsd": 1.23, "poolAddress": "58oQChx4yWmvKdwLLZzBi4ChoCc2fqCUWBkwMihLYQo2", "priceUsd": 1.23, "pricingID": "usd-coin", "programAddress": "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8", "tokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "tokenImageUrl": "abc123", "tokenName": "USD Coin", "tokenSymbol": "USDC", "volume1h": 1.23 } ], "services": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ], "tags": [ { "formatted": "Hot Wallet", "value": "hot-wallet" } ], "tokens": [ { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" } ], "twitter": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ], "types": [ "cex" ], "userAddresses": [ { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } } ], "userEntities": [ { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } ] } }, "SearchTag": { "required": [ "value", "formatted" ], "type": "object", "properties": { "formatted": { "type": "string", "example": "Hot Wallet" }, "value": { "type": "string", "example": "hot-wallet" } }, "example": { "formatted": "Hot Wallet", "value": "hot-wallet" } }, "SolanaEnrichedAnyTransfer": { "required": [ "id", "blockTimestamp", "blockNumber", "blockHash", "transactionHash", "fromAddress", "fromAddressOwner", "toAddress", "toAddressOwner", "tokenAddress", "tokenName", "tokenSymbol", "tokenDecimals", "unitValue", "tokenId", "historicalUSD", "instruction", "instructionIndex", "parentInstructionIndex", "program", "chain", "type" ], "type": "object", "properties": { "blockHash": { "type": "string" }, "blockNumber": { "minimum": 0, "type": "integer" }, "blockTimestamp": { "type": "string", "format": "date-time" }, "chain": { "$ref": "#/components/schemas/Chain" }, "fromAddress": { "$ref": "#/components/schemas/Address" }, "fromAddressOwner": { "$ref": "#/components/schemas/Address" }, "historicalUSD": { "type": "number" }, "id": { "type": "string" }, "instruction": { "type": "string", "nullable": true }, "instructionIndex": { "type": "integer" }, "parentInstructionIndex": { "type": "integer", "nullable": true }, "program": { "$ref": "#/components/schemas/Address" }, "toAddress": { "$ref": "#/components/schemas/Address" }, "toAddressOwner": { "$ref": "#/components/schemas/Address" }, "tokenAddress": { "$ref": "#/components/schemas/Address" }, "tokenDecimals": { "minimum": 0, "type": "integer", "nullable": true }, "tokenId": { "type": "string", "nullable": true }, "tokenName": { "type": "string", "nullable": true }, "tokenSymbol": { "type": "string", "nullable": true }, "transactionHash": { "type": "string" }, "type": { "type": "string" }, "unitValue": { "type": "number" } } }, "SolanaPoolSearchResult": { "required": [ "poolAddress", "tokenAddress", "tokenName", "tokenSymbol", "priceUsd", "marketCapUsd", "liquidityUsd", "volume1h" ], "type": "object", "properties": { "liquidityUsd": { "type": "number", "example": 1.23 }, "marketCapUsd": { "type": "number", "example": 1.23 }, "poolAddress": { "type": "string", "example": "58oQChx4yWmvKdwLLZzBi4ChoCc2fqCUWBkwMihLYQo2" }, "priceUsd": { "type": "number", "example": 1.23 }, "pricingID": { "type": "string", "example": "usd-coin" }, "programAddress": { "type": "string", "example": "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8" }, "tokenAddress": { "type": "string", "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" }, "tokenImageUrl": { "type": "string", "example": "abc123" }, "tokenName": { "type": "string", "example": "USD Coin" }, "tokenSymbol": { "type": "string", "example": "USDC" }, "volume1h": { "type": "number", "example": 1.23 } }, "example": { "liquidityUsd": 1.23, "marketCapUsd": 1.23, "poolAddress": "58oQChx4yWmvKdwLLZzBi4ChoCc2fqCUWBkwMihLYQo2", "priceUsd": 1.23, "pricingID": "usd-coin", "programAddress": "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8", "tokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "tokenImageUrl": "abc123", "tokenName": "USD Coin", "tokenSymbol": "USDC", "volume1h": 1.23 } }, "SortDir": { "enum": [ "asc", "desc" ], "type": "string", "example": "asc" }, "StreamV2Response": { "required": [ "streamId", "id", "createdAt", "lastActive", "transfersUsed", "isConnected" ], "type": "object", "properties": { "createdAt": { "type": "string", "description": "Timestamp when the stream was created.", "format": "date-time", "example": "2026-07-14T09:12:43Z" }, "id": { "type": "integer", "description": "Internal database identifier for the stream. No endpoint accepts it — use streamId to connect to the WebSocket or to delete the stream.", "example": 173943 }, "isConnected": { "type": "boolean", "description": "Whether a client is currently connected to the stream.", "example": true }, "lastActive": { "type": "string", "description": "Timestamp of the last activity on the stream, or null if it has never been connected.", "format": "date-time", "nullable": true, "example": "2026-07-15T10:16:35Z" }, "streamId": { "type": "string", "description": "Identifier for the stream. Pass it as the stream_id query parameter on wss://api.arkm.com/ws/v2/transfers to connect, and as the path parameter on DELETE /ws/v2/streams/{id} to delete.", "example": "e561dd5b-a24d-4669-bbba-9e5cf37d5125" }, "transfersUsed": { "type": "integer", "description": "Number of transfers delivered on this stream so far.", "example": 1 } }, "example": { "createdAt": "2026-07-14T09:12:43Z", "id": 173943, "isConnected": true, "lastActive": "2026-07-15T10:16:35Z", "streamId": "e561dd5b-a24d-4669-bbba-9e5cf37d5125", "transfersUsed": 1 } }, "SubaccountBalances": { "required": [ "address", "ownerAddress", "name", "symbol", "id", "balance", "usd", "price" ], "type": "object", "properties": { "address": { "type": "string", "example": "BCjNfgiZYpfZG2aTDDFw5dL4zu7cwBRdv2v8FsnjK6Dy" }, "balance": { "type": "number", "example": 508628.141646117 }, "balanceExact": { "type": "string", "nullable": true, "example": "508628141646117" }, "id": { "type": "string", "example": "jito-staked-sol" }, "name": { "type": "string", "example": "Jito Staked SOL" }, "ownerAddress": { "type": "string", "example": "GxDDTT1zqgH2aNgdoyDvEgvHdsLq91JAExCTao7c5GT4" }, "price": { "type": "number", "example": 87.73 }, "symbol": { "type": "string", "example": "JitoSOL" }, "usd": { "type": "number", "example": 44621946.86661385 } }, "example": { "address": "BCjNfgiZYpfZG2aTDDFw5dL4zu7cwBRdv2v8FsnjK6Dy", "balance": 508628.141646117, "balanceExact": "508628141646117", "id": "jito-staked-sol", "name": "Jito Staked SOL", "ownerAddress": "GxDDTT1zqgH2aNgdoyDvEgvHdsLq91JAExCTao7c5GT4", "price": 87.73, "symbol": "JitoSOL", "usd": 44621946.86661385 } }, "TagSummary": { "required": [ "tagId", "numAddresses", "numEntities", "numUniqueTagParams" ], "type": "object", "properties": { "numAddresses": { "type": "integer", "description": "Total number of addresses carrying this tag.", "example": 1436136 }, "numEntities": { "type": "integer", "description": "Total number of entities carrying this tag.", "example": 41 }, "numUniqueTagParams": { "type": "integer", "description": "Number of unique tag parameter combinations for this tag.", "example": 38 }, "tagId": { "type": "string", "description": "The tag identifier these statistics describe.", "example": "proof-of-reserves" } }, "example": { "numAddresses": 1436136, "numEntities": 41, "numUniqueTagParams": 38, "tagId": "proof-of-reserves" } }, "TagUpdate": { "required": [ "id", "tag_name", "rank", "category", "address_count", "entity_count", "status", "diff_ts", "diff_seq" ], "type": "object", "properties": { "address_count": { "type": "integer", "description": "Number of addresses with this tag.", "example": 6110547 }, "category": { "type": "string", "description": "Tag category.", "nullable": true, "example": "Other" }, "description": { "type": "string", "description": "Human-readable description of the tag.", "nullable": true, "example": "Addresses that have deployed smart contracts" }, "diff_seq": { "type": "integer", "description": "Sequence number for ordering changes within the same timestamp.", "example": 1 }, "diff_ts": { "type": "string", "description": "Timestamp when this change was detected.", "format": "date-time", "example": "2025-02-09T02:59:00Z" }, "entity_count": { "type": "integer", "description": "Number of entities associated with this tag.", "example": 0 }, "id": { "type": "string", "description": "Unique tag identifier.", "example": "contract-deployer" }, "rank": { "type": "integer", "description": "Tag priority rank (lower is higher priority).", "nullable": true, "example": 180 }, "status": { "type": "string", "description": "Change type: 'new', 'updated', or 'deleted'.", "example": "new" }, "tag_name": { "type": "string", "description": "Display name of the tag.", "nullable": true, "example": "Contract Deployer" }, "template": { "type": "string", "description": "Tag template string.", "nullable": true, "example": "Contract Deployer" } }, "example": { "address_count": 6110547, "category": "Other", "description": "Addresses that have deployed smart contracts", "diff_seq": 1, "diff_ts": "2025-02-09T02:59:00Z", "entity_count": 0, "id": "contract-deployer", "rank": 180, "status": "new", "tag_name": "Contract Deployer", "template": "Contract Deployer" } }, "Token": { "type": "object", "properties": { "deployments": { "type": "array", "items": { "$ref": "#/components/schemas/TokenDeployment" }, "example": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ] }, "identifier": { "$ref": "#/components/schemas/Identifier" }, "name": { "type": "string", "nullable": true, "example": "USDC" }, "price": { "type": "number", "nullable": true, "example": 0.9998 }, "price24hAgo": { "type": "number", "nullable": true, "example": 0.9997 }, "symbol": { "type": "string", "nullable": true, "example": "usdc" }, "tvTicker": { "type": "string", "nullable": true, "example": "USDC" } }, "example": { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" } }, "TokenBalance": { "required": [ "pricingID", "name", "symbol", "balance", "price", "usd" ], "type": "object", "properties": { "balance": { "type": "number", "description": "Token balance in whole units.", "example": 2128574.671908 }, "name": { "type": "string", "nullable": true, "example": "USD Coin" }, "price": { "type": "number", "description": "Price in USD per token.", "example": 0.99985 }, "pricingID": { "type": "string", "nullable": true, "example": "usd-coin" }, "symbol": { "type": "string", "nullable": true, "example": "USDC" }, "usd": { "type": "number", "description": "USD value of the balance.", "example": 2128254.36 } }, "example": { "balance": 2128574.671908, "name": "USD Coin", "price": 0.99985, "pricingID": "usd-coin", "symbol": "USDC", "usd": 2128254.36 } }, "TokenDeployment": { "required": [ "chain", "address" ], "type": "object", "properties": { "address": { "type": "string", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "chain": { "$ref": "#/components/schemas/Chain" }, "decimals": { "type": "integer", "nullable": true, "example": 6 } }, "example": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } }, "TokenHistogramSnapshot": { "required": [ "inUSD", "outUSD", "inValue", "outValue", "time" ], "type": "object", "properties": { "inUSD": { "type": "number", "example": 1.23 }, "inValue": { "type": "number", "example": 1.23 }, "outUSD": { "type": "number", "example": 1.23 }, "outValue": { "type": "number", "example": 1.23 }, "time": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "example": { "inUSD": 1.23, "inValue": 1.23, "outUSD": 1.23, "outValue": 1.23, "time": "2024-01-01T00:00:00Z" } }, "TokenHistoricalQuote": { "required": [ "time", "usd", "volume24h", "marketCap" ], "type": "object", "properties": { "marketCap": { "type": "number", "description": "Market capitalization in USD.", "example": 75000000.5 }, "time": { "type": "string", "description": "Snapshot timestamp.", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "usd": { "type": "number", "description": "Price in USD.", "example": 1.05 }, "volume24h": { "type": "number", "description": "24-hour trading volume in USD.", "example": 1250000.5 } }, "example": { "marketCap": 75000000.5, "time": "2024-01-01T00:00:00Z", "usd": 1.05, "volume24h": 1250000.5 } }, "TokenMarketData": { "required": [ "price", "totalVolume", "price24hAgo", "maxPrice24h", "minPrice24h", "circulatingSupply", "totalSupply", "price7dAgo", "price30dAgo", "price180dAgo", "allTimeHigh", "allTimeLow", "marketCap", "fullyDilutedValue" ], "type": "object", "properties": { "allTimeHigh": { "type": "number", "example": 1.23 }, "allTimeLow": { "type": "number", "example": 1.23 }, "circulatingSupply": { "type": "number", "nullable": true, "example": 1.23 }, "fullyDilutedValue": { "type": "number", "nullable": true, "example": 1.23 }, "marketCap": { "type": "number", "nullable": true, "example": 1.23 }, "maxPrice24h": { "type": "number", "example": 1.23 }, "minPrice24h": { "type": "number", "example": 1.23 }, "price": { "type": "number", "example": 1.23 }, "price180dAgo": { "type": "number", "example": 1.23 }, "price24hAgo": { "type": "number", "example": 1.23 }, "price30dAgo": { "type": "number", "example": 1.23 }, "price7dAgo": { "type": "number", "example": 1.23 }, "totalSupply": { "type": "number", "nullable": true, "example": 1.23 }, "totalVolume": { "type": "number", "example": 1.23 } }, "example": { "allTimeHigh": 1.23, "allTimeLow": 1.23, "circulatingSupply": 1.23, "fullyDilutedValue": 1.23, "marketCap": 1.23, "maxPrice24h": 1.23, "minPrice24h": 1.23, "price": 1.23, "price180dAgo": 1.23, "price24hAgo": 1.23, "price30dAgo": 1.23, "price7dAgo": 1.23, "totalSupply": 1.23, "totalVolume": 1.23 } }, "TokenPriceChange": { "required": [ "pricingID", "currentPrice", "historicalPrice" ], "type": "object", "properties": { "currentPrice": { "type": "number", "description": "Current price in USD.", "example": 0.999831 }, "historicalPrice": { "type": "number", "description": "Price in USD at the requested past timestamp.", "example": 0.999357 }, "pricingID": { "type": "string", "description": "The CoinGecko pricing ID of the token.", "example": "usd-coin" } }, "example": { "currentPrice": 0.999831, "historicalPrice": 0.999357, "pricingID": "usd-coin" } }, "TopFlow": { "required": [ "address", "inUSD", "outUSD", "inValue", "outValue" ], "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "inUSD": { "type": "number", "example": 1.23 }, "inValue": { "type": "number", "example": 1.23 }, "outUSD": { "type": "number", "example": 1.23 }, "outValue": { "type": "number", "example": 1.23 } }, "example": { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "inUSD": 1.23, "inValue": 1.23, "outUSD": 1.23, "outValue": 1.23 } }, "TopHolderResponse": { "required": [ "token", "totalSupply", "addressTopHolders", "entityTopHolders" ], "type": "object", "properties": { "addressTopHolders": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AddressTopHolder" }, "example": [ { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "balance": 1500000000.5, "pctOfCap": 0.025, "unrealizedPnlUsd": 12345.67, "usd": 1500000000.5 } ] }, "nullable": true, "example": { "abc123": [ { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "balance": 1500000000.5, "pctOfCap": 0.025, "unrealizedPnlUsd": 12345.67, "usd": 1500000000.5 } ] } }, "entityTopHolders": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTopHolder" }, "example": [ { "balance": 1500000000.5, "entity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "pctOfCap": 0.025, "usd": 1500000000.5 } ] }, "nullable": true, "example": { "abc123": [ { "balance": 1500000000.5, "entity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "pctOfCap": 0.025, "usd": 1500000000.5 } ] } }, "token": { "$ref": "#/components/schemas/Token" }, "totalSupply": { "type": "object", "additionalProperties": { "type": "number", "example": 1.23 }, "nullable": true, "example": { "abc123": 1.23 } } }, "example": { "addressTopHolders": { "abc123": [ { "address": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "balance": 1500000000.5, "pctOfCap": 0.025, "unrealizedPnlUsd": 12345.67, "usd": 1500000000.5 } ] }, "entityTopHolders": { "abc123": [ { "balance": 1500000000.5, "entity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "pctOfCap": 0.025, "usd": 1500000000.5 } ] }, "token": { "deployments": [ { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "decimals": 6 } ], "identifier": { "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "chain": "ethereum", "pricingID": "usd-coin" }, "name": "USDC", "price": 0.9998, "price24hAgo": 0.9997, "symbol": "usdc", "tvTicker": "USDC" }, "totalSupply": { "abc123": 1.23 } } }, "TopToken": { "required": [ "token", "current", "previous" ], "type": "object", "properties": { "current": { "$ref": "#/components/schemas/TopTokenInterval" }, "previous": { "$ref": "#/components/schemas/TopTokenInterval" }, "token": { "required": [ "id", "symbol", "marketCap" ], "type": "object", "properties": { "id": { "type": "string", "example": "usd-coin" }, "marketCap": { "type": "number", "nullable": true, "example": 1.23 }, "symbol": { "type": "string", "example": "USDC" } }, "example": { "id": "usd-coin", "marketCap": 1.23, "symbol": "USDC" } } }, "example": { "current": { "inflowCexVolume": 1.23, "inflowDexVolume": 1.23, "outflowCexVolume": 1.23, "outflowDexVolume": 1.23, "price": 1.23 }, "previous": { "inflowCexVolume": 1.23, "inflowDexVolume": 1.23, "outflowCexVolume": 1.23, "outflowDexVolume": 1.23, "price": 1.23 }, "token": { "id": "usd-coin", "marketCap": 1.23, "symbol": "USDC" } } }, "TopTokenInterval": { "required": [ "price", "inflowDexVolume", "inflowCexVolume", "outflowDexVolume", "outflowCexVolume" ], "type": "object", "properties": { "inflowCexVolume": { "type": "number", "example": 1.23 }, "inflowDexVolume": { "type": "number", "example": 1.23 }, "outflowCexVolume": { "type": "number", "example": 1.23 }, "outflowDexVolume": { "type": "number", "example": 1.23 }, "price": { "type": "number", "example": 1.23 } }, "example": { "inflowCexVolume": 1.23, "inflowDexVolume": 1.23, "outflowCexVolume": 1.23, "outflowDexVolume": 1.23, "price": 1.23 } }, "TopTokenTimeFrame": { "enum": [ "1h", "6h", "12h", "24h", "7d" ], "type": "string", "example": "1h" }, "TopTokensOrderByAgg": { "enum": [ "volume", "inflow", "outflow", "volumeDex", "volumeCex", "inflowDex", "inflowCex", "outflowDex", "outflowCex", "netflowDex", "netflowCex", "netflow", "netflowVolumeRatio", "netflowVolumeRatioDex", "netflowVolumeRatioCex", "price" ], "type": "string", "example": "volume" }, "TransferFilter": { "type": "object", "properties": { "base": { "type": "array", "items": { "type": "string" }, "description": "Entity names or wallet addresses to monitor. Shows transfers where any of these appear as sender or receiver. Accepts the same values as the base parameter on GET /transfers — entity names, wallet addresses, or '!' prefix to exclude.", "example": [ "binance", "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" ] }, "chains": { "$ref": "#/components/schemas/Chains" }, "counterparties": { "type": "array", "items": { "type": "string" }, "description": "Strict counterparty filter — only delivers transfers between base and these counterparties (base→counterparty or counterparty→base). Requires base to be set. Accepts entity names or wallet addresses.", "example": [ "binance", "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" ] }, "flow": { "$ref": "#/components/schemas/TransferFlow" }, "from": { "type": "array", "items": { "type": "string" }, "description": "Filter by sender. Accepts wallet addresses, entity names, or special syntax: 'type:cex' for all CEX addresses, 'deposit:binance' for Binance deposit addresses. Same syntax as GET /transfers.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "type:cex", "deposit:binance" ] }, "to": { "type": "array", "items": { "type": "string" }, "description": "Filter by receiver. Accepts wallet addresses, entity names, or special syntax: 'type:cex' for all CEX addresses, 'deposit:binance' for Binance deposit addresses. Same syntax as GET /transfers.", "example": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ] }, "tokens": { "type": "array", "items": { "type": "string" }, "description": "Filter by token. Accepts token symbols or contract addresses.", "example": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ] }, "usdGte": { "type": "string", "description": "Minimum USD value of the transfer. Can be used alone as a filter requirement if \u003e= 250,000.", "example": "250000" }, "usdLte": { "type": "string", "description": "Maximum USD value of the transfer.", "example": "1000000" }, "valueGte": { "type": "string", "description": "Minimum raw token amount (not USD). For example, '100' means at least 100 units of the token.", "example": "100" }, "valueLte": { "type": "string", "description": "Maximum raw token amount (not USD).", "example": "10000" } }, "example": { "base": [ "binance", "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" ], "chains": [ "ethereum", "bsc", "polygon" ], "counterparties": [ "binance", "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" ], "flow": "in", "from": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "type:cex", "deposit:binance" ], "to": [ "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "deposit:binance" ], "tokens": [ "ethereum", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" ], "usdGte": "250000", "usdLte": "1000000", "valueGte": "100", "valueLte": "10000" } }, "TransferFlow": { "enum": [ "in", "out", "self", "all" ], "type": "string", "example": "in" }, "TransferSortKey": { "enum": [ "time", "value", "usd" ], "type": "string", "example": "time" }, "TrendingToken": { "required": [ "pricingID", "price", "price24hAgo", "volume24h", "allTimeHigh", "allTimeLow" ], "type": "object", "properties": { "allTimeHigh": { "type": "number", "description": "All-time high price in USD.", "example": 1.043 }, "allTimeLow": { "type": "number", "description": "All-time low price in USD.", "example": 0.877647 }, "circulatingSupply": { "type": "number", "description": "Circulating supply in whole token units.", "nullable": true, "example": 73354602419.50252 }, "name": { "type": "string", "nullable": true, "example": "USD Coin" }, "price": { "type": "number", "description": "Current price in USD.", "example": 0.999831 }, "price24hAgo": { "type": "number", "description": "Price in USD 24 hours ago.", "example": 0.999825 }, "pricingID": { "type": "string", "example": "usd-coin" }, "symbol": { "type": "string", "nullable": true, "example": "USDC" }, "totalSupply": { "type": "number", "description": "Total supply in whole token units.", "nullable": true, "example": 73355068862.08713 }, "volume24h": { "type": "number", "description": "24-hour trading volume in USD.", "example": 7539296441 } }, "example": { "allTimeHigh": 1.043, "allTimeLow": 0.877647, "circulatingSupply": 73354602419.50252, "name": "USD Coin", "price": 0.999831, "price24hAgo": 0.999825, "pricingID": "usd-coin", "symbol": "USDC", "totalSupply": 73355068862.08713, "volume24h": 7539296441 } }, "TronEnrichedAnyTransfer": { "required": [ "id", "transactionHash", "fromAddress", "fromIsContract", "toAddress", "toIsContract", "tokenAddress", "blockTimestamp", "blockNumber", "blockID", "tokenName", "tokenSymbol", "tokenDecimals", "unitValue", "tokenId", "historicalUSD", "assetId", "chain" ], "type": "object", "properties": { "assetId": { "type": "string", "nullable": true, "example": "usd-coin" }, "blockID": { "type": "string", "example": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060" }, "blockNumber": { "minimum": 0, "type": "integer", "example": 1 }, "blockTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "chain": { "$ref": "#/components/schemas/Chain" }, "fromAddress": { "$ref": "#/components/schemas/Address" }, "fromIsContract": { "type": "boolean", "example": true }, "historicalUSD": { "type": "number", "example": 1.23 }, "id": { "type": "string", "example": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060" }, "toAddress": { "$ref": "#/components/schemas/Address" }, "toIsContract": { "type": "boolean", "example": true }, "tokenAddress": { "type": "string", "nullable": true, "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }, "tokenDecimals": { "minimum": 0, "type": "integer", "nullable": true, "example": 1 }, "tokenId": { "type": "string", "nullable": true, "example": "usd-coin" }, "tokenName": { "type": "string", "nullable": true, "example": "USD Coin" }, "tokenSymbol": { "type": "string", "nullable": true, "example": "USDC" }, "transactionHash": { "type": "string", "example": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060" }, "unitValue": { "type": "number", "example": 1.23 } }, "example": { "assetId": "usd-coin", "blockID": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "blockNumber": 1, "blockTimestamp": "2024-01-01T00:00:00Z", "chain": "ethereum", "fromAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "fromIsContract": true, "historicalUSD": 1.23, "id": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "toAddress": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "arkhamEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "arkhamLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" }, "chain": "ethereum", "contract": false, "depositServiceID": "binance", "isShielded": true, "isUserAddress": false, "ownerAddress": {}, "predictedEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "program": true, "service": true, "userEntity": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" }, "userLabel": { "address": "0x28C6c06298d514Db089934071355E5743bf21d60", "chainType": "evm", "name": "Cold Wallet", "note": "" } }, "toIsContract": true, "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "tokenDecimals": 1, "tokenId": "usd-coin", "tokenName": "USD Coin", "tokenSymbol": "USDC", "transactionHash": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", "unitValue": 1.23 } }, "TxInfo": {}, "UpdateAlertRequest": { "required": [ "name", "enabled", "base", "alertMethodId" ], "type": "object", "properties": { "alertMethodId": { "type": "integer", "example": 1 }, "base": { "type": "array", "items": { "type": "string", "example": "abc123" }, "nullable": true, "example": [ "abc123" ] }, "chains": { "type": "array", "items": { "$ref": "#/components/schemas/Chain" }, "nullable": true, "example": [ "ethereum" ] }, "description": { "type": "string", "nullable": true, "example": "abc123" }, "enabled": { "type": "boolean", "example": true }, "from": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "name": { "type": "string", "example": "abc123" }, "to": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "tokens": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "usdGte": { "type": "number", "nullable": true, "example": 1.23 }, "usdLte": { "type": "number", "nullable": true, "example": 1.23 }, "valueGte": { "type": "number", "nullable": true, "example": 1.23 }, "valueLte": { "type": "number", "nullable": true, "example": 1.23 } }, "example": { "alertMethodId": 1, "base": [ "abc123" ], "chains": [ "ethereum" ], "description": "abc123", "enabled": true, "from": [ "abc123" ], "name": "abc123", "to": [ "abc123" ], "tokens": [ "abc123" ], "usdGte": 1.23, "usdLte": 1.23, "valueGte": 1.23, "valueLte": 1.23 } }, "UpdateStatus": { "enum": [ "new", "updated", "deleted", "all" ], "type": "string", "example": "new" }, "UpdateUserEntityRequest": { "required": [ "name", "note", "id", "type", "service" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "example": { "abc123": [ "abc123" ] } }, "crunchbase": { "type": "string", "nullable": true, "example": "https://www.crunchbase.com/organization/binance" }, "customImageSlug": { "type": "string", "nullable": true, "example": "binance" }, "customized": { "type": "boolean", "nullable": true, "example": true }, "id": { "type": "string", "example": "binance" }, "instagram": { "type": "string", "nullable": true, "example": "https://www.instagram.com/binance" }, "linkShareable": { "type": "boolean", "nullable": true, "example": true }, "linkedin": { "type": "string", "nullable": true, "example": "https://www.linkedin.com/company/binance" }, "name": { "type": "string", "example": "Binance" }, "note": { "type": "string", "example": "" }, "ownerUID": { "type": "string", "example": "a1b2c3d4-5678-90ab-cdef-1234567890ab" }, "populatedTags": { "type": "array", "items": { "$ref": "#/components/schemas/PopulatedTag" }, "example": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] }, "service": { "type": "boolean", "nullable": true, "example": true }, "twitter": { "type": "string", "nullable": true, "example": "https://twitter.com/binance" }, "type": { "type": "string", "nullable": true, "example": "cex" }, "website": { "type": "string", "nullable": true, "example": "https://binance.com" } }, "example": { "addresses": { "abc123": [ "abc123" ] }, "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "website": "https://binance.com" } }, "UserEntity": { "required": [ "name", "note", "id", "type", "service", "createdAt", "updatedAt" ], "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "example": "abc123" }, "example": [ "abc123" ] }, "example": { "abc123": [ "abc123" ] } }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "crunchbase": { "type": "string", "nullable": true, "example": "https://www.crunchbase.com/organization/binance" }, "customImageSlug": { "type": "string", "nullable": true, "example": "binance" }, "customized": { "type": "boolean", "nullable": true, "example": true }, "id": { "type": "string", "example": "binance" }, "instagram": { "type": "string", "nullable": true, "example": "https://www.instagram.com/binance" }, "linkShareable": { "type": "boolean", "nullable": true, "example": true }, "linkedin": { "type": "string", "nullable": true, "example": "https://www.linkedin.com/company/binance" }, "name": { "type": "string", "example": "Binance" }, "note": { "type": "string", "example": "" }, "ownerUID": { "type": "string", "example": "a1b2c3d4-5678-90ab-cdef-1234567890ab" }, "populatedTags": { "type": "array", "items": { "$ref": "#/components/schemas/PopulatedTag" }, "example": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ] }, "service": { "type": "boolean", "nullable": true, "example": true }, "twitter": { "type": "string", "nullable": true, "example": "https://twitter.com/binance" }, "type": { "type": "string", "nullable": true, "example": "cex" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "website": { "type": "string", "nullable": true, "example": "https://binance.com" } }, "example": { "addresses": { "abc123": [ "abc123" ] }, "createdAt": "2024-01-01T00:00:00Z", "crunchbase": "https://www.crunchbase.com/organization/binance", "customImageSlug": "binance", "customized": true, "id": "binance", "instagram": "https://www.instagram.com/binance", "linkShareable": true, "linkedin": "https://www.linkedin.com/company/binance", "name": "Binance", "note": "", "ownerUID": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "populatedTags": [ { "chain": "ethereum", "disablePage": false, "excludeEntities": false, "id": "proof-of-reserves", "label": "Binance Proof of Reserves", "rank": 20, "tagParams": "Binance" } ], "service": true, "twitter": "https://twitter.com/binance", "type": "cex", "updatedAt": "2024-01-01T00:00:00Z", "website": "https://binance.com" } }, "Volume": { "required": [ "exchangeID", "exchangeName", "withdrawnUSD", "depositedUSD" ], "type": "object", "properties": { "depositedUSD": { "type": "number", "example": 1.23 }, "exchangeID": { "type": "string", "example": "binance" }, "exchangeName": { "type": "string", "example": "binance" }, "withdrawnUSD": { "type": "number", "example": 1.23 } }, "example": { "depositedUSD": 1.23, "exchangeID": "binance", "exchangeName": "binance", "withdrawnUSD": 1.23 } }, "VolumeSnapshot": { "required": [ "time", "volumes" ], "type": "object", "properties": { "time": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/Volume" }, "nullable": true, "example": [ { "depositedUSD": 1.23, "exchangeID": "binance", "exchangeName": "binance", "withdrawnUSD": 1.23 } ] } }, "example": { "time": "2024-01-01T00:00:00Z", "volumes": [ { "depositedUSD": 1.23, "exchangeID": "binance", "exchangeName": "binance", "withdrawnUSD": 1.23 } ] } }, "WebSocketSessionInfoResponse": { "required": [ "creditPerTransfer", "creditPerSession" ], "type": "object", "properties": { "creditPerSession": { "type": "integer", "description": "API credits consumed when creating a session", "example": 500 }, "creditPerTransfer": { "type": "integer", "description": "API credits consumed per transfer received", "example": 2 }, "nextRenewalDate": { "type": "string", "description": "Next monthly session renewal charge date", "format": "date-time", "nullable": true, "example": "2026-08-14T00:00:00Z" } }, "example": { "creditPerSession": 500, "creditPerTransfer": 2, "nextRenewalDate": "2026-08-14T00:00:00Z" } }, "WebSocketSessionResponse": { "required": [ "sessionId", "transfersUsed", "createdAt", "isActive", "isConnected" ], "type": "object", "properties": { "createdAt": { "type": "string", "description": "When the session was created", "format": "date-time", "example": "2026-07-14T09:12:43Z" }, "isActive": { "type": "boolean", "description": "Whether the session is active", "example": true }, "isConnected": { "type": "boolean", "description": "Whether a WebSocket client is currently connected to this session", "example": true }, "sessionId": { "type": "string", "description": "Unique session identifier", "example": "ws_Ab3xK9pQ_1782149114960780310" }, "transfersUsed": { "type": "integer", "description": "Number of transfers received in this session", "example": 1 } }, "example": { "createdAt": "2026-07-14T09:12:43Z", "isActive": true, "isConnected": true, "sessionId": "ws_Ab3xK9pQ_1782149114960780310", "transfersUsed": 1 } } } } }