Search accounts

Use the following parameters to search accounts.

Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)
Request
query Parameters
account_type
string or null
Default: null

Filters the results on the crypto asset type.

Enum: "Bep20" "Bitcoin" "Cardano" "Cosmos" "Erc20" "Ethereum" "Generic" "Near" "Polkadot" "Polygon" "Ripple" "Solana" "Stellar" "Tezos" "Tron"
created_after
string or null <date-time>
Default: null

Returns objects created after the entered date.

Example: created_after=2020-09-12T14:15:22Z
created_before
string or null <date-time>
Default: null

Returns objects created before the entered date.

Example: created_before=2020-12-13T16:17:28Z
currency
string or null
Default: null

Filters the results by the account's currency.

Example: currency=bitcoin or ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7
entity
Array of integers or null
Default: null

An entity to filter account by

group
integer or null
Default: null

Lists accounts linked to the entered group.

id
integer or null
Default: null

Returns the object corresponding to the entered ID

name
string or null
Default: null

Filters the list by account name.

Example: name=hot wallet 1
order
string or null
Default: null

Orders the list of results

Enum: "asc" "desc"
Example: order=desc
order_by
string or null
Default: null

criteria to order by

Example: order_by=name
page
integer or null >= 1
Default: 1

Defines the page number to be fetched.

Example: page=3
page_size
integer or null >= -1
Default: 20

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

Example: page_size=40
parent
integer or null
Default: null

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

status
string or null
Default: null

Returns objects that match the selected status.

Enum: "ACTIVE" "APPROVED" "HSM_COIN_UPDATED" "PENDING" "PENDING_CREATE_IN_HSM" "PENDING_VIEW_ONLY" "REJECTED" "VIEW_ONLY"
user
integer or null
Default: null

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

Responses
200

Account search results

400

Invalid search parameter

404

This search parameter doesn't exist

get/accounts
Response samples
application/json
{
  • "edges": [
    ],
  • "page_info": {
    }
}
Copyright © Ledger Enterprise Platform 2023. All right reserved.