> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockgence.com/llms.txt
> Use this file to discover all available pages before exploring further.

# All counterparties of an address

> Returns every counterparty of an address, aggregated, labeled and paginated, ranked by USD value. Unlike
`POST /v1/trace`, which limits the branches per node, this includes the counterparties the trace left out (the
“+N” of a node).

**Request body (JSON).**
- `address` (required) and `chain` (default `ethereum`).
- `direction`: `out` (whom it sent to), `in` (who sent to it) or `both` (default).
- `since` and `until`: lower and upper time bound, in Unix seconds; 0 means no limit. `temporal` (default
 `true`) applies temporal consistency. `win_start` and `win_end`: date window.
- `include_tokens` (default `true`) and `read_more` (0 to 9): read the address the same way as its node in the
 trace. A graph node publishes these values in `reveal`.
- `min_usd`: discards counterparties worth less than that USD value (default 1.0). Relevant counterparties
 (exchange, mixer, bridge, sanctioned or scam) are kept even below that value.
- `offset` (default 0) and `limit` (1 to 100, default 20): pagination.

**Response.** `total`, `offset`, `returned`, `has_more`, `next_offset` and `counterparties` (each with
`address`, `label`, `category`, `direction`, `value`, `value_usd`, `asset`, `tx_count`, `first_ts` and
`last_ts`). To go through all of them, request `offset = next_offset` until `has_more` is `false`. `unpriced`
summarizes the token transfers discarded for having no published price; a counterparty that moved only those
tokens is not in the list.

**Limits.** Of what was read, at most the 10,000 highest-value transfers on the requested side are aggregated.

**Coverage.** If the source cannot read the address, the response is `503 source_unavailable`, with no charge:
never “0 counterparties”. What was left unread and the limits of the network are declared in
`degraded_sources`. On a network where inflows cannot be read, `direction: "in"` returns `503` with
`reason: "unsupported"`.

**Cost:** 4 credits base. Some operations charge less when they reuse a saved result; never more.



## OpenAPI

````yaml /openapi.en.json post /v1/counterparties
openapi: 3.1.0
info:
  title: blockgence API
  description: >-
    The **blockgence** API provides fund tracing, entity attribution and
    explainable risk screening across several

    networks, with the evidence behind every result.


    ### Authentication

    Every `/v1/*` route requires an **API key**, sent in the `X-API-Key: <key>`
    header or as

    `Authorization: Bearer <key>`. Your organization issues the key. The
    evidence verification routes

    (`/v1/evidence/*`) do not require a key.


    ### Credits and limits

    Each plan has a **per-minute request limit** and a **monthly credit
    allowance**. Each operation states its cost in

    credits. **Only successful responses (status below 400) are charged:** an
    error response is recorded with 0

    credits. Check your usage with `GET /v1/account`.


    ### Data that could not be read

    If the data source cannot read what you requested, the response is `503
    source_unavailable`, with no charge,

    stating the source, the network, the query, the reason and whether a retry
    is advisable. If an intermediate step

    fails, the response is 200 and declares it in `degraded_sources` and in the
    `coverage_gaps` of the node or edge:

    in those cases, missing data does not mean missing activity.


    ### Networks

    `ethereum`, `bsc`, `polygon`, `arbitrum`, `base` and `optimism`; plus `tron`
    for tracing, profile, funding, network

    probing and transactions. `GET /v1/chains` states what can be queried on
    each network, at no cost. The networks

    `monero`, `bitcoin`, `litecoin` and `solana` are recognized in `/screening`
    and `/address`, where the network is

    inferred from the address format. Any other network returns `400`: it is
    never replaced with Ethereum.
  contact:
    name: blockgence
    url: https://www.blockgence.com/
  version: 1.0.0
servers:
  - url: https://app.blockgence.com
    description: Production
security: []
tags:
  - name: Platform
    description: >-
      Available networks, what can be queried on each one, from which sources
      and under which methodology. No cost.
  - name: Tracing
    description: >-
      Fund-flow tracing and reads of an address or a transaction: a
      time-consistent graph in both directions, funding, counterparties,
      bridges, swaps, mixers, labels and on-chain data.
  - name: Screening
    description: >-
      Risk screening of an address, with a recommendation (allow, review or
      block), its reasons and its sources.
  - name: Contracts
    description: Contract inspection and simulation of a transaction before signing it.
  - name: Tokens
    description: Token profile, with its issuer, supply, holders and risk signals.
  - name: Compromise
    description: >-
      Compromise vector of a stolen wallet, that is, how control of the funds
      was lost.
  - name: Incidents
    description: >-
      Incident response for victims, hacks and scams: playbook, freeze requests
      to issuers, post-mortem and deliverables.
  - name: Copilot
    description: >-
      AI investigation copilot that answers in natural language and cites the
      evidence (SSE streaming).
  - name: Cases
    description: >-
      Investigation cases to save, share and export, with their evidence,
      activity and annotations.
  - name: Permissions
    description: >-
      Approvals, delegations and signatures that grant access to an address's
      funds (ERC-20, Permit2 and EIP-7702).
  - name: Guard
    description: Wallet and protocol monitoring, with alerts by webhook and email.
  - name: Travel Rule
    description: >-
      Travel Rule without third-party connections: ownership challenge,
      counterparty, reconciliation and validation of IVMS101 messages.
  - name: Audit
    description: >-
      Smart contract audits, with the status, findings and evidence of each
      audit.
  - name: Evidence
    description: >-
      Verification of sealed evidence, with the signing public key and
      timestamps. No API key or charge required.
  - name: Monero
    description: >-
      Public profile of a Monero transaction and verification of a payment
      proof. Monero does not publish senders or amounts, so it is not traced.
  - name: Account
    description: Usage and limits of your API key.
  - name: Icons
    description: Entity logos to render graphs in your own interface. No cost.
  - name: Service
    description: Service status.
paths:
  /v1/counterparties:
    post:
      tags:
        - Tracing
      summary: All counterparties of an address
      description: >-
        Returns every counterparty of an address, aggregated, labeled and
        paginated, ranked by USD value. Unlike

        `POST /v1/trace`, which limits the branches per node, this includes the
        counterparties the trace left out (the

        “+N” of a node).


        **Request body (JSON).**

        - `address` (required) and `chain` (default `ethereum`).

        - `direction`: `out` (whom it sent to), `in` (who sent to it) or `both`
        (default).

        - `since` and `until`: lower and upper time bound, in Unix seconds; 0
        means no limit. `temporal` (default
         `true`) applies temporal consistency. `win_start` and `win_end`: date window.
        - `include_tokens` (default `true`) and `read_more` (0 to 9): read the
        address the same way as its node in the
         trace. A graph node publishes these values in `reveal`.
        - `min_usd`: discards counterparties worth less than that USD value
        (default 1.0). Relevant counterparties
         (exchange, mixer, bridge, sanctioned or scam) are kept even below that value.
        - `offset` (default 0) and `limit` (1 to 100, default 20): pagination.


        **Response.** `total`, `offset`, `returned`, `has_more`, `next_offset`
        and `counterparties` (each with

        `address`, `label`, `category`, `direction`, `value`, `value_usd`,
        `asset`, `tx_count`, `first_ts` and

        `last_ts`). To go through all of them, request `offset = next_offset`
        until `has_more` is `false`. `unpriced`

        summarizes the token transfers discarded for having no published price;
        a counterparty that moved only those

        tokens is not in the list.


        **Limits.** Of what was read, at most the 10,000 highest-value transfers
        on the requested side are aggregated.


        **Coverage.** If the source cannot read the address, the response is
        `503 source_unavailable`, with no charge:

        never “0 counterparties”. What was left unread and the limits of the
        network are declared in

        `degraded_sources`. On a network where inflows cannot be read,
        `direction: "in"` returns `503` with

        `reason: "unsupported"`.


        **Cost:** 4 credits base. Some operations charge less when they reuse a
        saved result; never more.
      operationId: counterparties_v1_counterparties_post
      parameters:
        - name: X-Case-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Case-Id
          description: >-
            Active case, optional: the token of a case you can view. The query
            is recorded in that case and also uses its own labels. A case that
            does not exist, was deleted or is no longer shared with you returns
            `400 case_unavailable` and the query is not run, with no charge.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CounterpartiesRequest'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema: {}
        '401':
          description: The API key is missing, invalid or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: The monthly credits are exhausted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            The request does not have the expected shape; `detail` states which
            field to correct.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            The per-minute request limit was exceeded. Retry after the number of
            seconds in `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            `source_unavailable`: the data source could not read what was
            requested. No credits are charged. If an intermediate step fails,
            the response is 200 and declares it in `degraded_sources`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceUnavailable'
      security:
        - APIKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    CounterpartiesRequest:
      properties:
        address:
          type: string
          title: Address
        chain:
          type: string
          title: Chain
          default: ethereum
        direction:
          type: string
          title: Direction
          default: both
        since:
          type: integer
          title: Since
          default: 0
        temporal:
          type: boolean
          title: Temporal
          default: true
        win_start:
          type: integer
          title: Win Start
          default: 0
        win_end:
          type: integer
          title: Win End
          default: 0
        min_usd:
          type: number
          title: Min Usd
          default: 1
        offset:
          type: integer
          title: Offset
          default: 0
        limit:
          type: integer
          title: Limit
          default: 20
        include_tokens:
          type: boolean
          title: Include Tokens
          default: true
        read_more:
          type: integer
          title: Read More
          default: 0
        until:
          type: integer
          title: Until
          default: 0
      type: object
      required:
        - address
      title: CounterpartiesRequest
      description: >-
        Todas las contrapartes de UNA address, agregadas y paginadas. A
        diferencia

        del trace (capado por fan-out), acá se ve el universo completo de
        contrapartes

        (hasta lo que trae la fuente de datos), para revelar las que el rastreo
        dejó afuera.
    Error:
      type: object
      title: Error
      description: >-
        Common shape of errors: a readable `detail` and, in many cases, an
        `error` with a stable code to recognize it without parsing the text.
      properties:
        detail:
          type: string
          description: What happened, in one sentence.
        error:
          type: string
          description: Stable error code, when there is one.
      required:
        - detail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SourceUnavailable:
      type: object
      title: SourceUnavailable
      description: >-
        The data source could not read what was requested. No credits are
        charged. Missing data does not mean the address is risk-free or has no
        activity.
      properties:
        error:
          type: string
          enum:
            - source_unavailable
        detail:
          type: string
          description: What failed, where, and whether a retry is advisable.
        source:
          type: string
          description: >-
            Source that could not respond, for example `etherscan` or
            `blockscout`.
        chain:
          type: string
        primitive:
          type: string
          description: blockgence read that did not complete.
        operation:
          type: string
          description: Specific query to the source.
        target:
          type: string
          description: What was queried (address or transaction), abbreviated.
        reason:
          type: string
          description: >-
            Stable reason, for example `rate_limited`, `timeout` or
            `upstream_error`.
        retryable:
          type: boolean
        http_status:
          type:
            - integer
            - 'null'
        retry_after:
          type:
            - integer
            - 'null'
          description: >-
            Seconds to wait before retrying; also sent in the `Retry-After`
            header.
        upstream_message:
          type:
            - string
            - 'null'
        source_fault:
          type: boolean
          description: >-
            Whether the failure came from the source or from a limit of the
            query itself.
        failure_cause:
          type: string
          description: Cause of the failure, in one sentence.
      required:
        - error
        - detail
        - source
        - reason
        - retryable
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key in the `X-API-Key` header.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        The same API key as `Authorization: Bearer <key>`, as an alternative to
        `X-API-Key`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.