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

# List Address Book

> List address book entries with optional filtering.

Query params:
- asset: Filter by asset code (e.g., ?asset=BTC)
- status: Filter by status - verified, unverified, unavailable (e.g., ?status=verified)



## OpenAPI

````yaml /openapi.json get /api/private/v2/wallet/address-book/
openapi: 3.0.3
info:
  title: Digital Surge API
  version: '2.0'
  description: >-
    Digital Surge is an Australian cryptocurrency exchange. This API provides
    programmatic access to your account: live AUD pricing for hundreds of
    assets, instant swaps, recurring buys, price triggers, portfolio balances,
    transaction history, and crypto withdrawals.


    **Authentication** — create an API key in the Digital Surge app under
    *Account Settings → API Keys* and send it with every request:
    `Authorization: Bearer <your-api-key>`. Read-only and read & write keys are
    available.


    **Guides and interactive documentation** — https://digitalsurge.com.au/docs


    **AI agents** — connect via the Digital Surge MCP server:
    https://mcp.digitalsurge.com.au/mcp
servers:
  - url: https://app.digitalsurge.com.au
    description: Production
security: []
tags:
  - name: Public
    description: Unauthenticated endpoints — market data, asset info, pricing
  - name: Private
    description: Authenticated endpoints — trading, portfolio, account management
paths:
  /api/private/v2/wallet/address-book/:
    get:
      tags:
        - Private
      summary: List Address Book
      description: >-
        List address book entries with optional filtering.


        Query params:

        - asset: Filter by asset code (e.g., ?asset=BTC)

        - status: Filter by status - verified, unverified, unavailable (e.g.,
        ?status=verified)
      operationId: private_v2_wallet_address_book_list
      parameters:
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: page_size
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWithdrawalAddressBookListList'
          description: ''
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedWithdrawalAddressBookListList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/WithdrawalAddressBookList'
    WithdrawalAddressBookList:
      type: object
      description: >-
        Read-only serializer for listing address book entries.

        Includes asset code instead of full asset object.

        Includes a computed 'status' field with values: verified, unverified,
        unavailable.

        Includes nested travel_rule data when available.
      properties:
        id:
          type: integer
          readOnly: true
        asset:
          type: string
          readOnly: true
        asset_name:
          type: string
          readOnly: true
        network:
          type: string
          readOnly: true
        address:
          type: string
          readOnly: true
        memo:
          type: string
          readOnly: true
          description: Tag/Memo for assets that require it (XRP, XLM, etc)
        label:
          type: string
          readOnly: true
          description: User-friendly label (e.g., 'My Ledger', 'Cold Storage')
        status:
          type: string
          description: >-
            Compute status based on unavailable and confirmed fields.

            - unavailable: unavailable=True (admin-disabled)

            - verified: confirmed=True, unavailable=False

            - unverified: confirmed=False, unavailable=False


            Note: enabled=False addresses are filtered out in the view and won't
            appear here.
          readOnly: true
        enabled:
          type: boolean
          readOnly: true
          description: False = soft deleted
        confirmed:
          type: boolean
          readOnly: true
          description: Email confirmation status
        confirmed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
        last_used:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          description: Last time used for a withdrawal
        times_used:
          type: integer
          readOnly: true
        travel_rule:
          type: object
          additionalProperties: {}
          nullable: true
          description: >-
            Return current travel rule data for this address book entry, or
            null.


            Uses prefetched _prefetched_attestations (set via Prefetch in the
            viewset queryset).

            Falls back to a query if the prefetch is missing (e.g. single-object
            retrieval).
          readOnly: true
      required:
        - address
        - asset
        - asset_name
        - confirmed
        - confirmed_at
        - created
        - enabled
        - id
        - label
        - last_used
        - memo
        - network
        - status
        - times_used
        - travel_rule
        - updated
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Personal API key, created in the Digital Surge app under Account
        Settings → API Keys. Send it with every request as `Authorization:
        Bearer <your-api-key>`.

````