# TxRequest | xrpl
Documentation for xrpl

# Interface TxRequest

The tx method retrieves information on a single transaction, by its identifying hash. Expects a response in the form of a TxResponse.

#### Hierarchy

- BaseRequest
  - TxRequest

- Defined in packages/xrpl/src/models/methods/tx.ts:13

#####
Index

### Properties

api_version?
binary?
command
ctid?
id?
max_ledger?
min_ledger?
transaction?

## Properties

### `Optional` api_version

api_version?: number

The API version to use. If omitted, use version 1.

Inherited from BaseRequest.api_version

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

### `Optional` binary

binary?: boolean

If true, return transaction data and metadata as binary serialized to hexadecimal strings. If false, return transaction data and metadata as. JSON. The default is false.

- Defined in packages/xrpl/src/models/methods/tx.ts:28

### command

command: "tx"

The name of the API method.

Overrides BaseRequest.command

- Defined in packages/xrpl/src/models/methods/tx.ts:14

### `Optional` ctid

ctid?: string

The Concise Transaction ID to look up. Exactly one of `transaction` or `ctid` must be specified for a TxRequest.

- Defined in packages/xrpl/src/models/methods/tx.ts:22

### `Optional` id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Inherited from BaseRequest.id

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

### `Optional` max_ledger

max_ledger?: number

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.

- Defined in packages/xrpl/src/models/methods/tx.ts:42

### `Optional` min_ledger

min_ledger?: number

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 this range.

- Defined in packages/xrpl/src/models/methods/tx.ts:35

### `Optional` transaction

transaction?: string

The transaction hash to look up. Exactly one of `transaction` or `ctid` must be specified for a TxRequest.

- Defined in packages/xrpl/src/models/methods/tx.ts:18

Generated using TypeDoc