Get Transaction
Look up the status and details of a transaction. By default, this method only returns data from ledger versions that have been validated by consensus.
Warning: XAG-API is early alpha software. API methods and data formats are likely to change frequently in ways that break backwards compatibility.
Request Format
GET /transactions/{transaction_id}
This API method uses the following path parameters:
| Field | Value | Required? | Description |
|---|---|---|---|
transaction_id |
String (TransactionID) | Required | The ID of the transaction to retrieve. |
This API method uses the following query parameters:
| Field | Value | Required? | Description |
|---|---|---|---|
min_ledger |
Number | Optional | (Optional) Use this with max_ledger to specify a range of up to 1000 ledger indexes, starting with this ledger (inclusive). If the server cannot find the transaction, it confirms whether it was able to search all the ledgers in the requested range. (Requires rippled v1.5.0+) |
max_ledger |
Number | Optional | (Optional) Use this with min_ledger to specify a range of up to 1000 ledger indexes, ending with this ledger (inclusive). If the server cannot find the transaction, it confirms whether it was able to search all the ledgers in the requested range. (Requires rippled v1.5.0+) |
Response Formats
404 Not Found
The transaction was not included in a fully-validated ledger version that the server has available. If you provided both the min_ledger and max_ledger fields in the request, the 404 txnNotFound response includes the searched_all field (requires rippled v1.5.0+).
Media type: application/json
400 Bad Request
The request was not properly formatted.
Media type: application/json
Formatted as a RippleAPIError
The response uses the following fields:
| Field | Type | Required? | Description |
|---|---|---|---|
errors |
Array of ErrorItem | May be omitted | A list of errors that occurred when processing this request. |
message |
String | May be omitted | A human-readable error message summarizing the problem(s) that occurred. |
200 OK
Transaction object. (Note that this command may successfully find the transaction even if it is included in a ledger outside the range of min_ledger to max_ledger.)
Media type: application/json
Formatted as a AppliedTransaction
500 Internal Server Error
One of the Universal Errors occurred.