List reserved funds

GET

https://your-protect-instance.example.com/api/rest/v1/reservations

GET

/api/rest/v1/reservations

curl https://your-protect-instance.example.com/api/rest/v1/reservations \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "string",
      "amount": "string",
      "creationDate": "2024-01-15T09:30:00Z",
      "kind": "string",
      "comment": "string",
      "addressid": "string",
      "address": "string",
      "currencyInfo": {
        "name": "string",
        "symbol": "string",
        "coinTypeIndex": "string",
        "blockchain": "string",
        "isToken": true,
        "isERC20": true,
        "decimals": "string",
        "contractAddress": "string",
        "hasStaking": true,
        "isUTXOBased": true,
        "isAccountBased": true,
        "isFiat": true,
        "isFA12": true,
        "isFA20": true,
        "isNFT": true,
        "enabled": true,
        "id": "string",
        "displayName": "string",
        "type": "string",
        "wlcaId": "string",
        "network": "string",
        "tokenID": "string",
        "logo": "string",
        "tokenInfo": {
          "tokenType": "TOKEN_TYPE_ERC20"
        }
      },
      "asset": {
        "currency": "string",
        "kind": "string",
        "nft": {
          "tokenid": "string"
        },
        "unknown": {
          "blockchain": "string",
          "arg1": "string",
          "arg2": "string",
          "network": "string"
        },
        "currencyInfo": {
          "name": "string",
          "symbol": "string",
          "coinTypeIndex": "string",
          "blockchain": "string",
          "isToken": true,
          "isERC20": true,
          "decimals": "string",
          "contractAddress": "string",
          "hasStaking": true,
          "isUTXOBased": true,
          "isAccountBased": true,
          "isFiat": true,
          "isFA12": true,
          "isFA20": true,
          "isNFT": true,
          "enabled": true,
          "id": "string",
          "displayName": "string",
          "type": "string",
          "wlcaId": "string",
          "network": "string",
          "tokenID": "string",
          "logo": "string",
          "tokenInfo": {
            "tokenType": "TOKEN_TYPE_ERC20"
          }
        }
      },
      "resourceId": "string",
      "resourceType": "string"
    }
  ],
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}

This endpoint returns a list of fund reservations. Default limit is 100. Results are sorted by the most recent reservations first.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

kindstringOptional

Deprecated since 3.20: use 'kinds' instead.

addressstringOptional

Filter by blockchain address

addressIdstringOptionalformat: "uint64"

Filter by address id

cursor.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSizestringOptionalformat: "uint64"

The size of the page requested. The handling service should impose a hard limit on this

kindslist of stringsOptional

Filter by kinds of reservation. Takes precedence over 'kind'.

Response

A successful response.

resultlist of objectsOptional

cursorobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error