Accounts

Search accounts

get

Use the following parameters to search accounts.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Query parameters

account_labelstring[] | nullableOptional

A list of label id to filter account by.

Default: null

account_typestring · enum | nullableOptional

Filters the results on the crypto asset type.

Default: nullPossible values:

created_afterstring · date-time | nullableOptional

Returns objects created after the entered date.

Default: nullExample: 2020-09-12T14:15:22Z

created_beforestring · date-time | nullableOptional

Returns objects created before the entered date.

Default: nullExample: 2020-12-13T16:17:28Z

currencystring | nullableOptional

Filters the results by the account's currency.

Default: nullExample: bitcoin or ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7

entityinteger[] | nullableOptional

An entity to filter account by

Default: null

groupinteger | nullableOptional

Lists accounts linked to the entered group.

Default: null

idinteger | nullableOptional

Returns the object corresponding to the entered ID

Default: null

namestring | nullableOptional

Filters the list by account name.

Default: nullExample: hot wallet 1

orderstring · enum | nullableOptional

Orders the list of results

Default: nullExample: descPossible values:

order_bystring | nullableOptional

criteria to order by

Default: nullExample: name

pageinteger | nullableOptional

Defines the page number to be fetched.

Default: 1Example: 3

page_sizeinteger | nullableOptional

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate

Default: 20Example: 40

parentinteger | nullableOptional

Filters the list of results to display accounts linked to the entered parent account.

Default: null

statusstring · enum | nullableOptional

Returns objects that match the selected status.

Default: nullPossible values:

userinteger | nullableOptional

Filters the list to display accounts the entered user belongs to.

Default: null

Responses

200

Account search results

application/json

400

Invalid search parameter

application/json

404

This search parameter doesn't exist

application/json

get

HTTPcURLJavaScriptPython

GET /accounts HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "edges": [
    {
      "cursor": 0,
      "node": {
        "address": "2S4wKimi4PHKjdTYdzqN5HcEcNBM4Hv9db9QWKaZCxEr",
        "available_balance": "1337",
        "balance": "1338",
        "coin_fields": {
          "staking": {
            "activated_at": "2023-02-06T02:48:59+00:00",
            "activated_cycle": 575,
            "active_balance": "322254",
            "baker_address": "2S4wKimi4PHKjdTYdzqN5HcEcNBM4Hv9db9QWKaZCxEr",
            "delegated_at": "2023-01-19T15:18:29+00:00",
            "delegated_block": "3071075",
            "delegated_cycle": 568,
            "gross_apy": "38.33349571462074",
            "rewards": "6958",
            "state": "active",
            "updated_at": "2023-03-10T17:38:41+00:00"
          },
          "type": "Tezos"
        },
        "contract_address": "text",
        "created_by": 5,
        "created_on": "2025-05-30T18:24:46.012Z",
        "currency": "bitcoin",
        "derivation_path": "44'/0'/0'",
        "governance_rules": [
          {
            "id": 1,
            "index": 0,
            "name": "Rule 1",
            "rules": {
              "data": [
                {
                  "group": 2,
                  "quorum": 1
                },
                {
                  "quorum": 1,
                  "users": [
                    1,
                    2
                  ]
                }
              ],
              "id": 1,
              "type": "MULTI_AUTHORIZATIONS"
            }
          }
        ],
        "id": 1,
        "index": 0,
        "labels": [
          {
            "id": 1,
            "info": {
              "color": "#fe3423",
              "description": "Flag resources as potentially harmfull"
            },
            "name": "SPAM"
          }
        ],
        "last_request": 3,
        "name": "hot wallet 1",
        "parent": 1,
        "pending_balance": "42",
        "status": "ACTIVE",
        "token_accounts": [
          {
            "address": "text",
            "balance": "text",
            "contract_address": "text",
            "ticker": "text"
          }
        ],
        "tradelink_data": {
          "total_repledge": "0"
        },
        "type": "Bitcoin",
        "xpub": "xpub6DGnkaitcjHaKFY18sqWhT3ghE6WWCS61BWn6BwmfzTvr3GHis274GFmXwh4P46s6ikgGEoFjzq4R3KyhUwkkGnXdrpha4QGo3n7PPSehvR"
      }
    }
  ],
  "page_info": {
    "count": 1,
    "has_next_page": false
  }
}

Get an account by ID

get

This method returns the account that matches the entered ID.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Path parameters

account_idintegerRequired

The account's ID

Responses

200

Account object

application/json

404

Account not found

application/json

get

HTTPcURLJavaScriptPython

GET /accounts/{account_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "address": "2S4wKimi4PHKjdTYdzqN5HcEcNBM4Hv9db9QWKaZCxEr",
  "available_balance": "1337",
  "balance": "1338",
  "coin_fields": {
    "staking": {
      "activated_at": "2023-02-06T02:48:59+00:00",
      "activated_cycle": 575,
      "active_balance": "322254",
      "baker_address": "2S4wKimi4PHKjdTYdzqN5HcEcNBM4Hv9db9QWKaZCxEr",
      "delegated_at": "2023-01-19T15:18:29+00:00",
      "delegated_block": "3071075",
      "delegated_cycle": 568,
      "gross_apy": "38.33349571462074",
      "rewards": "6958",
      "state": "active",
      "updated_at": "2023-03-10T17:38:41+00:00"
    },
    "type": "Tezos"
  },
  "contract_address": "text",
  "created_by": 5,
  "created_on": "2025-05-30T18:24:46.012Z",
  "currency": "bitcoin",
  "derivation_path": "44'/0'/0'",
  "governance_rules": [
    {
      "id": 1,
      "index": 0,
      "name": "Rule 1",
      "rules": {
        "data": [
          {
            "group": 2,
            "quorum": 1
          },
          {
            "quorum": 1,
            "users": [
              1,
              2
            ]
          }
        ],
        "id": 1,
        "type": "MULTI_AUTHORIZATIONS"
      }
    }
  ],
  "id": 1,
  "index": 0,
  "labels": [
    {
      "id": 1,
      "info": {
        "color": "#fe3423",
        "description": "Flag resources as potentially harmfull"
      },
      "name": "SPAM"
    }
  ],
  "last_request": 3,
  "name": "hot wallet 1",
  "parent": 1,
  "pending_balance": "42",
  "status": "ACTIVE",
  "token_accounts": [
    {
      "address": "text",
      "balance": "text",
      "contract_address": "text",
      "ticker": "text"
    }
  ],
  "tradelink_data": {
    "total_repledge": "0"
  },
  "type": "Bitcoin",
  "xpub": "xpub6DGnkaitcjHaKFY18sqWhT3ghE6WWCS61BWn6BwmfzTvr3GHis274GFmXwh4P46s6ikgGEoFjzq4R3KyhUwkkGnXdrpha4QGo3n7PPSehvR"
}