Skip to content
/
Get intelligence about an...

Arkham Intel API (1.0.0)

Arkham Intelligence official API documentation

The Arkham API provides direct query access to Ultra, our proprietary AI-powered algorithmic address matching engine, enabling sophisticated users to customize data flows and integrate them into their existing systems.

Through the API, users can write custom queries to access a list of Arkham labels, as well as transaction logs and historical balance data for addresses and entities.

Institutions that onboard to the Arkham Exchange automatically qualify for access to this API.

The deprecated API documentation is available here in multiple languages; however, please note that it is no longer being updated.

⚠️ IMPORTANT: API-Key

All API requests MUST include a valid API-Key header. Requests without this header will be rejected with an unauthorized response.

To authenticate with Arkham's API, simply provide a valid API-Key in the header of your request. To apply for API access to our platform, visit: https://info.arkm.com/api-platform.

Endpoints

Our root URL is https://api.arkm.com.

Rate limits

Our API uses tier-based rate limits with different limits for different endpoints:

Standard Rate Limits

For the Basic API tier, most endpoints allow up to 20 requests per second with a small additional burst allowance for occasional spikes beyond that threshold.

Heavy Endpoints Rate Limits

Some resource-intensive endpoints have lower rate limits of 1 request per second:

  • /transfers
  • /swaps
  • /counterparties/address/{address}
  • /counterparties/entity/{entity}
  • /token/top_flow/{id}
  • /token/top_flow/{chain}/{address}
  • /token/volume/{id}
  • /token/volume/{chain}/{address}
  • /transfers/histogram

Note: These heavy endpoints are computationally intensive and query large amounts of data, hence the stricter rate limits to ensure platform stability.

If you are consistently hitting the default rate limit we have set for our API you can apply for a rate limit increase here.

Security and Privacy

All data on our platform—including your private labels—is stored securely, using state-of-the-art encryption both at rest and in transit, along with strict access controls to ensure your information remains confidential. For further details on our security and privacy measures, please refer to our Privacy Policy.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Prop
Languages
Servers
Mock server
https://docs.intel.arkm.com/_mock/openapi/
Production server
https://api.arkm.com/

Health

API Health check

Operations

Chains

View full list of supported blockchains.

Operations

Transfers

Provides endpoints for retrieving blockchain transfer and swap activity. These include detailed transfer lists, aggregated histograms for analyzing transfer trends over time, and DEX swap data, all filterable by various query parameters.

Operations

Transaction

Provides an endpoint for retrieving detailed information about a specific blockchain transaction using its hash. The response includes metadata such as block number, timestamp, sender and recipient addresses, gas usage, fees, value in native units and USD, and token details.

Operations

Token exchange movements

Provides an endpoint for analyzing token activity across centralized and decentralized exchanges. This includes ranking tokens by volume, inflows, outflows, netflows, and other metrics over customizable time intervals, with support for filtering by chain, market cap, and specific tokens.

Operations

User entities

Provides endpoints for managing custom entities created by an authenticated user. Entities can be retrieved in bulk or individually, with support for including associated blockchain addresses.

Operations

Entity bulk update

Provides endpoints for updating custom entities in bulk. Entities can be fully overwritten (replacing details and address sets) or incrementally updated by adding new addresses without removing existing ones.

Operations

Intelligence

Provides AI-powered intelligence endpoints for analyzing blockchain addresses, entities, contracts, and tokens. These endpoints return enriched insights such as tagging data, entity associations, predicted addresses, contract metadata, and token information across multiple chains.

Operations

Get intelligence about an address with additional address information

Request

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.

Security
ApiKeyAuth
Path
addressstringrequired
Query
chainstring
includeTagsboolean

Include populated tag details (default: true). Set to 'false' to exclude.

Default true
includeEntityPredictionsboolean

Include predicted entity information (default: true). Set to 'false' to exclude.

Default true
includeClustersboolean

Include cluster IDs (default: true). Set to 'false' to exclude.

Default true
curl -i -X GET \
  'https://docs.intel.arkm.com/_mock/openapi/intelligence/address_enriched/{address}?chain=string&includeTags=true&includeEntityPredictions=true&includeClusters=true' \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

Address intelligence with extra enrichment

Bodyapplication/json
addressstring

The raw address (hex for EVM chains, base58 for Bitcoin, etc.)

Example: "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
chainstring(Chain)
Enum"ethereum""polygon""bsc""optimism""avalanche""arbitrum_one""bitcoin""tron""base""flare"
Example: "bitcoin"
depositServiceIDstring or null
Example: null
arkhamEntityobject or null
arkhamLabelobject or null
isUserAddressboolean or null
Example: false
contractboolean or null
Example: false
clusterIdsArray of strings or null

Array of cluster IDs associated with this address (when includeClusters=true)

populatedTagsArray of objects or null(PopulatedTag)

Populated tags associated with this address (when includeTags=true)

predictedEntityobject(Entity)
Response
application/json
{
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "chain": "bitcoin",
  "depositServiceID": null,
  "arkhamEntity": {
    "name": "Vitalik Buterin",
    "note": "",
    "id": "vitalik-buterin",
    "type": "individual",
    "service": null,
    "addresses": null,
    "website": null,
    "twitter": "https://twitter.com/VitalikButerin",
    "crunchbase": "https://www.crunchbase.com/person/vitalik-buterin",
    "linkedin": "https://www.linkedin.com/in/vitalik-buterin-267a7450"
  },
  "arkhamLabel": {
    "name": "vitalik.eth",
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "chainType": "evm"
  },
  "isUserAddress": false,
  "contract": false,
  "clusterIds": [
    "string"
  ],
  "populatedTags": [
    { … }
  ],
  "predictedEntity": {
    "id": "vitalik-buterin",
    "name": "Vitalik Buterin",
    "note": "",
    "addresses": null,
    "customized": false,
    "type": "individual",
    "service": null,
    "ownerUID": "if0jX2ggQzRlZnKYieI6uhLb07W1",
    "website": "https://vitalik.eth.limo/",
    "twitter": "https://x.com/vitalikbuterin",
    "crunchbase": "https://www.crunchbase.com/person/vitalik-buterin",
    "linkedin": "https://ca.linkedin.com/in/vitalik-buterin-267a7450",
    "instagram": "https://www.instagram.com/vitalik.eth.official",
    "customImageSlug": "https://static.arkhamintelligence.com/entities/vitalik-buterin.png",
    "populatedTags": [ … ],
    "linkShareable": true
  }
}

Get intelligence about an entity

Request

Returns top-level entity information, including associated tags.

Security
ApiKeyAuth
Path
entitystringrequired
curl -i -X GET \
  'https://docs.intel.arkm.com/_mock/openapi/intelligence/entity/{entity}' \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

Entity intelligence

Bodyapplication/json
idstring
Example: "vitalik-buterin"
namestring
Example: "Vitalik Buterin"
notestring
Example: ""
addressesobject or null
Example: null
customizedboolean
Example: false
typestring or null
Example: "individual"
serviceboolean or null
Example: null
ownerUIDstring or null
Example: "if0jX2ggQzRlZnKYieI6uhLb07W1"
websitestring
Example: "https://vitalik.eth.limo/"
twitterstring
Example: "https://x.com/vitalikbuterin"
crunchbasestring
Example: "https://www.crunchbase.com/person/vitalik-buterin"
linkedinstring
Example: "https://ca.linkedin.com/in/vitalik-buterin-267a7450"
instagramstring
Example: "https://www.instagram.com/vitalik.eth.official"
customImageSlugstring
Example: "https://static.arkhamintelligence.com/entities/vitalik-buterin.png"
populatedTagsArray of objects(PopulatedTag)
linkShareableboolean
Example: true
Response
application/json
{
  "id": "vitalik-buterin",
  "name": "Vitalik Buterin",
  "note": "",
  "addresses": null,
  "customized": false,
  "type": "individual",
  "service": null,
  "ownerUID": "if0jX2ggQzRlZnKYieI6uhLb07W1",
  "website": "https://vitalik.eth.limo/",
  "twitter": "https://x.com/vitalikbuterin",
  "crunchbase": "https://www.crunchbase.com/person/vitalik-buterin",
  "linkedin": "https://ca.linkedin.com/in/vitalik-buterin-267a7450",
  "instagram": "https://www.instagram.com/vitalik.eth.official",
  "customImageSlug": "https://static.arkhamintelligence.com/entities/vitalik-buterin.png",
  "populatedTags": [
    { … }
  ],
  "linkShareable": true
}

Get entity summary statistics

Request

Returns precomputed or calculated summary statistics for the specified entity, including:

  • Total number of unique addresses (deduplicated across chains)
  • Total balance in USD across all chains
  • Total transfer volume in USD
  • First and last transfer timestamps

Supports both Arkham entities and user entities:

  • For Arkham entities (e.g., "binance"): Returns precomputed data when available, falls back to calculation
  • For user entities: Always calculates on the fly
  • Includes user-added addresses for Arkham entities when authenticated

Shareable user entities: If a user entity is marked as shareable, any authenticated or unauthenticated user can access the summary.

Security
ApiKeyAuth
Path
entitystringrequired

The entity ID (Arkham entity like "binance" or user entity)

curl -i -X GET \
  'https://docs.intel.arkm.com/_mock/openapi/intelligence/entity/{entity}/summary' \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

Entity summary statistics

Bodyapplication/json
entityIdstring

The entity identifier

Example: "xyz-exchange"
numAddressesinteger(int64)

Total number of unique addresses for this entity (deduplicated across chains)

Example: 1523
volumeUsdnumber(double)

Total transaction volume in USD across all chains

Example: 125000000.5
balanceUsdnumber(double)

Current balance in USD across all chains

Example: 85000000.25
firstTxstring or null(date-time)

Timestamp of first transaction across all chains (null if no transactions)

Example: "2017-07-14T10:02:13Z"
lastTxstring or null(date-time)

Timestamp of last transaction across all chains (null if no transactions)

Example: "2025-10-29T14:23:45Z"
Response
application/json
{
  "entityId": "xyz-exchange",
  "numAddresses": 1523,
  "volumeUsd": 125000000.5,
  "balanceUsd": 85000000.25,
  "firstTx": "2017-07-14T10:02:13Z",
  "lastTx": "2025-10-29T14:23:45Z"
}

History

Provides endpoints for retrieving historical analytics on blockchain entities and addresses. Returns time-series USD value snapshots to help analyze changes over time.

Operations

Portfolio

Provides endpoints for managing and tracking entity and address portfolios. Includes historical snapshots, daily time-series data, and cross-chain portfolio analytics.

Operations

Token

Provides endpoints for retrieving token-related information, including holders, flows, volumes, trending tokens, and balances across chains. These endpoints allow analysis of token distribution, trading activity, and ownership at both entity and address levels.

Operations

Market Data

Provides an endpoint for accessing market data and analytics, including indices and metrics that track token and altcoin performance relative to the broader market.

Operations

ARKM

Provides endpoints related to the ARKM token and Arkham Exchange tokens, including supply information and token listings.

Operations

Networks

Provides endpoints for monitoring blockchain networks and retrieving chain-specific historical data, including current status and historical quotes.

Operations

Balances

Provides endpoints for tracking and retrieving token balances for blockchain addresses and entities, with optional filtering by chain.

Operations

Loans

Provides endpoints for tracking loan and borrow positions on-chain, including supplied, borrowed, and outstanding assets for addresses and entities.

Operations

Counterparties

Provides endpoints for analyzing counterparty activity, aggregating top counterparties by volume for addresses and entities. Supports filtering by transfer direction, chain, token, time range, and transaction value.

Operations

Labels

Provides endpoints for managing user-defined labels, including creating, retrieving, updating, and deleting labels associated with blockchain addresses.

Operations

Flow

Provides endpoints for analyzing historical USD flows for addresses and entities across supported chains, including inflows, outflows, and running totals over time.

Operations