List Crypto Wallets

Returns all crypto wallets accessible to the authenticated API principal.

Endpoint Details

Method: GET
Path: /api/crypto-wallet
Authentication: Required (API Key)

Request

GET /api/crypto-wallet
Authorization: Bearer <your_api_key>
Accept: application/json

Query Parameters (APIPagingDto)

All query parameters are optional and can be used to filter, sort, and paginate the results:

Parameter	Type	Description
`limit`	integer	Maximum number of items to return
`sort`	string	Field to sort by
`direction`	string	Sort direction (asc/desc)
`select`	array	Array of specific fields to return
`filter`	string	Filter expression for results
`math`	string	Mathematical operations on results
`range`	string	Range-based filtering
`page`	integer	Page number for pagination
`cursor`	string	Cursor-based pagination identifier
`logic`	string	Logical operations for complex queries

Example Request

GET /api/crypto-wallet?limit=10&page=1&sort=created_at&direction=desc
Authorization: Bearer <your_api_key>
Accept: application/json

Response

Success Response (200)

{
  "code": 200,
  "message": "OK",
  "data": {
    "crypto_wallets": [
      {
        "id": "uuid",
        "asset": "string",
        "network": "string", 
        "wallet_address": "string",
        "balance": {
          "total": 0.0,
          "locked_amount": 0.0,
          "available": 0.0,
          "pending": 0.0,
          "currency": "string",
          "has_minor": true
        },
        "status": "string",
        "created_at": "2023-10-27T10:30:00Z",
        "updated_at": "2023-10-27T10:30:00Z"
      }
    ],
    "paging": {
      "totalCount": 100,
      "page": 1,
      "hasNextPage": true,
      "next_cursor": "cursor_string",
      "previous_cursor": "cursor_string"
    }
  }
}

{
  "message": "crypto wallets successfully fetched",
  "status": "success",
  "data": {
    "crypto_wallets": [
      {
        "id": "55566707-e03a-462d-a65c-f8f7963d2528",
        "asset": "USDC",
        "network": "TRC20",
        "wallet_address": "TKorxkk9QEQhKn6BxqnmwXveXyzC1GcCxn",
        "balance": {
          "total": 0,
          "locked_amount": 0,
          "available": 1.2961762799740766,
          "pending": 0,
          "currency": "USDC",
          "has_minor": false
        },
        "status": "active",
        "created_at": "2025-07-30T19:37:41.73719Z",
        "updated_at": "2025-07-30T19:37:41.73719Z"
      },
      {
        "id": "14b5c66b-3351-4120-8640-d17ed13ccb15",
        "asset": "USDC",
        "network": "ERC20",
        "wallet_address": "0x6BECC92E4c75F833D4036545dD4Aa84aaF8583ec",
        "balance": {
          "total": 0,
          "locked_amount": 54.88125845738305,
          "available": 241.40157205179526,
          "pending": 0,
          "currency": "USDC",
          "has_minor": false
        },
        "status": "active",
        "created_at": "2025-06-24T19:04:26.399099Z",
        "updated_at": "2025-06-24T19:04:26.399099Z"
      }
    ],
    "paging": {
      "totalCount": 2,
      "page": 1,
      "hasNextPage": false,
      "next_cursor": "",
      "previous_cursor": ""
    }
  }
}

Error Responses

Status Code	Description
400	Invalid input or malformed query parameters
401	Unauthorized - Invalid or missing API key
500	Internal server error

Data Models

Crypto Wallet Object

Field	Type	Description
`id`	UUID	Unique wallet identifier
`asset`	string	Asset type (e.g., USDT, USDC)
`network`	string	Blockchain network (e.g., ERC20, TRC20)
`wallet_address`	string	Crypto wallet address
`balance`	object	Balance information (see Balance Object)
`status`	string	Wallet status (active, inactive, etc.)
`created_at`	timestamp	ISO-8601 formatted creation timestamp
`updated_at`	timestamp	ISO-8601 formatted last update timestamp

Balance Object

Field	Type	Description
`total`	float64	Total balance in the wallet
`locked_amount`	float64	Amount locked/reserved for pending operations
`available`	float64	Available balance for new transactions
`pending`	float64	Amount in pending transactions
`currency`	string	Currency code
`has_minor`	boolean	Whether the currency supports minor units (decimals)

Pagination Info

Field	Type	Description
`totalCount`	int64	Total number of wallets available
`page`	integer	Current page number
`hasNextPage`	boolean	Whether there are more pages available
`next_cursor`	string	Cursor for retrieving the next page
`previous_cursor`	string	Cursor for retrieving the previous page

Usage Examples

Basic Request

curl -X GET "https://ba-be-stg.usevaulta.com/v1/api/crypto-wallet" \
  -H "Authorization: Bearer your_api_key" \
  -H "Accept: application/json"

Filtered Request

curl -X GET "https://ba-be-stg.usevaulta.com/v1/api/crypto-wallet?filter=asset:USDT&limit=5" \
  -H "Authorization: Bearer your_api_key" \
  -H "Accept: application/json"

Paginated Request

curl -X GET "https://ba-be-stg.usevaulta.com/v1/api/crypto-wallet?page=2&limit=10" \
  -H "Authorization: Bearer your_api_key" \
  -H "Accept: application/json"