Search Pledge

Search Pledge

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_id
integer or null >= 0
Default: null

Account id

Example: account_id=5
asset_manager_id
integer or null >= 0
Default: null

Asset manager id

Example: asset_manager_id=5
exchange_id
integer or null >= 0
Default: null

Exchange id

Example: exchange_id=5
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
state
Array of strings or null
Default: null

Returns objects that match the selected status.

Enum: "ASSIGNED_TO_SETTLEMENT" "OUTBOUND_TRANSACTION_CONFIRMED" "OUTBOUND_TRANSACTION_FAILED" "PLEDGE_APPROVED" "PLEDGE_CONSUMED" "PLEDGE_INCREMENT_PENDING_APPROVAL" "PLEDGE_READY" "PLEDGE_REJECTED" "RECOVERING_FROM_FAILURE" "UNPLEDGE_APPROVED" "UNPLEDGE_PENDING_APPROVAL" "UNPLEDGE_REJECTED"
Responses
200

pledge search results

400

invalid search parameters

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