Sign in

v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB
ledger.v2

Run a query template

Run a query template on a ledger

post/v2/{ledger}/queries/{id}/run

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

idstring required
Example:CUSTOMER_DEPOSIT

Query template ID.

Query parameters

schemaVersionstring required
Example:v1.0.0

Schema version to use for validation

pageSizeinteger

The maximum number of results to return per page.

cursorstring
Example:aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==

Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.

expandstring
pitstring date-time
order'effective'

Deprecated: Use sort param

reverseboolean
sortstring
Example:id:desc

Sort results using a field name and order (ascending or descending). Format: <field>:<order>, where <field> is the field name and <order> is either asc or desc.

Request body

cursorstring
varsobject

Example request

{
  "params": {
    "pageSize": 100,
    "cursor": "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    "sort": "id:desc"
  }
}

Response

OK

OR
OR
OR

Example response

{
  "cursor": {
    "pageSize": 15,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": "aW0gdmVuaWFtLCBxdWlzIG5vc3RydWQ=",
    "data": [
      {
        "postings": [
          {
            "amount": 100,
            "asset": "COIN",
            "destination": "users:002",
            "source": "users:001"
          }
        ],
        "reference": "ref:001",
        "metadata": {
          "admin": "true"
        },
        "preCommitVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        },
        "postCommitVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        },
        "preCommitEffectiveVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        },
        "postCommitEffectiveVolumes": {
          "orders:1": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          },
          "orders:2": {
            "USD": {
              "input": 100,
              "output": 10,
              "balance": 90
            }
          }
        }
      }
    ]
  }
}