GET
/
api
/
ledger
/
{ledger}
/
transactions
curl --request GET \
  --url http://localhost:55001/api/ledger/{ledger}/transactions \
  --header 'Authorization: Bearer <token>'
{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": "",
    "data": [
      {
        "timestamp": "2023-11-07T05:31:56Z",
        "postings": [
          {
            "amount": 100,
            "asset": "COIN",
            "destination": "users:002",
            "source": "users:001"
          }
        ],
        "reference": "ref:001",
        "metadata": {},
        "txid": 1,
        "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
            }
          }
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
ledger
string
required

Name of the ledger.

Example:

"ledger001"

Query Parameters

​
pageSize
integer

The maximum number of results to return per page.

Required range: 1 <= x <= 1000
​
page_size
integer
deprecated

The maximum number of results to return per page. Deprecated, please use pageSize instead.

Required range: 1 <= x <= 1000
​
after
string

Pagination cursor, will return transactions after given txid (in descending order).

Example:

1234

​
reference
string

Find transactions by reference field.

Example:

"ref:001"

​
account
string

Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $).

Example:

"users:001"

​
source
string

Filter transactions with postings involving given account at source (regular expression placed between ^ and $).

Example:

"users:001"

​
destination
string

Filter transactions with postings involving given account at destination (regular expression placed between ^ and $).

Example:

"users:001"

​
startTime
string

Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute).

​
start_time
string
deprecated

Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute). Deprecated, please use startTime instead.

​
endTime
string

Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute).

​
end_time
string
deprecated

Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute). Deprecated, please use endTime instead.

​
cursor
string

Parameter used in pagination requests. Maximum page size is set to 1000. 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.

Example:

"aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="

​
pagination_token
string
deprecated

Parameter used in pagination requests. Maximum page size is set to 1000. 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. Deprecated, please use cursor instead.

Example:

"aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="

​
metadata
object

Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below.

Response

200
application/json

OK

The response is of type object.