Arkham Cluster API

openapi: 3.2.0
info:
  title: Arkham Cluster API
  x-refined-note:
  - x-guidance differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Cluster across 2 of this provider''s published API definitions: arkham-openapi-original.json, arkham-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.arkm.com/x402
tags:
- name: Cluster
paths:
  /cluster/{id}/summary:
    get:
      summary: Get cluster summary statistics
      description: 'Returns summary statistics for the specified cluster, including:

        - Total number of unique addresses in the cluster

        - Total balance in USD

        - Total transaction volume in USD

        - First and last transaction timestamps


        Clusters are groups of addresses that have been linked together through on-chain heuristics (e.g., Bitcoin input clustering).


        To 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
      tags:
      - Cluster
  /cluster/summary:
    post:
      operationId: cluster_summary
      summary: Get Arkham cluster summary statistics
      tags:
      - Cluster
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.20'
        protocols:
        - x402: {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  anyOf:
                  - type: string
                  - type: number
                  - type: boolean
                  - type: array
                    items:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                  description: The ID of the cluster to summarize.
              required:
              - id
              additionalProperties:
                anyOf:
                - type: string
                - type: number
                - type: boolean
                - type: array
                  items:
                    anyOf:
                    - type: string
                    - type: number
                    - type: boolean
            example:
              id: 00000002aae817c1a0d2ec3c91ede74c64c92c83658decdad52b591451948d75a9ca
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '400':
          $ref: '#/components/responses/BadRequest400'
        '402':
          $ref: '#/components/responses/PaymentRequired402'
        '404':
          $ref: '#/components/responses/NotFound404'
        '429':
          $ref: '#/components/responses/RateLimited429'
        5XX:
          $ref: '#/components/responses/UpstreamError5xx'
      security: []
      description: Get Arkham cluster summary statistics. $0.20 per call.
    servers:
    - url: https://api.arkm.com/x402
components:
  schemas:
    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
          - 'null'
          format: date-time
          example: '2018-11-12T14:22:37Z'
        lastTx:
          type:
          - string
          - 'null'
          format: date-time
          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
  responses:
    PaymentRequired402:
      description: 'Payment challenge, not an application error. Read the base64 x402 v2 challenge from PAYMENT-REQUIRED, sign it, and retry the same request with PAYMENT-SIGNATURE. If a post-payment 402 omits PAYMENT-REQUIRED, verification failed: read the new challenge, re-sign, and retry once.'
      headers:
        PAYMENT-REQUIRED:
          description: Base64-encoded x402 v2 payment requirements. Its accepts array contains the scheme, network, asset, atomic amount, and payTo address.
          schema:
            type: string
    NotFound404:
      description: The upstream Arkham resource does not exist. Fatal for the same input. Payment is not settled.
    UpstreamError5xx:
      description: Arkham failed or timed out, including 502 and 504 responses. Retry with backoff. x402 payments and MPP transaction credentials are not settled for failed requests; MPP hash credits are redeemed at admission and are not refunded automatically.
    RateLimited429:
      description: Per-wallet endpoint rate limit exceeded. Retry with at least 1 second of backoff; keep heavy endpoints at no more than 5 requests per second.
    BadRequest400:
      description: 'Fatal for the request as written: validation failed or required JSON body fields are missing. Fix the request; do not retry it unchanged. Payment is not settled.'
      content:
        application/json:
          schema:
            type: object
            required:
            - success
            - error
            properties:
              success:
                type: boolean
                enum:
                - false
              error:
                type: string
              issues:
                type: array
                description: Per-field validation issues, present when schema validation produced them.
  securitySchemes:
    siwx:
      type: apiKey
      in: header
      name: SIGN-IN-WITH-X
x-refined-from:
- arkham-openapi-original.json
- arkham-openapi.json