Stream

Get Transactions Stream

Returns transactions which have been committed to the ledger. Check detailed documentation for brief explanation

post/stream/transactions

Request body

cursorstring nullable

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger nullable

The page size requested.

kind_filter'User' | 'EpochChange' | 'All'

Limit returned transactions by their kind. Defaults to user.

manifest_accounts_withdrawn_from_filterAddress[]

Allows specifying an array of account addresses. If specified, the response will contain only transactions with a manifest containing withdrawals from the given accounts.

manifest_accounts_deposited_into_filterAddress[]

Similar to manifest_accounts_withdrawn_from_filter, but will return only transactions with a manifest containing deposits to the given accounts.

manifest_badges_presented_filterAddress[]

Allows specifying array of badge resource addresses. If specified, the response will contain only transactions where the given badges were presented.

manifest_resources_filterAddress[]

Allows specifying array of resource addresses. If specified, the response will contain only transactions containing the given resources in the manifest (regardless of their usage). We recommend that integrators use balance_change_resources_filter in most cases, as it also captures resource changes that are not specified in the manifest.

affected_global_entities_filterAddress[]

Allows specifying an array of global addresses. If specified, the response will contain transactions that affected all of the given global entities. A global entity is marked as "affected" by a transaction if any of its state (or its descendents' state) was modified as a result of the transaction. For performance reasons consensus manager and transaction tracker are excluded from that filter.

accounts_with_manifest_owner_method_callsAddress[]

Allows specifying an array of account addresses. If specified, the response will contain only transactions that, for all specified accounts, contain manifest method calls to that account which require the owner role. See the account docs for more information.

accounts_without_manifest_owner_method_callsAddress[]

Allows specifying an array of account addresses. If specified, the response will contain only transactions that, for all specified accounts, do NOT contain manifest method calls to that account which require owner role. See the account docs for more information.

event_global_emitters_filterAddress[]

Allows specifying an array of global addresses. If specified, the response will contain transactions in which all entities emitted events. If an event was published by an internal entity, it is going to be indexed as it is a global ancestor. For performance reasons events published by consensus manager and native XRD resource are excluded from that filter.

balance_change_resources_filterAddress[]

Allows filtering to transactions which included non-fee related balance changes for all provided resources. Defaults to []. We recommend that integrators use this instead of the manifest_resources_filter in most cases, as it also captures resource changes that are not specified in the manifest.

transaction_status_filter'Success' | 'Failure' | 'All'

Allows filtering by the transaction commit status (Success, Failure, All). Defaults to All.

order'Asc' | 'Desc'

Configures the order of returned result set. Defaults to desc.

Example request

{
  "limit_per_page": 5
}

Response

Transactions (paginated)

next_cursorstring nullable

If specified, contains a cursor to query next page of the items collection.

Example response

{
  "ledger_state": {
    "network": "<network-name>"
  }
}

Changes

Changed in 12 of the 50 revisions of this API.9217

Jan 22, 20250387680b7d534See the full diff
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  request property // deprecated
  request-property-deprecated
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  response property allOf[subschema #2]/items/items/receipt/events deprecated
  response-property-deprecated
Dec 17, 2024f72f555723702See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
Dec 10, 202400c5f3bf5c2163See the full diff
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property //// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ○
  the request property //// became nullable
  request-property-became-nullable
- ○
  the request property //// became nullable
  request-property-became-nullable
- ○
  the request property //// became nullable
  request-property-became-nullable
Dec 9, 20246ccf7b2ba0b03See the full diff
- ▲
  the request property //// became not nullable
  request-property-became-not-nullable
- ▲
  the request property //// became not nullable
  request-property-became-not-nullable
- ▲
  the request property //// became not nullable
  request-property-became-not-nullable
Nov 12, 2024b934f6eb79ca2See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Oct 3, 2024345114e18c652See the full diff
- ○
  removed from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jul 22, 2024a1b5147b72321See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
Jul 22, 20248e9f931c46f91See the full diff
- ●
  removed the request property /
  request-property-removed
Jul 16, 20241699478a52e41See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 16, 202431c0cb9534ca1See the full diff
- ●
  removed the request property /
  request-property-removed

Full history (12 revisions)