How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ledger Settlements API

The Settlements API from Ledger — 4 operation(s) for settlements.

Ledger Settlements API is one of 42 APIs that Ledger publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Settlement. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 5 operations across 4 paths, and defines 65 schemas. It is described by OpenAPI 3.2.0, at version 1.35.0.

Requests are made against the base URL https://api.vault.ledger.com.

5 operations 4 paths 65 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.35.0
Base URL
https://api.vault.ledger.com
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Ledger Settlements API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-Ledger-API-User (Ledger_API_User). An API key is passed in the header as X-Ledger-API-Key (Ledger_API_Key). An API key is passed in the header as X-Ledger-Store-Auth-Token (Ledger_Store_Auth_Token). By default, every request must be authenticated.

  • Ledger_API_User — (required) Username of a registered API User
  • Ledger_API_Key — If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, [see step 5 o…
  • Ledger_Store_Auth_Token — If you've set up HashiCorp Vault as an authentication service, you'll need to pass the X-Ledger-Store-Auth-Token header along with the API user header. For mor…

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Settlements 5
GET
/settlements
Search settlement
2 params → 200400
POST
/settlements
Create Settlement
body → 200400
GET
/settlements/{settlement_id}
Get a settlement by id
1 param → 200404
POST
/settlements/{settlement_id}/cancel
Cancel a settlement by id. Only Settlement with an outbound transaction in status FAILEDTOBROADCAST can be canceled. Only Exchange (Liquidity Provider) user can cancel a settlement.
1 param → 200400404
POST
/settlements/{settlement_id}/recover
Used to accelerate on-chain confirmation of an Outbound Settlement transaction stuck pending in a mempool. This is only applicable to a settlement with an outbound transaction in status SUBMITTED. On…
1 param body → 200400404

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are Pledge (9 properties), Settlement (8 properties), RepledgeIntent (8 properties), EthereumSCITransactionData (7 properties). Each schema is shown below with its type and property counts.

SolanaCreateAssociatedTokenAccountTransactionData
object
4 properties 3 required
EthereumFeesStrategy
object
2 properties 2 required
EthereumSendTransactionData
object
6 properties 5 required
BitcoinSendTransactionData
object
5 properties 5 required
CardanoSendTransactionData
object
5 properties 5 required
PolkadotSendTransactionCreationData
object
3 properties 3 required
RippleSendTransactionData
object
6 properties 5 required
TezosSendTransactionCreationData
object
4 properties 4 required
BitcoinSendTransactionCreationData
object
4 properties 4 required
TronSendTransactionCreationData
object
4 properties 4 required
EthereumFeesStrategyData
object
2 properties 2 required
PolkadotUnbondStakingTransactionData
object
3 properties 3 required
CardanoSendTransactionCreationData
object
4 properties 4 required
StellarMemoText1
object
1 property 1 required
SolanaSendTransactionCreationData
object
3 properties 3 required
BitcoinFeesStrategy
object
2 properties 2 required
PolkadotBondExtraStakingTransactionData
object
3 properties 3 required
APISearchPageInfo
object
2 properties 2 required
RepledgeIntent
object
8 properties 5 required
EthereumSCITransactionData
object
7 properties 5 required
PolkadotWithdrawTransactionCreationData
object
3 properties 3 required
SolanaSendSplTokenTransactionData
object
6 properties 5 required
PolkadotWithdrawStakingTransactionData
object
2 properties 2 required
TronSendTransactionData
object
5 properties 5 required
TezosSendTransactionData
object
5 properties 5 required
StellarSendTransactionData
object
6 properties 5 required
PolkadotRebondStakingTransactionData
object
3 properties 3 required
TradelinkCustodian
object
4 properties 4 required
RippleSendTransactionCreationData
object
4 properties 4 required
StellarMemoReturn1
object
1 property 1 required
GenericFeesStrategyData
object
1 property 1 required
StellarSendTransactionCreationData
object
4 properties 4 required
PolkadotChillTransactionCreationData
object
3 properties 3 required
Settlement
object
8 properties 4 required
StellarMemoId1
object
1 property 1 required
PolkadotUnbondTransactionCreationData
object
3 properties 3 required
PolkadotSetPayeeTransactionCreationData
object
3 properties 3 required
PledgeSearchResult
object
2 properties 2 required
PolkadotChillStakingTransactionData
object
2 properties 2 required
SolanaSendTransactionData
object
5 properties 4 required
TradelinkAssetManager
object
6 properties 6 required
SCIData
object
3 properties
PolkadotRebondTransactionCreationData
object
3 properties 3 required
Pledge
object
9 properties 9 required
SolanaCreateAssociatedTokenAccountCreationData
object
3 properties 3 required
EthereumSCDTransactionData
object
5 properties 4 required
PolkadotBondExtraTransactionCreationData
object
3 properties 3 required
EthereumExecuteContractTransactionCreationData
object
4 properties 4 required
EthereumSendTransactionCreationData
object
4 properties 4 required
PolkadotSendTransactionData
object
4 properties 4 required
TradelinkExchange
object
6 properties 6 required
SettlementRecoveryData
object
2 properties 2 required
GenericFeesStrategy
object
2 properties 2 required
EthereumDeployContractTransactionCreationData
object
4 properties 4 required
StellarMemoHash1
object
1 property 1 required
_APISearchPledgeResults
object
2 properties 2 required
RepledgeRequest
object
2 properties 2 required
BitcoinFeesStrategyData
object
1 property 1 required
OutboundTransaction
object
3 properties 2 required
SolanaSendSplTokenTransactionCreationData
object
3 properties 3 required
Error
object
3 properties 3 required
PolkadotSetPayeeStakingTransactionData
object
3 properties 3 required
InboundTransactionIntent
object
3 properties 3 required
EthereumEIP1559FeesStrategyData
object
2 properties 2 required
CreateSettlement
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ledger-settlements-api-openapi.yml Raw ↑

Other APIs Ledger publishes across the network.

Ledger Wallet API
Ledger Device Management Kit
Ledger 4337 API
Ledger Accounts API
Ledger Authentication API
Ledger Buy Redirect API
Ledger Capabilities API
Ledger Cardano API
Ledger Compliance API
Ledger Crypto Currencies API
Ledger Currencies API
Ledger Delegates API
Where this information came from

This is an independent, third-party profile of Ledger Settlements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.