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

# Get address records

> Return address records with network, status, label, and pagination details.



## OpenAPI

````yaml api-reference/platform-api.json get /v2/addresses
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.37
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/addresses:
    get:
      tags:
        - Address Information
      summary: Search address details
      description: Returns a list of addresses that match the specified search term.
      operationId: searchAddressLabels
      parameters:
        - name: networks
          required: false
          in: query
          description: >-
            Comma-separated list of blockchain networks to filter by (e.g.,
            ethereum, solana). Repeats also allowed.
          schema:
            example:
              - ethereum
              - solana
            type: array
            items:
              type: string
        - name: status
          required: false
          in: query
          description: Comma-separated list of address statuses. Repeats also allowed.
          schema:
            example:
              - malicious
              - sanctioned
            type: array
            items:
              type: string
              enum:
                - malicious
                - blacklisted
                - sanctioned
        - name: cursor
          required: false
          in: query
          description: >-
            Opaque cursor for pagination, obtained from a previous response meta
            field.
          schema:
            example: n51
            type: string
        - name: size
          required: false
          in: query
          description: Number of results per page (1–200, default 50).
          schema:
            minimum: 1
            maximum: 200
            example: 50
            type: number
      responses:
        '200':
          description: List of addresses that match the specified search term.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressIndexResponseDto'
components:
  schemas:
    AddressIndexResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AddressDto'
        meta:
          $ref: '#/components/schemas/CursorMetaDto'
      required:
        - items
        - meta
    AddressDto:
      type: object
      properties:
        id:
          type: string
          example: solana:9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin
          description: Record id
        address:
          type: string
          example: 9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin
          description: Address
        network:
          type: string
          example: solana
          description: Blockchain network identifier (e.g. solana, stellar)
        type:
          type: string
          enum:
            - account
            - validator
            - contract
            - module
            - multisig
          example: multisig
        status:
          type: array
          example:
            - blacklisted
          items:
            type: string
            enum:
              - malicious
              - blacklisted
              - sanctioned
        label:
          type: string
          example: Treasury Multisig
        entity:
          type: string
          example: DAO Alpha
        blocked_by:
          example:
            - id: dao-alpha
              name: DAO Alpha
              icon_url: https://cdn.example.com/icons/dao-alpha.png
          type: array
          items:
            $ref: '#/components/schemas/EntityDto'
        tags:
          example:
            - DAO
            - Squads v3 Multisig
          type: array
          items:
            type: string
        balances:
          example:
            - denom: SOL
              amount: '5000000000'
          type: array
          items:
            $ref: '#/components/schemas/BalanceDto'
        last_active_at:
          type: string
          example: '2025-08-20T12:34:56.000Z'
      required:
        - id
        - address
        - network
        - type
        - status
        - label
        - entity
        - blocked_by
        - tags
        - balances
        - last_active_at
    CursorMetaDto:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the next page of results. null if
            there is no next page.
          example: eyJpZCI6IjkxeFFlV3Z...
        previous_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the previous page of results. null
            if there is no previous page.
          example: eyJpZCI6IjkxeFFlV3Z...
        first_page_cursor:
          type: string
          description: >-
            Opaque string cursor pointing to the very first page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        last_page_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the very last page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        total_count:
          type: number
          nullable: true
          description: Total number of results.
          example: 100
        page_number:
          type: number
          description: >-
            Current page number (1-based). Omitted by list endpoints that do not
            compute a page index.
          example: 1
    EntityDto:
      type: object
      properties:
        id:
          type: string
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        name:
          type: string
          example: Berlin Bank AG
        types:
          type: array
          example:
            - counterparty
          items:
            type: string
            enum:
              - self
              - client
              - counterparty
        legal_form:
          type: string
          nullable: true
          enum:
            - individual
            - business
          example: business
        jurisdiction:
          type: string
          nullable: true
          example: DE
        is_fi:
          type: boolean
          example: false
        client_id:
          type: string
          nullable: true
          example: null
          description: >-
            The client this counterparty belongs to. Null for workspace-level
            entities.
        created_at:
          type: string
          example: '2026-09-14T10:00:00.000Z'
        updated_at:
          type: string
          example: '2026-09-14T10:00:00.000Z'
        address:
          $ref: '#/components/schemas/EntityPostalAddressDto'
        tax_ids:
          type: array
          items:
            $ref: '#/components/schemas/TaxIdDto'
        persons_of_interest:
          type: array
          items:
            $ref: '#/components/schemas/PersonOfInterestDto'
        notes:
          type: string
          nullable: true
          example: Onboarded via referral
      required:
        - id
        - name
        - types
        - is_fi
        - client_id
        - created_at
        - updated_at
        - address
        - tax_ids
        - persons_of_interest
    BalanceDto:
      type: object
      properties:
        amount:
          type: string
          example: '5000000000'
        denom:
          type: string
          example: SOL
      required:
        - amount
        - denom
    EntityPostalAddressDto:
      type: object
      properties:
        line1:
          type: string
          nullable: true
          example: Friedrichstraße 1
        line2:
          type: string
          nullable: true
          example: 3. OG
        city:
          type: string
          nullable: true
          example: Berlin
        region:
          type: string
          nullable: true
          example: BE
        postal_code:
          type: string
          nullable: true
          example: '10117'
        country:
          type: string
          nullable: true
          example: DE
    TaxIdDto:
      type: object
      properties:
        jurisdiction:
          type: string
          example: BR
        scheme:
          type: string
          enum:
            - cpf
            - cnpj
            - ein
            - vat
            - utr
            - other
          example: cnpj
        masked_value:
          type: string
          example: '**********0195'
          description: Last four characters visible; never the raw value.
      required:
        - jurisdiction
        - scheme
        - masked_value
    PersonOfInterestDto:
      type: object
      properties:
        id:
          type: string
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        name:
          type: string
          example: Ada Lovelace
        role:
          type: string
          nullable: true
          example: director
      required:
        - id
        - name
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

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