Pledges

get

Search Pledge

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Query parameters

account_idinteger | nullableOptional

Account id

Default: nullExample: 5

asset_manager_idinteger | nullableOptional

Asset manager id

Default: nullExample: 5

exchange_idinteger | nullableOptional

Exchange id

Default: nullExample: 5

pageinteger | nullableOptional

Defines the page number to be fetched.

Default: 1Example: 3

page_sizeinteger | nullableOptional

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

Default: 20Example: 40

Responses

200

pledge search results

application/json

400

invalid search parameters

application/json

get

HTTPcURLJavaScriptPython

GET /pledges HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "edges": [
    {
      "cursor": 0,
      "node": {
        "account_id": 1,
        "amount": 1,
        "asset_manager": {
          "approver_group_id": 1,
          "code": "text",
          "id": "text",
          "name": "text",
          "role": "text",
          "whitelist_id": 1
        },
        "custodian": {
          "approver_group_id": 1,
          "code": "text",
          "id": "text",
          "name": "text",
          "role": "text",
          "whitelist_id": 1
        },
        "exchange": {
          "approver_group_id": 1,
          "code": "text",
          "id": "text",
          "name": "text",
          "role": "text",
          "whitelist_id": 1
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "pending": 1,
        "pledge_subaccount_id": 1,
        "state": "ASSIGNED_TO_SETTLEMENT"
      }
    }
  ],
  "page_info": {
    "count": 1,
    "has_next_page": false
  }
}

get

Get a pledge by id

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Path parameters

pledge_idintegerRequired

pledge's id

Responses

200

pledge object

application/json

404

pledge not found

application/json

get

HTTPcURLJavaScriptPython

GET /pledges/{pledge_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "account_id": 1,
  "amount": 1,
  "asset_manager": {
    "approver_group_id": 1,
    "code": "text",
    "id": "text",
    "name": "text",
    "role": "text",
    "whitelist_id": 1
  },
  "custodian": {
    "approver_group_id": 1,
    "code": "text",
    "id": "text",
    "name": "text",
    "role": "text",
    "whitelist_id": 1
  },
  "exchange": {
    "approver_group_id": 1,
    "code": "text",
    "id": "text",
    "name": "text",
    "role": "text",
    "whitelist_id": 1
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pending": 1,
  "pledge_subaccount_id": 1,
  "state": "ASSIGNED_TO_SETTLEMENT"
}