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

Sync

PreviousNftsNextTokens

Sync the account to update transactions with list status

get

This will synchronize the account's transactions status with the one on the blockchain

Authorizations
Path parameters
account_idintegerRequired

The account's ID

Query parameters
synchronousboolean | nullableOptional

If true, the synchronization will be performed synchronously. Otherwise, it will run a a background task

Default: falseExample: true
Responses
200
Account object
application/json
404
Account not found
application/json
get
GET /accounts/{account_id}/sync 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:11:42.632Z",
  "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"
}