Get Account Settings

Get an account's settings. These are the settings that can be modified by the user. By default, this method returns data from the 'current' (in-progress) ledger, which may change before validation.

Warning: XRP-API is early alpha software. API methods and data formats are likely to change frequently in ways that break backwards compatibility.

Request Format

GET /accounts/{address}/settings

This API method uses the following path parameters:

Field Value Required? Description
address String (Address) Required The account to query.

This API method uses the following query parameters:

Field Value Required? Description
ledger_index (Varies) (LedgerIndex) Optional (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying Ledgers )

Response Formats

400 Bad Request

This error case indicates that the request was not properly formatted.

Media type: application/json

Formatted as a RippleAPIError

The response uses the following fields:

Field Type Required? Description
message String May be omitted A human-readable error message summarizing the problem(s) that occurred.
errors Array of ErrorItem May be omitted A list of errors that occurred when processing this request.

200 OK

A successful response contains the settings data for the requested account.

Media type: application/json

Formatted as a AccountSettings

The response uses the following fields:

Field Type Required? Description
regularKey String (Address) May be omitted The address of an XRP Ledger account.
passwordSpent Boolean May be omitted TODO
disableMasterKey Boolean May be omitted If the master key is disabled, true; false otherwise.

404 Not Found

Not found

Media type: application/json

Formatted as a RippleAPIError

The response uses the following fields:

Field Type Required? Description
message String May be omitted A human-readable error message summarizing the problem(s) that occurred.
errors Array of ErrorItem May be omitted A list of errors that occurred when processing this request.