Arkham Tag API

openapi: 3.2.0
info:
  title: Arkham Tag API
  x-refined-note:
  - x-guidance differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Tag 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: Tag
paths:
  /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 >= 0, default 0).
        schema:
          type: string
          description: Number of items to skip from the beginning (must be >= 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
      tags:
      - Tag
  /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
      tags:
      - Tag
  /tag/params:
    post:
      operationId: tag_params
      summary: Get Arkham tag parameters
      tags:
      - Tag
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '1.00'
        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 tag identifier to retrieve parameters for.
                limit:
                  description: Number of items to return per page (1-1000, default 100).
                  anyOf:
                  - type: string
                  - type: number
                  - type: boolean
                  - type: array
                    items:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                offset:
                  description: Number of items to skip from the beginning (must be >= 0, default 0).
                  anyOf:
                  - type: string
                  - type: number
                  - type: boolean
                  - type: array
                    items:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
              required:
              - id
              additionalProperties:
                anyOf:
                - type: string
                - type: number
                - type: boolean
                - type: array
                  items:
                    anyOf:
                    - type: string
                    - type: number
                    - type: boolean
            example:
              id: proof-of-reserves
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items: {}
        '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 tag parameters. $1.00 per call.
    servers:
    - url: https://api.arkm.com/x402
  /tag/summary:
    post:
      operationId: tag_summary
      summary: Get Arkham tag summary statistics
      tags:
      - Tag
      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 tag identifier to retrieve summary statistics for.
              required:
              - id
              additionalProperties:
                anyOf:
                - type: string
                - type: number
                - type: boolean
                - type: array
                  items:
                    anyOf:
                    - type: string
                    - type: number
                    - type: boolean
            example:
              id: proof-of-reserves
      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 tag summary statistics. $0.20 per call.
    servers:
    - url: https://api.arkm.com/x402
components:
  schemas:
    Chain:
      enum:
      - ethereum
      - polygon
      - bsc
      - optimism
      - avalanche
      - arbitrum_one
      - base
      - bitcoin
      - tron
      - flare
      - solana
      - dogecoin
      - zcash
      - hyperevm
      - hypercore
      type: string
      example: ethereum
    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
          - 'null'
          description: The specific parameter value for this tag instance.
          example: Binance
      example:
        chain: ethereum
        disablePage: false
        excludeEntities: false
        id: proof-of-reserves
        label: Binance Proof of Reserves
        rank: 20
        tagParams: Binance
    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
  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