account_lines

[Source]

The account_lines method returns information about an account's trust lines, which contain balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger.

Request Format

An example of the request format:

{
  "id": 1,
  "command": "account_lines",
  "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
}

Try it! >

The request accepts the following parameters:

`Field`	Type	Description
`account`	String - Address	Look up trust lines connected to this account.
`ledger_hash`	String	(Optional) A 20-byte hex string for the ledger version to use. (See Specifying Ledgers)
`ledger_index`	Number or String	(Optional) The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying Ledgers)
`peer`	String - Address	(Optional) A second account; if provided, filter results to trust lines connecting the two accounts.
`limit`	Number	(Optional) Limit the number of trust lines to retrieve. The server may return less than the specified limit, even if there are more pages of results. Must be within the inclusive range 10 to 400. Positive values outside this range are replaced with the closest valid option. The default is 200.
`marker`	Marker	(Optional) Value from a previous paginated response. Resume retrieving data where that response left off.

The following parameters are deprecated and may be removed without further notice: ledger and peer_index.

Response Format

An example of a successful response:

{
    "id": 1,
    "status": "success",
    "type": "response",
    "result": {
        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "lines": [
            {
                "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
                "balance": "0",
                "currency": "ASP",
                "limit": "0",
                "limit_peer": "10",
                "quality_in": 0,
                "quality_out": 0
            },
            {
                "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
                "balance": "0",
                "currency": "XAU",
                "limit": "0",
                "limit_peer": "0",
                "no_ripple": true,
                "no_ripple_peer": true,
                "quality_in": 0,
                "quality_out": 0
            },
            {
                "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
                "balance": "3.497605752725159",
                "currency": "USD",
                "limit": "5",
                "limit_peer": "0",
                "no_ripple": true,
                "quality_in": 0,
                "quality_out": 0
            }
        ]
    }
}

The response follows the standard format, with a successful result containing the address of the account and an array of trust line objects. Specifically, the result object contains the following fields:

`Field`	Type	Description
`account`	String	Unique Address of the account this request corresponds to. This is the "perspective account" for purpose of the trust lines.
`lines`	Array	Array of trust line objects, as described below. If the number of trust lines is large, only returns up to the `limit` at a time.
`ledger_current_index`	Integer - Ledger Index	(Omitted if `ledger_hash` or `ledger_index` provided) The ledger index of the current open ledger, which was used when retrieving this information.
`ledger_index`	Integer - Ledger Index	(Omitted if `ledger_current_index` provided instead) The ledger index of the ledger version that was used when retrieving this data.
`ledger_hash`	String - Hash	(May be omitted) The identifying hash the ledger version that was used when retrieving this data.
`marker`	Marker	Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one.

Each trust line object has some combination of the following fields:

`Field`	Type	Description
`account`	String	The unique Address of the counterparty to this trust line.
`balance`	String	Representation of the numeric balance currently held against this line. A positive balance means that the perspective account holds value; a negative balance means that the perspective account owes value.
`currency`	String	A Currency Code identifying what currency this trust line can hold.
`limit`	String	The maximum amount of the given currency that this account is willing to owe the peer account
`limit_peer`	String	The maximum amount of currency that the counterparty account is willing to owe the perspective account
`quality_in`	Unsigned Integer	Rate at which the account values incoming balances on this trust line, as a ratio of this value per 1 billion units. (For example, a value of 500 million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1 ratio.
`quality_out`	Unsigned Integer	Rate at which the account values outgoing balances on this trust line, as a ratio of this value per 1 billion units. (For example, a value of 500 million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1 ratio.
`no_ripple`	Boolean	(May be omitted) If `true`, this account has enabled the No Ripple flag for this trust line. If present and `false`, this account has disabled the No Ripple flag, but, because the account also has the Default Ripple flag disabled, that is not considered the default state. If omitted, the account has the No Ripple flag disabled for this trust line and Default Ripple enabled.
`no_ripple_peer`	Boolean	(May be omitted) If `true`, the peer account has enabled the No Ripple flag for this trust line. If present and `false`, this account has disabled the No Ripple flag, but, because the account also has the Default Ripple flag disabled, that is not considered the default state. If omitted, the account has the No Ripple flag disabled for this trust line and Default Ripple enabled.
`authorized`	Boolean	(May be omitted) If `true`, this account has authorized this trust line. The default is `false`.
`peer_authorized`	Boolean	(May be omitted) If `true`, the peer account has authorized this trust line. The default is `false`.
`freeze`	Boolean	(May be omitted) If `true`, this account has frozen this trust line. The default is `false`.
`freeze_peer`	Boolean	(May be omitted) If `true`, the peer account has frozen this trust line. The default is `false`.

Possible Errors

Any of the universal error types.
invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
actNotFound - The Address specified in the account field of the request does not correspond to an account in the ledger.
lgrNotFound - The ledger specified by the ledger_hash or ledger_index does not exist, or it does exist but the server does not have it.
actMalformed - If the marker field provided is not acceptable.