Ledger Enterprise
API Documentation V1
API Documentation V1
  • GETTING STARTED
    • Welcome
    • Getting Started
    • Authentication
    • Rate Limits
    • Pagination
  • tutorials
    • Register a new API User
    • First Steps as an API User
    • Generate Reporting API Keys
    • Manage Reporting API Keys
  • REFERENCE
    • API reference
      • Accounts
        • Addresses
        • Balances
          • History
        • Currency
        • History
        • Labels
        • Nft collections
        • Nft portfolio
        • Nfts
        • Sync
        • Tokens
        • Erc20 children accounts
      • Api users
        • Register
      • Currencies
        • Tokens
      • Digests
        • History
      • Entities
        • History
        • Users
      • Groups
        • History
      • Labels
      • Messages
        • History
      • Organization
      • Pledges
      • Requests
        • Approve
        • Challenge
          • Reject
        • Governance status
        • Reject
      • Settlements
      • Transactions
        • Estimate fees
        • Fees
        • Approve
        • History
        • Labels
        • Reject
      • Users
        • History
      • Whitelists
        • History
      • Auth
        • Token
          • Refresh
      • Compliance
        • Address risk
        • Sanctions
      • Notifications
        • Configuration
    • Specification
Powered by GitBook
On this page
  1. REFERENCE
  2. API reference
  3. Accounts

Addresses

PreviousAccountsNextBalances

[DEPRECATED] Get an address by index for an account

get

Deprecated - Returns the receiving address corresponding to the specified index. The index must already be used or be the next one available. Check the derivation path parameter number to find out how many have already been generated. This functionaltity is available for UTXO-based currencies only. On non UTXO-based accounts, this endpoint will return the single public address in use for the account.

Authorizations
Path parameters
account_idintegerRequired

The account's ID

indexintegerRequired
Responses
200
Address generated
application/json
404
No address matches the provided index
application/json
get
GET /accounts/{account_id}/addresses/{index} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
  "address": "text",
  "derivation_path": "text"
}
  • GET[DEPRECATED] Get receiving addresses of an account
  • POSTGet receiving addresses of an account
  • GET[DEPRECATED] Get an address by index for an account

[DEPRECATED] Get receiving addresses of an account

get

Deprecated - For UTXO-based accounts. Returns a list of the next 3 available fresh addresses for an account. A fresh address is a newly generated address that has not received any previous transactions. It is recommended for privacy and security to use a fresh address for every transaction. On non UTXO-based accounts, this endpoint will return the single public address in use for the account.

Authorizations
Path parameters
account_idintegerRequired

The account's ID

Responses
200
New address generated
application/json
404
Provided index invalid
application/json
get
GET /accounts/{account_id}/addresses HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
  "addresses": [
    {
      "address": "text",
      "derivation_path": "text"
    }
  ]
}

Get receiving addresses of an account

post

[LAM] This post endpoint is returning addresses verified by the HSM and can be trusted. For UTXO-based accounts. Returns a list of the next 3 available fresh addresses for an account. A fresh address is a newly generated address that has not received any previous transactions. It is recommended for privacy and security to use a fresh address for every transaction. On non UTXO-based accounts, this endpoint will return the single public address in use for the account.

Authorizations
Path parameters
account_idintegerRequired

The account's ID

Body
account_namestringRequired

The name of the account you want the addresses for.

Example: My-Eth
indexinteger | nullableOptional

Select the index of the address to retrieve.

Default: nullExample: 35
Responses
200
New address generated
application/json
404
Provided index invalid
application/json
post
POST /accounts/{account_id}/addresses HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "account_name": "My-Eth",
  "index": 35
}
{
  "addresses": [
    {
      "address": "text",
      "derivation_path": "0/18"
    }
  ]
}