Streamd API

• Creation and installation
• API Reference
• Transaction Reference

• WebSocket API uses the WebSocket protocol, which can be implemented by most browsers and JavaScript to achieve persistent two-way communication. There is not a 1:1 correlation between requests and responses. Some requests to the server will respond to multiple messages asynchronously; other times, responses may arrive in a different order than the request that submitted them. The streamd server can be configured to accept secure (wss://), insecure (ws://) WebSocket connections, or both.
• The JSON-RPC API relies on request-response communication over HTTP or HTTPs. (The streamd server can be configured to accept HTTP, HTTPS, or both.) For commands that prompt multiple responses, you can provide a callback URL.
• The streamd program can also be used as a fast command line client to send JSON-RPC requests to a running streamd server. This is designed for administrative purposes and is not a supported API.

WebSocket and JSON-RPC APIs are still under development and are subject to change.

• A malicious server can report that you received a payment when no payment was made.
• It can selectively show or hide payment paths and currency transactions, not providing you with the best deal to protect your own interests.
• If you send it your account secrets, it can conduct any transaction in your name, and even transfer or destroy all the money in your account balance.

Request format

• Place the command in the top-level "method" field
• Includes top-level "params" fields. The content of this field should be a single-item array containing only one nested JSON object containing all parameters of the command.

# [rpc_ip]:
#   IP address or domain to bind to allow insecure RPC connections.
#   Defaults to not allow RPC connections.
#
# [rpc_port]:
#   Port to bind to if allowing insecure RPC connections.
[rpc_ip]
127.0.0.1 
[rpc_port]
8088

streamd --rpc_ip=api.labs.streamd:5005 server_info

• WebSocket requests put the command name in the “command” field alongside the command parameters at the root of the JSON object. An optional “id” field is echoed in the response so that you can match responses to requests even when they arrive out of order.
• JSON-RPC requests put the command in the “method” field and the parameters in a separate object, as the first member of the “params” array. There is no “id” field because each response is returned directly to its request.
• The command line outputs commands after any formal command line selection, followed by a restricted set of parameters, separated by whitespace.

{
  "id": 2,
  "command": "account_info",
  "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "strict": true,
  "ledger_index": "validated"
}

POST http://s1.labs.stream:51234/
{
    "method": "account_info",
    "params": [
        {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "strict": true,
            "ledger_index": "validated"
        }
    ]
}

streamd account_info vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV validated true

{
  "id": 2,
  "status": "success",
  "type": "response",
  "result": {
    "account_data": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Balance": "27389517749",
      "Flags": 0,
      "LedgerEntryType": "AccountRoot",
      "OwnerCount": 18,
      "PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
      "PreviousTxnLgrSeq": 6592159,
      "Sequence": 1400,
      "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
    },
    "ledger_index": 6760970
  }
}

{
  "id": 2,
  "status": "success",
  "type": "response",
  "result": {
    "account_data": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Balance": "27389517749",
      "Flags": 0,
      "LedgerEntryType": "AccountRoot",
      "OwnerCount": 18,
      "PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
      "PreviousTxnLgrSeq": 6592159,
      "Sequence": 1400,
      "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
    },
    "ledger_index": 6760970
  }
}

{
    "result": {
        "account_data": {
            "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "Balance": "27389517749",
            "Flags": 0,
            "LedgerEntryType": "AccountRoot",
            "OwnerCount": 18,
            "PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
            "PreviousTxnLgrSeq": 6592159,
            "Sequence": 1400,
            "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
        },
        "ledger_index": 6761012,
        "status": "success"
    }
}

{
  "id": 3,
  "status": "error",
  "type": "response",
  "error": "ledgerIndexMalformed",
  "request": {
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "command": "account_info",
    "id": 3,
    "ledger_index": "-",
    "strict": true
  }
}

HTTP Status: 200 OK
{
    "result": {
        "error": "ledgerIndexMalformed",
        "request": {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "command": "account_info",
            "ledger_index": "-",
            "strict": true
        },
        "status": "error"
    }
}

{
    "result": {
        "error": "ledgerIndexMalformed",
        "request": {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "command": "account_info",
            "ledger_index": "-",
            "strict": true
        },
        "status": "error"
    }
}

WebSocket API error response format

JSON-RPC API Error Response Format

HTTP Status: 400 Bad Request
Null method

When your request results in an error, the entire request is logged in the background as a partial response so you can try to debug the error. However, this also includes any confidentiality included as part of the request. When sharing incorrect information, be very careful not to accidentally reveal important private account information to others.

• unknownCmd - The request does not contain a command recognized by the streamd server.
• jsonInvalid - (WebSocket only) The request was not a valid JSON object.
  • JSON-RPC returns a 400 Bad Request HTTP error in this case.
• missingCommand - (WebSocket only) The request did not specify a command field.
  • JSON-RPC returns a 400 Bad Request HTTP error in this case.
• tooBusy - The server is under heavy load and cannot execute this command at this time. If you connect to the server as an administrator, you will usually not be denied.
• noNetwork - The server cannot connect to the remaining radar networks (and cannot run in standalone mode).
• noCurrent - Due to high load, network issues, validator failure, misconfiguration, or other issues, the server does not know what the existing ledger is.
• noClosed - The server has no closed ledgers, primarily because it has not completed startup.
• wsTextRequired - (WebSocket only) The request's opcode is not text.

WebSocket and JSON-RPC APIs generally take the same parameters, albeit in different ways (see Request Formatting for details). Many similar parameters appear in the API, and there are some conventions for how to specify these parameters.

All field names are case-sensitive. In the response, fields obtained directly from the ledger node or transaction object start with an uppercase letter. Other fields, including some that continually dynamically generate responses, are lowercase.

Different types of objects are uniquely identified in different ways:

Accounts are distinguished by their respective addresses, such as "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59". The address starts with the letters r, and some streamd also accept hexadecimal address form.

Transactions are identified by the binary coded hash value of the transaction, and you can also identify them by the account and serial number sent by the transaction.

Each complete ledger has a ledger index and a unique hash value, which can be used to specify an instance of the ledger.

• The address length is between 25-35 characters
• Starts with the letters v
• Use English letters, excluding numbers 0, uppercase letters O, uppercase letters I, lowercase letters l
• Case sensitive
• Contains 4 bytes of checksum
• The number of valid addresses generated is close to 2^32

• Length of 64 characters
• Represented as hexadecimal: 0-9, A-F
• Usually represented in uppercase letters

A serial number is a 32-bit unsigned integer that identifies a transaction or offer relative to a specific account.

Each account in the Stream ledger has a serial number, starting from 1. For a transaction to be sent to the network or included to a validated ledger, it must have a sequence field that matches the current sequence of the sending account. The account's sequence field is incremented every time a transaction from that account is included in the verified ledger (regardless of whether the transaction succeeded or failed). This preserves the order of transactions for that account and distinguishes between two potentially identical transactions.

Each node in the Stream is tagged with the sending account address and sequence value of the OfferCreate transaction that created it. These two fields together provide a unique identifier.

• Because transactions are not fully propagated throughout the network, two different streamd servers may have accounts with the same sequence number but different contents.
• There may be multiple closed account versions competing for consensus. These accounts have the same serial number but different contents (different hashes). In the end, only one can be authenticated
• The contents of the existing ledger change over time, even if the sequence number is the same, this will cause the hash to change. Therefore, its hash cannot be calculated until the ledger is closed.

Many API methods require you to specify a ledger instance that includes the correct data to be retrieved and the latest data for a specific version of the shared ledger. Commands that accept a version of the ledger all work the same way. There are three ways you can specify the ledger:

1. Specify the ledger via the serial number in the ledger_index parameter. Each closed ledger has an identifiable sequence number that is one greater than the previous validated ledger. (The origin ledger sequence number is 0)
2. Specify the ledger via the hash value in the ledger_hash parameter.
3. Specify the ledger via one of the shortcuts in the ledger_index parameter:
   • validated : For most recent ledgers that have been verified by the entire network
   • closed : For most recent ledgers that have been modified and closed and raised by nodes for verification
   • current : For the version of the ledger that the node is currently running

There is also a deprecated ledger parameter that accepts the above three formats. Do not use this parameter, it may be removed without notification.

If you do not specify a ledger, the current (in progress) ledger will be selected by default. If you provide more than one specified ledger, the deprecated ledger field will be used first, if it still exists, falling back to ledger_hash. The ledger_index field is ignored unless neither of the other two are present.

Note: Do not rely on this default behavior; it changes frequently. Instead, you need to make a version of the ledger on every call.

The Stream ledger uses decimal arithmetic with a different precision than typical floating point numbers, so monetary amounts are always presented as strings

STM

Do not specify STM as an object

Non-STM

{
    "currency": "USD",
    "value": "153.75",
    "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
}

Specify currency without amount

There are two currency codes in the STM ledger:

• Three-character currency codes. Uppercase ISO 4217 currency codes are recommended. Any combination of uppercase and lowercase letters, digits, and these symbols is allowed: ?, !, @, #, $, %, ^, &, *, <, >, (, ), {, }, [, ], |. The uppercase currency code STM is reserved for STM and cannot be used for issued currencies.
• 160-bit hexadecimal value, according to the STM ledger's internal currency format, such as 0158415500000000C1F76FF6ECB0BAC600000000, which is an uncommon expression.

streamdThe server and its API represent times as unsigned integers. Measured as the number of seconds since January 1, 2000 (00:00 UTC). This works similarly to Unix epoch, except that the Stream Epoch after the Unix Epoch is 946684800 seconds.

Do not convert Stream Epoch times to UNIX Epoch times in 32-bit variables: this may cause integer overflow.

Depending on how the streamd server is configured, running time, and other factors, a server may participate in a multinational Stream peer-to-peer network to varying degrees. This is represented as the server_state field in responses to the server_info and server_state commands. This possible response tracks a series of ascending interactions, with each subsequent value replacing the previous one. They are defined as follows (in order of priority from small to large):

Note: The distinction between full, validating and proposing is based on synchronicity of the remaining global network, and it is normal for servers to fluctuate between these states during general operation.

• submit command
• submit_multisigned command

WebSocket and JSON-RPC API methods are defined based on command names and are divided into public commands and management commands. Public commands are not necessarily available to the general public, but can be used by any client connected to the server. (Think of public commands as the organization members or customers who run the server, while administrative commands are the people responsible for keeping the server running). Public commands include operations such as checking the status of the ledger, finding a path to connect users, and submitting transactions. Administrative commands, on the other hand, are intended only for trusted server operators and contain commands for managing, monitoring, and debugging the server.

• account_currencies - Get the list of currencies that the account can send or receive
• account_channels - Get the list of payment channels whose account is the source of the channel
• account_info - Get basic data about the account
• account_lines - Get information about account trust relationships
• account_objects - Get all ledger objects owned by an account
• account_offers - Get information about account currency exchange offers
• account_tx - Get information about account transactions
• book_offers - Get information about offers to exchange two currencies
• channel_authorize - Sign money claims from payment channels
• channel_verify - View the signature of the payment channel statement
• fee - Get information about transaction costs
• gateway_balances - Calculate the total amount issued by the account
• ledger - Get information about the ledger version
• ledger_closed - Get the latest closed ledger version
• ledger_current - Get the current working ledger version
• ledger_data - Get the original content of the ledger version
• ledger_entry - Get an element from the ledger version
• nostream_check - Get recommended changes to an account's DefaultStream and NoStream settings
• path_find - Find payment paths between two accounts and receive updates
• ping - Confirm connection to server
• random - Generate a random number
• stream_path_find - Find a payment path between two accounts, once
• server_info - Retrieve the status of the server in a human-readable format
• server_state - Retrieve the status of the server in a machine-readable format
• sign - Password signing transaction
• sign_for - helps with multi-signatures
• submit - Send transaction to the network
• submit_multisigned - Send a multi-signed transaction to the network
• subscribe - listen to updates about a specific subject
• transaction_entry - Retrieve information about a transaction from a specific ledger version
• tx - Retrieve information about transactions from all ledgers at hand
• tx_history - Retrieve information about all recent transactions
• unsubscribe - Stop listening to updates on a specific topic

• can_delete - allows online deletion of ledgers to a specific ledger
• connect - Force the streamd server to connect to a specific peer
• consensus_info - Get information about the consensus status
• feature - Get information about protocol revisions
• fetch_info - Get information about server and network synchronization
• get_counts - Get statistics about server internal and memory usage
• ledger_accept - Close and advance the ledger in standalone mode
• ledger_cleaner - Configure the ledger clearing service to check for corrupted data
• ledger_request - Query a peer for a specific ledger version
• log_level - Get or modify log verbosity
• logrotate - Reopen the log file
• peers - Get information about connected peers
• print - Get information about internal subsystems
• stop - Shut down the streamd server
• validation_create - Generate keys for new streamd validators
• validation_seed - Temporarily sets the key used for verification
• validators - Get information about the current validator
• validator_list_sites - Get information about sites that publish validator lists
• wallet_propose - Generate keys for new accounts

• ledger_header - Use the ledger command instead.
• unl_add, unl_delete, unl_list, unl_load, unl_network, unl_reset, unl_score - Use UNL management configuration files instead.
• wallet_seed- - Use wallet_propose instead.

• json - Passing JSON via the command line

Note: The command line interface is for administrative purposes only and is not a supported API.

The "accounts" in the Stream ledger represent STM holders and transaction senders. Accounts can send and receive STM and issued assets, participate in decentralized exchanges, and change their own settings. Creating an account involves generating a key and then receiving STM from another account. See Accounts for more information.

{
    "command": "account_currencies",
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "strict": true,
    "ledger_index": "validated"
}

{
    "method": "account_currencies",
    "params": [
        {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "account_index": 0,
            "ledger_index": "validated",
            "strict": true
        }
    ]
}

{
    "result": {
        "ledger_index": 155786,
        "receive_currencies": [
            "BTC",
            "CNY",
            "ETH"
        ],
        "send_currencies": [
            "CNY"
        ],
        "validated": true
    },
    "status": "success",
    "type": "response"
}

200 OK
{
    "result": {
        "ledger_index": 155786,
        "receive_currencies": [
            "BTC",
            "CNY",
            "ETH"
        ],
        "send_currencies": [
            "CNY"
        ],
        "status": "success",
        "validated": true
    }
}

Note: The currencies an account can send or receive are defined based on a check of its trust lines. If an account has a trust line for a currency and has enough room to increase the balance, it can receive that currency. If the trustline's balance can be reduced, the account can send the currency. This method does not check whether the trust row is frozen or authorized

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• actNotFound- The address specified in the account request field does not correspond to an account in the ledger.
• lgrNotFound - The ledger specified by ledger_hash or ledger_index does not exist, or it does exist, but the server does not.

{
  "id": 2,
  "command": "account_info",
  "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "strict": true,
  "ledger_index": "current",
  "queue": true
}

{
    "method": "account_info",
    "params": [
        {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "strict": true,
            "ledger_index": "current",
            "queue": true
        }
    ]
}

#Syntax: account_info account [ledger_index|ledger_hash] [strict]
rippled account_info vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV true

{
  "id": 2,
  "result": {
    "account_data": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Balance": "99999986730672448",
      "Flags": 0,
      "LedgerEntryType": "AccountRoot",
      "OwnerCount": 15,
      "PreviousTxnID": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
      "PreviousTxnLgrSeq": 155512,
      "Sequence": 293,
      "index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037"
    },
    "ledger_current_index": 155823,
    "validated": false
  },
  "status": "success",
  "type": "response"
}

{
  "result": {
    "account_data": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Balance": "99999986730672448",
      "Flags": 0,
      "LedgerEntryType": "AccountRoot",
      "OwnerCount": 15,
      "PreviousTxnID": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
      "PreviousTxnLgrSeq": 155512,
      "Sequence": 293,
      "index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037"
    },
    "ledger_current_index": 155823,
    "validated": false
  },
  "status": "success",
  "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing. For example, a request that specifies queue as true but ledger_index is not specified for the current open ledger.
• actNotFound- The address specified in the account request field does not correspond to an account in the ledger.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.

{
  "id": 1,
  "command": "account_lines",
  "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "ledger": "current"
}

{
    "method": "account_lines",
    "params": [
        {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "ledger": "current"
        }
    ]
}

{
  "id": 1,
  "result": {
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "ledger_current_index": 155833,
    "lines": [{
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "999857.44805",
      "currency": "CNY",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "0",
      "currency": "STM",
      "limit": "0",
      "limit_peer": "0",
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "0",
      "currency": "XCN",
      "limit": "0",
      "limit_peer": "0",
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i",
      "balance": "0",
      "currency": "BTC",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "no_vstream_peer": true,
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i",
      "balance": "0",
      "currency": "ETH",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "0",
      "currency": "BTC",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "quality_in": 0,
      "quality_out": 0
    }],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "ledger_current_index": 155833,
    "lines": [{
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "999857.44805",
      "currency": "CNY",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "0",
      "currency": "XRP",
      "limit": "0",
      "limit_peer": "0",
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "0",
      "currency": "XCN",
      "limit": "0",
      "limit_peer": "0",
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i",
      "balance": "0",
      "currency": "BTC",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "no_vstream_peer": true,
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i",
      "balance": "0",
      "currency": "ETH",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "quality_in": 0,
      "quality_out": 0
    }, {
      "account": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
      "balance": "0",
      "currency": "BTC",
      "limit": "1000000000000000e-4",
      "limit_peer": "0",
      "no_vstream": true,
      "quality_in": 0,
      "quality_out": 0
    }],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• actNotFound - The address account specified in the request field does not correspond to an account in the ledger.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.
• actMalformed - If the field provided by marker is not acceptable.

{
  "id": 2,
  "command": "account_offers",
  "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "ledger": "current"
}

{
    "method": "account_offers",
    "params": [
        {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "ledger_index": "current"
        }
    ]
}

#Syntax: account_offers account [ledger_index]
rippled account_offers vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV current

{
  "id": 2,
  "result": {
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "ledger_current_index": 155935,
    "offers": [{
      "flags": 0,
      "seq": 234,
      "taker_gets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1"
      },
      "taker_pays": "1000000"
    }, {
      "flags": 0,
      "seq": 239,
      "taker_gets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "0.00195"
      },
      "taker_pays": "1950000"
    }, {
      "flags": 0,
      "seq": 275,
      "taker_gets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1.85"
      },
      "taker_pays": "1000000"
    }],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "ledger_current_index": 155935,
    "offers": [{
      "flags": 0,
      "seq": 234,
      "taker_gets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1"
      },
      "taker_pays": "1000000"
    }, {
      "flags": 0,
      "seq": 239,
      "taker_gets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "0.00195"
      },
      "taker_pays": "1950000"
    }, {
      "flags": 0,
      "seq": 275,
      "taker_gets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1.85"
      },
      "taker_pays": "1000000"
    }],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• actNotFound - The address account specified in the request field does not correspond to an account in the ledger.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.
• actMalformed - If the field provided by marker is not acceptable.

{
  "id": 2,
  "command": "account_tx",
  "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "ledger_index_min": -1,
  "ledger_index_max": -1,
  "binary": false,
  "limit": 2,
  "forward": false
}

{
    "method": "account_tx",
    "params": [
        {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "binary": false,
            "forward": false,
            "ledger_index_max": -1,
            "ledger_index_min": -1,
            "limit": 2
        }
    ]
}

#Syntax account_tx account ledger_index_min ledger_index_max [offset] [limit] [binary] [count] [forward]
rippled -- account_tx vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV -1 -1 2 5 1 0 1

Note: For WebSocket and JSON-RPC, there is an older, deprecated version of the account_tx method. For this reason, Stream recommends not using any of the following fields: offset, count, descending, ledger_max, and ledger_min. If you use any of these deprecated fields, this method does not support pagination.

Repeat query data

{
  "id": 2,
  "result": {
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "ledger_index_max": 155983,
    "ledger_index_min": 2,
    "limit": 2,
    "marker": {
      "ledger": 153500,
      "seq": 0
    },
    "transactions": [{
      "meta": {
        "AffectedNodes": [{
          "ModifiedNode": {
            "FinalFields": {
              "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
              "Balance": "21492361",
              "Flags": 8388608,
              "OwnerCount": 14,
              "Sequence": 78
            },
            "LedgerEntryType": "AccountRoot",
            "LedgerIndex": "ADEFE0B5A676E5431444ADA797634C65B963A00B9B79DBFA4821DA786DD6C8B4",
            "PreviousFields": {
              "Balance": "22492373",
              "Sequence": 77
            },
            "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
            "PreviousTxnLgrSeq": 153524
          }
        }, {
          "ModifiedNode": {
            "FinalFields": {
              "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
              "Balance": "99999986730672448",
              "Flags": 0,
              "OwnerCount": 15,
              "Sequence": 293
            },
            "LedgerEntryType": "AccountRoot",
            "LedgerIndex": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
            "PreviousFields": {
              "Balance": "99999986729672448"
            },
            "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
            "PreviousTxnLgrSeq": 153524
          }
        }],
        "TransactionIndex": 0,
        "TransactionResult": "tesSUCCESS",
        "delivered_amount": "1000000"
      },
      "tx": {
        "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
        "Amount": "1000000",
        "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "Fee": "12",
        "Flags": 2147483648,
        "LastLedgerSequence": 155520,
        "Memos": [{
          "Memo": {
            "MemoData": "68616861",
            "MemoType": "6D656D6F"
          }
        }],
        "Sequence": 77,
        "SigningPubKey": "021ADD58CB32BFD8F3F24A027081CE3928CEE072E85692123DE4DF92EFCF2CE2BC",
        "TransactionType": "Payment",
        "TxnSignature": "304402200C8B73E45DD5C43D6C10ECF26BE1D0212BA121BC0EB090441B09AE21FAD2F17C02206143819F8B15F4C8C83A4735E56E971E7465A76C2116443092E8E7179B4A7AFD",
        "date": 575694990,
        "hash": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
        "inLedger": 155512,
        "ledger_index": 155512
      },
      "validated": true
    }]
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "ledger_index_max": 155983,
    "ledger_index_min": 2,
    "limit": 2,
    "marker": {
      "ledger": 153500,
      "seq": 0
    },
    "transactions": [{
      "meta": {
        "AffectedNodes": [{
          "ModifiedNode": {
            "FinalFields": {
              "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
              "Balance": "21492361",
              "Flags": 8388608,
              "OwnerCount": 14,
              "Sequence": 78
            },
            "LedgerEntryType": "AccountRoot",
            "LedgerIndex": "ADEFE0B5A676E5431444ADA797634C65B963A00B9B79DBFA4821DA786DD6C8B4",
            "PreviousFields": {
              "Balance": "22492373",
              "Sequence": 77
            },
            "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
            "PreviousTxnLgrSeq": 153524
          }
        }, {
          "ModifiedNode": {
            "FinalFields": {
              "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
              "Balance": "99999986730672448",
              "Flags": 0,
              "OwnerCount": 15,
              "Sequence": 293
            },
            "LedgerEntryType": "AccountRoot",
            "LedgerIndex": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
            "PreviousFields": {
              "Balance": "99999986729672448"
            },
            "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
            "PreviousTxnLgrSeq": 153524
          }
        }],
        "TransactionIndex": 0,
        "TransactionResult": "tesSUCCESS",
        "delivered_amount": "1000000"
      },
      "tx": {
        "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
        "Amount": "1000000",
        "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "Fee": "12",
        "Flags": 2147483648,
        "LastLedgerSequence": 155520,
        "Memos": [{
          "Memo": {
            "MemoData": "68616861",
            "MemoType": "6D656D6F"
          }
        }],
        "Sequence": 77,
        "SigningPubKey": "021ADD58CB32BFD8F3F24A027081CE3928CEE072E85692123DE4DF92EFCF2CE2BC",
        "TransactionType": "Payment",
        "TxnSignature": "304402200C8B73E45DD5C43D6C10ECF26BE1D0212BA121BC0EB090441B09AE21FAD2F17C02206143819F8B15F4C8C83A4735E56E971E7465A76C2116443092E8E7179B4A7AFD",
        "date": 575694990,
        "hash": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
        "inLedger": 155512,
        "ledger_index": 155512
      },
      "validated": true
    }]
  },
  "status": "success",
  "type": "response"
}

Note: The server may respond with different values than provided for ledger_index_min and ledger_index_max, for example, if it does not have the version you specified on hand.

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• actMalformed - The address account specified in the request field is not in the correct format.
• actBitcoin - The address account specified in this field is formatted as a Bitcoin address, not an STM ledger address.
• lgrIdxsInvalid - A ledger specified by ledger_index_min or ledger_index_max that does not exist, or exists but does not exist on the server.

{
    "id": 0,
    "command": "novstream_check",
    "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "role": "gateway",
    "ledger_index": "current",
    "limit": 2,
    "transactions": true
}

{
    "method": "novstream_check",
    "params": [
        {
            "account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "ledger_index": "current",
            "limit": 2,
            "role": "gateway",
            "transactions": true
        }
    ]
}

Note: There is no command line syntax for this method. Use the json command to access this command from the command line.

{
  "id": 0,
  "result": {
    "ledger_current_index": 169518,
    "problems": ["You should immediately set your default vstream flag", "You should clear the no vstream flag on your CNY line to vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz", "You should clear the no vstream flag on your BTC line to vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz", "You should clear the no vstream flag on your BTC line to vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i"],
    "transactions": [{
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": 10,
      "Sequence": 335,
      "SetFlag": 8,
      "TransactionType": "AccountSet"
    }, {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": 10,
      "Flags": 262144,
      "LimitAmount": {
        "currency": "BTC",
        "issuer": "vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i",
        "value": "1000000000000000e-4"
      },
      "Sequence": 338,
      "TransactionType": "TrustSet"
    }],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

{
  "id": 0,
  "result": {
    "ledger_current_index": 169518,
    "problems": ["You should immediately set your default vstream flag", "You should clear the no vstream flag on your CNY line to vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz", "You should clear the no vstream flag on your BTC line to vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz", "You should clear the no vstream flag on your BTC line to vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i"],
    "transactions": [{
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": 10,
      "Sequence": 335,
      "SetFlag": 8,
      "TransactionType": "AccountSet"
    }, {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": 10,
      "Flags": 262144,
      "LimitAmount": {
        "currency": "BTC",
        "issuer": "vp9Ykz8Af9bYV6zpjxRiza2oeim8xmiu7i",
        "value": "1000000000000000e-4"
      },
      "Sequence": 338,
      "TransactionType": "TrustSet"
    }],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• actNotFound - The address account specified in the request field does not correspond to an account in the ledger.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.

{
    "command": "wallet_propose",
    "passphrase": "test"
}

{
    "method": "wallet_propose",
    "params": [
        {
            "passphrase": "test"
        }
    ]
}

#Syntax: wallet_propose [passphrase]
streamd -- wallet_propose test

{
   "result" : {
      "account_id" : "vp2YHP5k3bSd6LRFT4phDjVMLXQjH4hiaG",
      "master_key" : "AHOY CLAD JUDD NOON MINI CHAD CUBA JAN KANT AMID DEL LETS",
      "master_seed" : "ssyXjRurNo75TjXjubby65cD96ak8",
      "master_seed_hex" : "5BDD10A694F2E36CCAC0CBE28CE2AC49",
      "public_key" : "aBPXjfsA7fY2LLPxRuZ7Sj2ADzoSEGDW4Atd5MgxdHz5FQvGPbqU",
      "public_key_hex" : "02CF23BCB1252D153713954AF374F44F82C255170ECAEDB059783128F53288F34F",
      "status" : "success"
   }
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly.
• badSeed - A forbidden seed value specified by this request (in the passphrase, seed or seed_hex field), such as an empty string, or a string similar to an STM ledger address.

Each streamd server maintains a complete copy of the current state of the STM ledger, containing all accounts, transactions, offers and other data in the network in an optimized tree format. As transactions and offers are proposed, each server integrates them into its current copy of the ledger, periodically closes it, and (if configured) participates in advancing the globally validated version. After the network reaches consensus, this version of the ledger is verified and made permanent. Any transactions not included in one version of the ledger will become candidates for inclusion in the next validated version.

{
    "id": 14,
    "command": "ledger",
    "ledger_index": "validated",
    "full": false,
    "accounts": false,
    "transactions": false,
    "expand": false,
    "owner_funds": false
}

{
    "method": "ledger",
    "params": [
        {
            "ledger_index": "validated",
            "accounts": false,
            "full": false,
            "transactions": false,
            "expand": false,
            "owner_funds": false
        }
    ]
}

#Syntax: ledger ledger_index|ledger_hash [full|tx]
# "full" is equivalent to "full": true
# "tx" is equivalent to "transactions": true
streamd ledger current

{
  "id": 14,
  "result": {
    "ledger": {
      "accepted": true,
      "account_hash": "C3FED0CFCF26EF342D1213435258C9EB3098620FC2096DFFA1244B333386E64E",
      "close_time": 575706870,
      "close_time_human": "2018-Mar-30 06:34:30",
      "close_time_resolution": 10,
      "closed": true,
      "hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
      "ledger_hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
      "ledger_index": "156118",
      "parent_hash": "DEEC565070B7689FC64F6B64DEAD224DCFF037E8A85D8C237627C6460B3EB95B",
      "seqNum": "156118",
      "totalCoins": "99999999999992838",
      "total_coins": "99999999999992838",
      "transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
    },
    "ledger_index": 156118,
    "validated": true
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "ledger": {
      "accepted": true,
      "account_hash": "C3FED0CFCF26EF342D1213435258C9EB3098620FC2096DFFA1244B333386E64E",
      "close_time": 575706870,
      "close_time_human": "2018-Mar-30 06:34:30",
      "close_time_resolution": 10,
      "closed": true,
      "hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
      "ledger_hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
      "ledger_index": "156118",
      "parent_hash": "DEEC565070B7689FC64F6B64DEAD224DCFF037E8A85D8C237627C6460B3EB95B",
      "seqNum": "156118",
      "totalCoins": "99999999999992838",
      "total_coins": "99999999999992838",
      "transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
    },
    "ledger_index": 156118,
    "validated": true
  },
  "status": "success",
  "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.
• noPermission - If you specify full or accounts as true, but are not connected to the server as an administrator (usually, admin needs to connect to the local port).

{
   "id": 2,
   "command": "ledger_closed"
}

{
    "method": "ledger_closed",
    "params": [
        {}
    ]
}

#Syntax: ledger_closed
streamd ledger_closed

{
  "id": 2,
  "result": {
    "ledger_hash": "D771E2D1A624BBD3FA26827C48F3B6BD5B33E1C642E0982B239D4928E967E25A",
    "ledger_index": 156173
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "ledger_hash": "D771E2D1A624BBD3FA26827C48F3B6BD5B33E1C642E0982B239D4928E967E25A",
    "ledger_index": 156173
  },
  "status": "success",
  "type": "response"
}

• Any common error type.

The ledger_current method returns the unique identifier of the currently ongoing ledger. This command is useful for testing because the returned ledger is still changing.

Example of request format:

{
   "id": 2,
   "command": "ledger_current"
}

{
    "method": "ledger_current",
    "params": [
        {}
    ]
}

#Syntax: ledger_current
streamd ledger_current

The request does not contain parameters.

An example of a successful response:

{
  "id": 2,
  "result": {
    "ledger_current_index": 156196
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "ledger_current_index": 156196
    "status": "success",
  }
}

Responses follow the standard format, with successful results containing the following fields:

Possible errors:

• Any common error type.

{
   "id": 2,
   "ledger_hash": "D771E2D1A624BBD3FA26827C48F3B6BD5B33E1C642E0982B239D4928E967E25A",
   "command": "ledger_data",
   "limit": 5,
   "binary": true
}

{
    "method": "ledger_data",
    "params": [
        {
            "binary": true,
            "ledger_hash": "D771E2D1A624BBD3FA26827C48F3B6BD5B33E1C642E0982B239D4928E967E25A",
            "limit": 5
        }
    ]
}

Note: There is no command line syntax for ledger_data. You can access this method from the command line using the json command.

{
  "id": 2,
  "result": {
    "ledger_hash": "D771E2D1A624BBD3FA26827C48F3B6BD5B33E1C642E0982B239D4928E967E25A",
    "ledger_index": "156173",
    "marker": "1E58E0D2E99FFE7EF7C2B98EE63998F845860CF2A58EAE711C12A894A1205A63",
    "state": [{
      "data": "11006F2200000000240000000B250000015133000000000000000034000000000000000055E8146BAA479266D61727383AAF3A7EBA3061B917F08C61BFA82B2C551CAF94355010AFE8D4AF92CB0CBD5051A499BA555711BA23DFD44FACDE675A17AF4C4A80AAAB6440000000000F424065D485543DF729C000000000000000000000000000434E590000000000C3B914002ED6944382B78F183DD6613F0E5CC5FD8114F2D333C71B380B69EDEB68751F7AAD5EE3350E8C",
      "index": "0027D7CCB2CF1E7A8A15A7F255F459BB0B1B42CD2908929C23E948D73966ABC2"
    }, {
      "data": "11006F22000200002400000011250000123A33000000000000000034000000000000000055FA09A55BB3DA539D72B12D3D359C51901F8467F9C97A113E4AAE54D7A546A50750108F8858298670F04B0D754DDD47BAF18BCDDC13409AF229994F1550F7DCA7000064D4CA71EA17A3C000000000000000000000000000434E590000000000C3B914002ED6944382B78F183DD6613F0E5CC5FD6540000000004AC4A08114F2D333C71B380B69EDEB68751F7AAD5EE3350E8C",
      "index": "01985A028B3C15B0CD5D0D5B60F2558043F56FFC4CA04B2177CBBFDF2215D22C"
    }, {
      "data": "1100642200000000581150F3BF4E6D62FAAD62B4D65887E58BA3607C7871238F49B84ED7A30C2EB49E82148B17262A312E4FF5BE1138A85301428C74628BB80113C21F5F400136752D1233FCD9812C4F10D2FCACCE4BCD3398C223F74CFAB010381DA5BE6436A2A7A04FCC55D92AAD60CF3E071B8F13C1D774E219750CFC03207C67DDC9FD121609956EB68CCDF0B4289C763685FB8A3FA9547817E97E92928D5E679FCE3C3F9D3C2889918CB3DCDF310F5B9FCA974BD60D6D5EEB0A3C3D3537CBE8E980C47F489D3CA16E08921B1FE1B20A9A539E233647D82A24A5CAA933931870599E86525727BC6E65DF438FBAF5A39DC30219C91D5AEBB7F70E9B9BDEC3C4BEDBF68A044A7A482962DDF6D960E8C573B95D016433550944DE2ED51E00F41A27E4290774398E42ABB509F49B87B29E5E02505C44437495B816B06BCB6DDEFAFC5BA1323B98B9F0813AF51F525B5C96D7A8179894DD9AD4E9810A5D6023BCD72B3F207649244430791157BD5F29CE9E5B5716D7B83DA9C99B8E5C756BCE430B6CF8BE6F90427EB2EC9131C8A571BA94200A3770C9D26C5403C8C1E19923F8CD02F91FC56E10E6B5170A3EDE8AB39A201597EB0956F310FF0A0F32F4130FB708445AD0483C67C59FE5B1DF6E74A8B270556CDF991503A1F915EA64BB4A48AD87243669CC9CB2F2C658FB816B63C501E346EBAD252E15DFFE136A96882961C1356F6187424C87825150C9AE89E67CC751283DA7ABC6C74E3254E44DE414EB4CB416DF",
      "index": "1150F3BF4E6D62FAAD62B4D65887E58BA3607C7871238F49B84ED7A30C2EB49E"
    }, {
      "data": "1100642200000000581325AE6430D47924A0E9389AC91A7D1125B1AF64A0D729E790BD4BB6DDEFC072821415B8498C737803B6C6D57F0F5F085C8746AF154B011340B84627D80CFDCF5C9721417038617F7A174E0081C69E402490A73AA5A5070CB456D1739F8B693C93D3E4EC9788D1D6492ED5B841360F2DCC625A3EA47C04ABC9",
      "index": "1325AE6430D47924A0E9389AC91A7D1125B1AF64A0D729E790BD4BB6DDEFC072"
    }, {
      "data": "11006F2200000000240000000625000001483300000000000000003400000000000000005597674188B06F3ED44BA2F34180E0B538579504647796E00D8DD5F865D85F0EBB5010AFE8D4AF92CB0CBD5051A499BA555711BA23DFD44FACDE675B038D7EA4C6800064400000000098968065D4C38D7EA4C68000000000000000000000000000434E590000000000C3B914002ED6944382B78F183DD6613F0E5CC5FD8114F2D333C71B380B69EDEB68751F7AAD5EE3350E8C",
      "index": "159769461D9A3B758F9315780270886EA863E21F3677997F319EB58E1F71174A"
    }],
    "validated": true
  },
  "status": "success",
  "type": "response"
}

{
  "id": 2,
  "result": {
    "ledger_hash": "D771E2D1A624BBD3FA26827C48F3B6BD5B33E1C642E0982B239D4928E967E25A",
    "ledger_index": "156173",
    "marker": "1E58E0D2E99FFE7EF7C2B98EE63998F845860CF2A58EAE711C12A894A1205A63",
    "state": [{
      "Account": "vP3AYvkqCZTP3oh9b9zDzVqgf9odzhFCcC",
      "BookDirectory": "AFE8D4AF92CB0CBD5051A499BA555711BA23DFD44FACDE675A17AF4C4A80AAAB",
      "BookNode": "0000000000000000",
      "Flags": 0,
      "LedgerEntryType": "Offer",
      "OwnerNode": "0000000000000000",
      "PreviousTxnID": "E8146BAA479266D61727383AAF3A7EBA3061B917F08C61BFA82B2C551CAF9435",
      "PreviousTxnLgrSeq": 337,
      "Sequence": 11,
      "TakerGets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1.5"
      },
      "TakerPays": "1000000",
      "index": "0027D7CCB2CF1E7A8A15A7F255F459BB0B1B42CD2908929C23E948D73966ABC2"
    }, {
      "Account": "vP3AYvkqCZTP3oh9b9zDzVqgf9odzhFCcC",
      "BookDirectory": "8F8858298670F04B0D754DDD47BAF18BCDDC13409AF229994F1550F7DCA70000",
      "BookNode": "0000000000000000",
      "Flags": 131072,
      "LedgerEntryType": "Offer",
      "OwnerNode": "0000000000000000",
      "PreviousTxnID": "FA09A55BB3DA539D72B12D3D359C51901F8467F9C97A113E4AAE54D7A546A507",
      "PreviousTxnLgrSeq": 4666,
      "Sequence": 17,
      "TakerGets": "4900000",
      "TakerPays": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "29.4"
      },
      "index": "01985A028B3C15B0CD5D0D5B60F2558043F56FFC4CA04B2177CBBFDF2215D22C"
    }, {
      "Flags": 0,
      "Indexes": ["5F400136752D1233FCD9812C4F10D2FCACCE4BCD3398C223F74CFAB010381DA5", "BE6436A2A7A04FCC55D92AAD60CF3E071B8F13C1D774E219750CFC03207C67DD", "C9FD121609956EB68CCDF0B4289C763685FB8A3FA9547817E97E92928D5E679F", "CE3C3F9D3C2889918CB3DCDF310F5B9FCA974BD60D6D5EEB0A3C3D3537CBE8E9", "80C47F489D3CA16E08921B1FE1B20A9A539E233647D82A24A5CAA93393187059", "9E86525727BC6E65DF438FBAF5A39DC30219C91D5AEBB7F70E9B9BDEC3C4BEDB", "F68A044A7A482962DDF6D960E8C573B95D016433550944DE2ED51E00F41A27E4", "290774398E42ABB509F49B87B29E5E02505C44437495B816B06BCB6DDEFAFC5B", "A1323B98B9F0813AF51F525B5C96D7A8179894DD9AD4E9810A5D6023BCD72B3F", "207649244430791157BD5F29CE9E5B5716D7B83DA9C99B8E5C756BCE430B6CF8", "BE6F90427EB2EC9131C8A571BA94200A3770C9D26C5403C8C1E19923F8CD02F9", "1FC56E10E6B5170A3EDE8AB39A201597EB0956F310FF0A0F32F4130FB708445A", "D0483C67C59FE5B1DF6E74A8B270556CDF991503A1F915EA64BB4A48AD872436", "69CC9CB2F2C658FB816B63C501E346EBAD252E15DFFE136A96882961C1356F61", "87424C87825150C9AE89E67CC751283DA7ABC6C74E3254E44DE414EB4CB416DF"],
      "LedgerEntryType": "DirectoryNode",
      "Owner": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "RootIndex": "1150F3BF4E6D62FAAD62B4D65887E58BA3607C7871238F49B84ED7A30C2EB49E",
      "index": "1150F3BF4E6D62FAAD62B4D65887E58BA3607C7871238F49B84ED7A30C2EB49E"
    }, {
      "Flags": 0,
      "Indexes": ["B84627D80CFDCF5C9721417038617F7A174E0081C69E402490A73AA5A5070CB4", "56D1739F8B693C93D3E4EC9788D1D6492ED5B841360F2DCC625A3EA47C04ABC9"],
      "LedgerEntryType": "DirectoryNode",
      "Owner": "vpyqxXzyoX62Bs6WRckYuUoVQjiGaBvCwB",
      "RootIndex": "1325AE6430D47924A0E9389AC91A7D1125B1AF64A0D729E790BD4BB6DDEFC072",
      "index": "1325AE6430D47924A0E9389AC91A7D1125B1AF64A0D729E790BD4BB6DDEFC072"
    }, {
      "Account": "vP3AYvkqCZTP3oh9b9zDzVqgf9odzhFCcC",
      "BookDirectory": "AFE8D4AF92CB0CBD5051A499BA555711BA23DFD44FACDE675B038D7EA4C68000",
      "BookNode": "0000000000000000",
      "Flags": 0,
      "LedgerEntryType": "Offer",
      "OwnerNode": "0000000000000000",
      "PreviousTxnID": "97674188B06F3ED44BA2F34180E0B538579504647796E00D8DD5F865D85F0EBB",
      "PreviousTxnLgrSeq": 328,
      "Sequence": 6,
      "TakerGets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "10"
      },
      "TakerPays": "10000000",
      "index": "159769461D9A3B758F9315780270886EA863E21F3677997F319EB58E1F71174A"
    }],
    "validated": true
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "ledger_hash": "D771E2D1A624BBD3FA26827C48F3B6BD5B33E1C642E0982B239D4928E967E25A",
    "ledger_index": "156173",
    "marker": "1E58E0D2E99FFE7EF7C2B98EE63998F845860CF2A58EAE711C12A894A1205A63",
    "state": [{
      "Account": "vP3AYvkqCZTP3oh9b9zDzVqgf9odzhFCcC",
      "BookDirectory": "AFE8D4AF92CB0CBD5051A499BA555711BA23DFD44FACDE675A17AF4C4A80AAAB",
      "BookNode": "0000000000000000",
      "Flags": 0,
      "LedgerEntryType": "Offer",
      "OwnerNode": "0000000000000000",
      "PreviousTxnID": "E8146BAA479266D61727383AAF3A7EBA3061B917F08C61BFA82B2C551CAF9435",
      "PreviousTxnLgrSeq": 337,
      "Sequence": 11,
      "TakerGets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1.5"
      },
      "TakerPays": "1000000",
      "index": "0027D7CCB2CF1E7A8A15A7F255F459BB0B1B42CD2908929C23E948D73966ABC2"
    }, {
      "Account": "vP3AYvkqCZTP3oh9b9zDzVqgf9odzhFCcC",
      "BookDirectory": "8F8858298670F04B0D754DDD47BAF18BCDDC13409AF229994F1550F7DCA70000",
      "BookNode": "0000000000000000",
      "Flags": 131072,
      "LedgerEntryType": "Offer",
      "OwnerNode": "0000000000000000",
      "PreviousTxnID": "FA09A55BB3DA539D72B12D3D359C51901F8467F9C97A113E4AAE54D7A546A507",
      "PreviousTxnLgrSeq": 4666,
      "Sequence": 17,
      "TakerGets": "4900000",
      "TakerPays": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "29.4"
      },
      "index": "01985A028B3C15B0CD5D0D5B60F2558043F56FFC4CA04B2177CBBFDF2215D22C"
    }, {
      "Flags": 0,
      "Indexes": ["5F400136752D1233FCD9812C4F10D2FCACCE4BCD3398C223F74CFAB010381DA5", "BE6436A2A7A04FCC55D92AAD60CF3E071B8F13C1D774E219750CFC03207C67DD", "C9FD121609956EB68CCDF0B4289C763685FB8A3FA9547817E97E92928D5E679F", "CE3C3F9D3C2889918CB3DCDF310F5B9FCA974BD60D6D5EEB0A3C3D3537CBE8E9", "80C47F489D3CA16E08921B1FE1B20A9A539E233647D82A24A5CAA93393187059", "9E86525727BC6E65DF438FBAF5A39DC30219C91D5AEBB7F70E9B9BDEC3C4BEDB", "F68A044A7A482962DDF6D960E8C573B95D016433550944DE2ED51E00F41A27E4", "290774398E42ABB509F49B87B29E5E02505C44437495B816B06BCB6DDEFAFC5B", "A1323B98B9F0813AF51F525B5C96D7A8179894DD9AD4E9810A5D6023BCD72B3F", "207649244430791157BD5F29CE9E5B5716D7B83DA9C99B8E5C756BCE430B6CF8", "BE6F90427EB2EC9131C8A571BA94200A3770C9D26C5403C8C1E19923F8CD02F9", "1FC56E10E6B5170A3EDE8AB39A201597EB0956F310FF0A0F32F4130FB708445A", "D0483C67C59FE5B1DF6E74A8B270556CDF991503A1F915EA64BB4A48AD872436", "69CC9CB2F2C658FB816B63C501E346EBAD252E15DFFE136A96882961C1356F61", "87424C87825150C9AE89E67CC751283DA7ABC6C74E3254E44DE414EB4CB416DF"],
      "LedgerEntryType": "DirectoryNode",
      "Owner": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "RootIndex": "1150F3BF4E6D62FAAD62B4D65887E58BA3607C7871238F49B84ED7A30C2EB49E",
      "index": "1150F3BF4E6D62FAAD62B4D65887E58BA3607C7871238F49B84ED7A30C2EB49E"
    }, {
      "Flags": 0,
      "Indexes": ["B84627D80CFDCF5C9721417038617F7A174E0081C69E402490A73AA5A5070CB4", "56D1739F8B693C93D3E4EC9788D1D6492ED5B841360F2DCC625A3EA47C04ABC9"],
      "LedgerEntryType": "DirectoryNode",
      "Owner": "vpyqxXzyoX62Bs6WRckYuUoVQjiGaBvCwB",
      "RootIndex": "1325AE6430D47924A0E9389AC91A7D1125B1AF64A0D729E790BD4BB6DDEFC072",
      "index": "1325AE6430D47924A0E9389AC91A7D1125B1AF64A0D729E790BD4BB6DDEFC072"
    }, {
      "Account": "vP3AYvkqCZTP3oh9b9zDzVqgf9odzhFCcC",
      "BookDirectory": "AFE8D4AF92CB0CBD5051A499BA555711BA23DFD44FACDE675B038D7EA4C68000",
      "BookNode": "0000000000000000",
      "Flags": 0,
      "LedgerEntryType": "Offer",
      "OwnerNode": "0000000000000000",
      "PreviousTxnID": "97674188B06F3ED44BA2F34180E0B538579504647796E00D8DD5F865D85F0EBB",
      "PreviousTxnLgrSeq": 328,
      "Sequence": 6,
      "TakerGets": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "10"
      },
      "TakerPays": "10000000",
      "index": "159769461D9A3B758F9315780270886EA863E21F3677997F319EB58E1F71174A"
    }],
    "validated": true
  },
  "status": "success",
  "type": "response"
}

• Any common error type
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.

Note: There is no command line version of this method. You can access this method from the command line using the json command.

{
  "id": 3,
  "command": "ledger_entry",
  "type": "account_root",
  "account_root": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "ledger_index": "validated"
}

{
    "method": "ledger_entry",
    "params": [
        {
            "account_root": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "ledger_index": "validated",
            "type": "account_root"
        }
    ]
}

1. index - Retrieve any type of ledger object by its unique ID
2. account_root - Retrieves the AccountRoot object. This is roughly equivalent to the account_info command.
3. directory - Retrieves a DirectoryNode that contains a list of other ledger objects
4. offer - Retrieves an offer object that defines an offer to exchange currency
5. stream_state - Retrieves a StreamState object that tracks the (non-STM) currency balance between two accounts.

{
  "id": 3,
  "result": {
    "index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
    "ledger_index": 156275,
    "node": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Balance": "99999986731672268",
      "Flags": 0,
      "LedgerEntryType": "AccountRoot",
      "OwnerCount": 13,
      "PreviousTxnID": "8D262E7AFD3E498C924EBA62F901FB4867C1CF04BD7248C8E894EDDD6320A376",
      "PreviousTxnLgrSeq": 156245,
      "Sequence": 308,
      "index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037"
    },
    "validated": true
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
    "ledger_index": 156275,
    "node": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Balance": "99999986731672268",
      "Flags": 0,
      "LedgerEntryType": "AccountRoot",
      "OwnerCount": 13,
      "PreviousTxnID": "8D262E7AFD3E498C924EBA62F901FB4867C1CF04BD7248C8E894EDDD6320A376",
      "PreviousTxnLgrSeq": 156245,
      "Sequence": 308,
      "index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037"
    },
    "validated": true
  },
  "status": "success",
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.

{
    "id": 102,
    "command": "ledger_request",
    "ledger_index": 13800000
}

streamd ledger_request 13800000

Note: To retrieve a ledger, the Stream server must have a direct peer relationship with the ledger in its history. If no peer owns the requested ledger, you can use the connect command or the fixed_ips section of the configuration file to add the Stream's full history server to s1.labs.stream and then ledger_request make the request again.

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "acquiring" : {
         "hash" : "01DDD89B6605E20338B8EEB8EB2B0E0DD2F685A2B164F3790C4D634B5734CC26",
         "have_header" : false,
         "peers" : 2,
         "timeouts" : 0
      },
      "error" : "lgrNotFound",
      "error_code" : 20,
      "error_message" : "acquiring ledger containing requested index",
      "request" : {
         "command" : "ledger_request",
         "ledger_index" : 18851277
      },
      "status" : "error"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "hash" : "EB68B5B4F6F06BF59B6D7532BCB98BB98E2F10C2435D895217AA0AA7E910FBD5",
      "have_header" : true,
      "have_state" : false,
      "have_transactions" : false,
      "needed_state_hashes" : [
         "C46F7B9E795135447AF24BAF999AB8FC1612A997F6EAAF8B784C226FF0BD8E25",
         "E48F528E4FC2A1DC492C6264B27B420E2285B2A3ECF3A253DB480DA5BFB7F858",
         "B62CD0B2E1277F78BC279FA037F3F747587299B60D23A551C3F63DD137DC0CF8",
         "30014C55701FB8426E496A47B297BEC9E8F5BFA47763CC22DBD9024CC81D39DD",
         "7EB59A853913898FCEA7B701637F33B1054BD36C32A0B910B612EFB9CDFF6334",
         "07ECAD3066D62583883979A2FADAADC8F7D89FA07375843C8A47452639AB2421",
         "97A87E5246AF78463485CB27E08D561E22AAF33D5E2F08FE2FACAE0D05CB5478",
         "50A0525E238629B32324C9F59B4ECBEFE3C21DC726DB9AB3B6758BD1838DFF68",
         "8C541B1ED47C9282E2A28F0B7F3DDFADF06644CAB71B15A3E67D04C5FAFE9BF4",
         "2C6CC536C778D8C0F601E35DA7DD9888C288897E4F603E76357CE2F47E8A7A9F",
         "309E78DEC67D5725476A59E114850556CC693FB6D92092997ADE97E3EFF473CC",
         "8EFF61B6A636AF6B4314CAC0C08F4FED0759E1F782178A822EDE98275E5E4B10",
         "9535645E5D249AC0B6126005B79BB981CBA00286E00154D20A3BCF65743EA3CA",
         "69F5D6FCB41D1E6CEA5ADD42CBD194086B45E957D497DF7AEE62ADAD485660CE",
         "07E93A95DBB0B8A00925DE0DF6D27E41CACC77EF75055A89815006109D82EAD3",
         "7FDF25F660235DCAD649676E3E6729DF920A9B0B4B6A3B090A3C64D7BDE2FB20"
      ],
      "needed_transaction_hashes" : [
         "BA914854F2F5EDFCBD6E3E0B168E5D4CD0FC92927BEE408C6BD38D4F52505A34",
         "AE3A2DB537B01EB33BB3A677242DE52C9AE0A64BD9222EE55E52855276E7EA2A",
         "E145F737B255D93769673CBA6DEBA4F6AC7387A309DAACC72EA5B07ECF03C215",
         "073A118552AA60E1D3C6BE6F65E4AFA01C582D9C41CCC2887244C19D9BFA7741",
         "562DB8580CD3FE19AF5CEA61C2858C10091151B924DBF2AEB7CBB8722E683204",
         "437C0D1C2391057079E9539CF028823D29E6437A965284F6E54CEBF1D25C5D56",
         "1F069486AF5533883609E5C8DB907E97273D9A782DF26F5E5811F1C42ED63A3D",
         "CAA6B7DA68EBA71254C218C81A9EA029A179694BDD0D75A49FB03A7D57BCEE49"
      ],
      "peers" : 6,
      "status" : "success",
      "timeouts" : 1
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "ledger" : {
         "accepted" : true,
         "account_hash" : "84EBB27D9510AD5B9A3A328201921B3FD418D4A349E85D3DC69E33C7B506407F",
         "close_time" : 486691300,
         "close_time_human" : "2015-Jun-04 00:01:40",
         "close_time_resolution" : 10,
         "closed" : true,
         "hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
         "ledger_hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
         "ledger_index" : "13840000",
         "parent_hash" : "8A3F6FBC62C11DE4538D969F9C7966234635FE6CEB1133DDC37220978F8100A9",
         "seqNum" : "13840000",
         "totalCoins" : "99999022883526403",
         "total_coins" : "99999022883526403",
         "transaction_hash" : "3D759EF3AF1AE2F78716A8CCB2460C3030F82687E54206E883703372B9E1770C"
      },
      "ledger_index" : 13840000,
      "status" : "success"
   }
}

1. When a lgrNotFound error is returned, the response has a field, acquiring a Ledger request object indicating the progress of acquiring the ledger from the peer network.
2. When the response indicates that the server is currently retrieving the ledger, the body of the result is a ledger request object indicating the progress of retrieving the ledger from the peer network.
3. When the ledger is fully available, the response is a representation of the ledger header.

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing. This error can also occur if you specify a ledger index that is equal to or higher than the ledger currently being processed.
• lgrNotFound - If the ledger has not been provided yet. This indicates that the server has started fetching the ledger, although it may fail if no connected peer owns the requested ledger. (Previously, this error used the code ledgerNotFound.)

{
   "id": "Accept my ledger!",
   "command": "ledger_accept"
}

#Syntax: ledger_accept
streamd ledger_accept

{
  "id": "Accept my ledger!",
  "status": "success",
  "type": "response",
  "result": {
    "ledger_current_index": 6643240
  }
}

Note: When a ledger is closed, streamd determines the canonical sequence of transactions in that ledger and replays them. This can change the results of transactions temporarily applied to the current ledger.

• Any common error type.
• notStandAlone - If the streamd server is not currently running in standalone mode.

Transactions are the only way to modify the shared state of the STM ledger. All activity on Stream takes the form of transactions: payments, currency-exchange offers, account settings, and changes to the ledger itself, such as enabling new features.

Transactions involve several sources of complexity. In traditional banking, a trusted third party (a bank or an ACH) verifies participants' identities and ensures that their balances are adjusted accurately. Stream uses cryptography and distributed computing to perform these functions. Sending STM does not require a third party outside the distributed network itself. Stream accounts also support issuing balances in any currency and trading on a decentralized exchange. This adds flexibility, but the system must account for counterparty risk, currency conversion, and other issues. The STM ledger must reliably track which transactions have been fully validated, even in the event of hardware failures, attacks, or natural disasters.

The tx method retrieves information for a single transaction.

Example of request format:

{
  "id": 1,
  "command": "tx",
  "transaction": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
  "binary": false
}

{
    "method": "tx",
    "params": [
        {
            "transaction": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
            "binary": false
        }
    ]
}

#Syntax: tx transaction [binary]
streamd tx 17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D false

The request contains the following parameters:

An example of a successful response:

{
  "id": 1,
  "result": {
    "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
    "Amount": "1000000",
    "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "Fee": "12",
    "Flags": 2147483648,
    "LastLedgerSequence": 155520,
    "Memos": [{
      "Memo": {
        "MemoData": "68616861",
        "MemoType": "6D656D6F"
      }
    }],
    "Sequence": 77,
    "SigningPubKey": "021ADD58CB32BFD8F3F24A027081CE3928CEE072E85692123DE4DF92EFCF2CE2BC",
    "TransactionType": "Payment",
    "TxnSignature": "304402200C8B73E45DD5C43D6C10ECF26BE1D0212BA121BC0EB090441B09AE21FAD2F17C02206143819F8B15F4C8C83A4735E56E971E7465A76C2116443092E8E7179B4A7AFD",
    "date": 575694990,
    "hash": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
    "inLedger": 155512,
    "ledger_index": 155512,
    "meta": {
      "AffectedNodes": [{
        "ModifiedNode": {
          "FinalFields": {
            "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
            "Balance": "21492361",
            "Flags": 8388608,
            "OwnerCount": 14,
            "Sequence": 78
          },
          "LedgerEntryType": "AccountRoot",
          "LedgerIndex": "ADEFE0B5A676E5431444ADA797634C65B963A00B9B79DBFA4821DA786DD6C8B4",
          "PreviousFields": {
            "Balance": "22492373",
            "Sequence": 77
          },
          "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
          "PreviousTxnLgrSeq": 153524
        }
      }, {
        "ModifiedNode": {
          "FinalFields": {
            "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "Balance": "99999986730672448",
            "Flags": 0,
            "OwnerCount": 15,
            "Sequence": 293
          },
          "LedgerEntryType": "AccountRoot",
          "LedgerIndex": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
          "PreviousFields": {
            "Balance": "99999986729672448"
          },
          "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
          "PreviousTxnLgrSeq": 153524
        }
      }],
      "TransactionIndex": 0,
      "TransactionResult": "tesSUCCESS",
      "delivered_amount": "1000000"
    },
    "validated": true
  },
  "status": "success",
  "type": "response"
}

The response follows a standard format, with a successful result containing the fields of the Transaction object and the following additional fields:

Possible errors:

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• txnNotFound - The transaction does not exist, or it is part of an old version of the ledger that is not available streamd.

The transaction_entry method retrieves information for a single transaction from a specific ledger version. (tx In contrast, this command will search all ledgers for the specified transaction, and we recommend using that method.)

Example of request format:

{
  "id": 4,
  "command": "transaction_entry",
  "tx_hash": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
  "ledger_index": 155512
}

{
    "method": "transaction_entry",
    "params": [
        {
            "tx_hash": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
            "ledger_index": 155512
        }
    ]
}

#Syntax: transaction_entry transaction_hash ledger_index|ledger_hash
streamd transaction_entry 17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D 155512

The request contains the following parameters:

Note: This method does not support retrieving information from the currently ongoing ledger. You must specify a ledger version in ledger_index or ledger_hash.

An example of a successful response:

{
  "id": 4,
  "result": {
    "ledger_index": 155512,
    "metadata": {
      "AffectedNodes": [{
        "ModifiedNode": {
          "FinalFields": {
            "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
            "Balance": "21492361",
            "Flags": 8388608,
            "OwnerCount": 14,
            "Sequence": 78
          },
          "LedgerEntryType": "AccountRoot",
          "LedgerIndex": "ADEFE0B5A676E5431444ADA797634C65B963A00B9B79DBFA4821DA786DD6C8B4",
          "PreviousFields": {
            "Balance": "22492373",
            "Sequence": 77
          },
          "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
          "PreviousTxnLgrSeq": 153524
        }
      }, {
        "ModifiedNode": {
          "FinalFields": {
            "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "Balance": "99999986730672448",
            "Flags": 0,
            "OwnerCount": 15,
            "Sequence": 293
          },
          "LedgerEntryType": "AccountRoot",
          "LedgerIndex": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
          "PreviousFields": {
            "Balance": "99999986729672448"
          },
          "PreviousTxnID": "BEE1FD0E440416A4CFD29663ADB2BAB5356CBE3FE2AF7659C69B4153612BBD52",
          "PreviousTxnLgrSeq": 153524
        }
      }],
      "TransactionIndex": 0,
      "TransactionResult": "tesSUCCESS"
    },
    "tx_json": {
      "Account": "vfq4sckDNcNcyfrDQed6FBqqDfEgTgsjtJ",
      "Amount": "1000000",
      "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": "12",
      "Flags": 2147483648,
      "LastLedgerSequence": 155520,
      "Memos": [{
        "Memo": {
          "MemoData": "68616861",
          "MemoType": "6D656D6F"
        }
      }],
      "Sequence": 77,
      "SigningPubKey": "021ADD58CB32BFD8F3F24A027081CE3928CEE072E85692123DE4DF92EFCF2CE2BC",
      "TransactionType": "Payment",
      "TxnSignature": "304402200C8B73E45DD5C43D6C10ECF26BE1D0212BA121BC0EB090441B09AE21FAD2F17C02206143819F8B15F4C8C83A4735E56E971E7465A76C2116443092E8E7179B4A7AFD",
      "hash": "17CF128117A275D1E0F0638CE38DADD7DE4F978818F1E950C89CA5C62620E27D",
      "inLedger": 155512,
      "ledger_index": 155512
    },
    "validated": false
  },
  "status": "success",
  "type": "response"
}

Responses follow a standard format, with successful results containing the following fields:

There are several possible reasons why the server may not be able to find the transaction:

• Transaction does not exist
• The transaction exists, but is not in the specified ledger version
• The server does not have the specified ledger version available. Another server with the correct version may respond differently.

Possible errors:

• Any common error type.
• fieldNotFoundTransaction- tx_hashThis field is ignored in the request
• notYetImplemented - No ledger version specified in the request.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.
• transactionNotFound - The transaction specified in the request was not found in the specified ledger. (It may be in a different ledger version, or not available at all.)

Warning: This method is deprecated and may be removed without notice.

{
  "id": 5,
  "command": "tx_history",
  "start": 0
}

{
    "method": "tx_history",
    "params": [
        {
            "start": 0
        }
    ]
}

#Syntax: tx_history [start]
streamd tx_history 0

{
  "id": 5,
  "result": {
    "index": 11,
    "txs": [{
      "Account": "vpiwZth4cjYpQzpUjHUiEbjiGkgexjU9v3",
      "Fee": "12",
      "Flags": 2148007936,
      "LastLedgerSequence": 156205,
      "Sequence": 10,
      "SigningPubKey": "037BC8FBA834E60F92B2E084DD8937E871AEFFA63255EA12ED827C302C9E0217CB",
      "TakerGets": "1000000",
      "TakerPays": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1"
      },
      "TransactionType": "OfferCreate",
      "TxnSignature": "3045022100ED2C80534AB54D708D48C8E3CC51993159968B54E1AFB97AB4B8C9C07750A7300220449150763E9859B96A7C63D3CBF09FC944AE9E7C812476150B4ECB01023C4843",
      "hash": "861E6F41746B753DAA4ED2D4AE11F967D6FB2F0097F86E8F22845B5BCE9F21CC",
      "inLedger": 156197,
      "ledger_index": 156197
    }, {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "CNY",
        "issuer": "vpiwZth4cjYpQzpUjHUiEbjiGkgexjU9v3",
        "value": "1000"
      },
      "Destination": "vpiwZth4cjYpQzpUjHUiEbjiGkgexjU9v3",
      "Fee": "12",
      "Flags": 2147483648,
      "LastLedgerSequence": 156197,
      "SendMax": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1010"
      },
      "Sequence": 300,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "3045022100EF5BFE996389995EAD9BC6818BF1AA6364123F937E1167269CDEE73908683FD0022025A3E7EE9AE2C7FEFFAFC779914E9A53F84FDF29B8D1C27A28871CE335BA42E0",
      "hash": "ADB6082D69DBFCBB062177EBFEECB5A63F637427301C5ADE12B133961FE46F86",
      "inLedger": 156194,
      "ledger_index": 156194
    }]
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "index": 11,
    "txs": [{
      "Account": "vpiwZth4cjYpQzpUjHUiEbjiGkgexjU9v3",
      "Fee": "12",
      "Flags": 2148007936,
      "LastLedgerSequence": 156205,
      "Sequence": 10,
      "SigningPubKey": "037BC8FBA834E60F92B2E084DD8937E871AEFFA63255EA12ED827C302C9E0217CB",
      "TakerGets": "1000000",
      "TakerPays": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1"
      },
      "TransactionType": "OfferCreate",
      "TxnSignature": "3045022100ED2C80534AB54D708D48C8E3CC51993159968B54E1AFB97AB4B8C9C07750A7300220449150763E9859B96A7C63D3CBF09FC944AE9E7C812476150B4ECB01023C4843",
      "hash": "861E6F41746B753DAA4ED2D4AE11F967D6FB2F0097F86E8F22845B5BCE9F21CC",
      "inLedger": 156197,
      "ledger_index": 156197
    }, {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "CNY",
        "issuer": "vpiwZth4cjYpQzpUjHUiEbjiGkgexjU9v3",
        "value": "1000"
      },
      "Destination": "vpiwZth4cjYpQzpUjHUiEbjiGkgexjU9v3",
      "Fee": "12",
      "Flags": 2147483648,
      "LastLedgerSequence": 156197,
      "SendMax": {
        "currency": "CNY",
        "issuer": "vJqt7ir44V6RyWwxxEgD87sEfStdwCahZz",
        "value": "1010"
      },
      "Sequence": 300,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "3045022100EF5BFE996389995EAD9BC6818BF1AA6364123F937E1167269CDEE73908683FD0022025A3E7EE9AE2C7FEFFAFC779914E9A53F84FDF29B8D1C27A28871CE335BA42E0",
      "hash": "ADB6082D69DBFCBB062177EBFEECB5A63F637427301C5ADE12B133961FE46F86",
      "inLedger": 156194,
      "ledger_index": 156194
    }]
  },
  "status": "success",
  "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• noPermission- The field specified by start is greater than 10000, but you are not connected to the server as an administrator.

• create - Start sending pathfinding information
• close - Stop sending pathfinding information
• status - Get information about the currently opened pathfinding request

{
    "id": 8,
    "command": "path_find",
    "subcommand": "create",
    "source_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "destination_amount": {
        "value": "0.001",
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
    }
}

{
  "alternatives": [],
  "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "destination_amount": {
    "currency": "USD",
    "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "value": "0.001"
  },
  "id": 8,
  "source_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "type": "path_find"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• noEvents - You are using a protocol that does not support asynchronous callbacks, such as JSON-RPC.

Asynchronous follow-up

{
    "id": 1,
    "type": "path_find",
    "alternatives": [
        /* paths omitted from this example; same format as the initial response */
    ],
    "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "destination_amount": {
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "value": "0.001"
    },
    "source_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
}

{
  "id": 57,
  "command": "path_find",
  "subcommand": "close"
}

• Any common error type.
• invalidParams - If any field is specified incorrectly, or any required field is missing.
• noEvents - If you are trying to use this method on a protocol that does not support asynchronous callbacks, such as JSON-RPC.
• noPathRequest - You are trying to turn off a pathfinding request when no request is open.

{
  "id": 58,
  "command": "path_find",
  "subcommand": "status"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• noEvents - You are using a protocol that does not support asynchronous callbacks, such as JSON-RPC.
• noPathRequest - You are trying to check the status of a pathfinding request when no request has been opened.

The vstream_path_find method is a simplified version of path_find that can be used out of the box and provides a single response for the payment path. It is available in WebSocket and JSON-RPC APIs. However, over time, the results tend to become outdated. Rather than making multiple calls to keep things updated, you should use path_find whenever possible.

Although the streamd server attempts to find the cheapest path or combination of paths for payment, there is no guarantee that the path returned by this method is actually the best path.

Warning: Beware of path lookup results from untrusted servers. The server can be modified to return less operator revenue than the optimal path. The server may also return bad results when under heavy load. If you don't have a server you can trust, then you should compare pathfinding results from multiple servers run by different parties to minimize the risk of a single server returning bad results.

Example of request format:

{
    "id": 8,
    "command": "vstream_path_find",
    "source_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "source_currencies": [
        {
            "currency": "STM"
        },
        {
            "currency": "USD"
        }
    ],
    "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "destination_amount": {
        "value": "0.001",
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
    }
}

{
    "method": "vstream_path_find",
    "params": [
        {
            "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "destination_amount": {
                "currency": "USD",
                "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
                "value": "0.001"
            },
            "source_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "source_currencies": [
                {
                    "currency": "STM"
                },
                {
                    "currency": "USD"
                }
            ]
        }
    ]
}

#Syntax vstream_path_find json ledger_index|ledger_hash
streamd vstream_path_find '{"source_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV", "source_currencies": [ { "currency": "STM" }, { "currency": "USD" } ], "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV", "destination_amount": { "value": "0.001", "currency": "USD", "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV" } }'

The request contains the following parameters:

An example of a successful response:

{
  "id": 8,
  "result": {
    "alternatives": [],
    "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "destination_currencies": ["ETH", "BTC", "CNY", "STM"]
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "alternatives": [],
    "destination_account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "destination_currencies": ["ETH", "BTC", "CNY", "STM"]
  },
  "status": "success",
  "type": "response"
}

Responses follow a standard format, with successful results containing the following fields:

Each element in the alternatives array is an object representing a path from one possible source currency (held by the initial account) to the target account and currency. The object has the following fields:

The following fields are deprecated and may be ignored: paths_canonical, and paths_expanded. If they appear, you should ignore them.

Possible errors:

• Any common error type.
• tooBusy - The server is under heavy load and cannot calculate the path. If you are connecting as an administrator, this will not be returned.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• srcActMissing- This field is ignored in source_account requests.
• srcActMalformed- The field in the source_account request is not in the correct format.
• dstActMissing- This field is ignored in destination_account requests.
• dstActMalformed- The field in the destination_account request is not in the correct format.
• srcCurMalformed - The source_currencies field is not properly formatted.
• srcIsrMalformed- issuerOne or more fields of the currency object in the request are invalid.

sign method takes a transaction and key in JSON format and returns a signed binary representation of the transaction. The result is always different, even if you provide the same transaction JSON and key. To contribute a signature to a multi-signature transaction, use the sign_for command instead.

Warning: Unless you streamd run the server yourself, you should use the StreamAPI to perform local signing instead of using this command. An untrusted server might alter a transaction before signing it, or use your key to sign additional arbitrary transactions as if they came from you.

Example of request format:

{
  "id": 2,
  "command": "sign",
  "tx_json" : {
      "TransactionType" : "Payment",
      "Account" : "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Destination" : "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount" : {
         "currency" : "USD",
         "value" : "1",
         "issuer" : "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
      }
   },
   "secret" : "s████████████████████████████",
   "offline": false,
   "fee_mult_max": 1000
}

{
    "method": "sign",
    "params": [
        {
            "offline": false,
            "secret": "s████████████████████████████",
            "tx_json": {
                "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
                "Amount": {
                    "currency": "USD",
                    "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
                    "value": "1"
                },
                "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
                "TransactionType": "Payment"
            },
            "fee_mult_max": 1000
        }
    ]
}

#Syntax: sign secret tx_json [offline]
streamd sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV", "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV", "Amount": { "currency": "USD", "value": "1", "issuer" : "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV" }, "Sequence": 360, "Fee": "10000"}' offline

To sign a transaction, you must provide a key that authorizes the transaction. You can do this in a few ways:

• Supply a secret value and ignore the key_type field. The value can be formatted as a base58 seed, RFC-1751, hexadecimal or string password. (secp256k1 key only)
• Supply a key_type value and only one of seed, seed_hex or passphrase. Omit the secret field. (Not supported by command line syntax).

The request contains the following parameters:

• Sequence - The server automatically uses the next sequence number in the sender's account information.

• Warning: The account's next sequence number will not be incremented until this transaction is applied. If you sign multiple transactions without committing and waiting for a response on each transaction, you must manually provide the correct sequence number for each transaction after the first transaction.

• Fee - If you omit the Fee parameter, the server will automatically try to fill in the appropriate transaction cost. In a production Stream ledger, rpcHIGH_FEE will fail unless you provide an appropriate fee_mult_max value.
• The parameters fee_mult_max and fee_div_max limit how high the automatically provided transaction costs can be, based on the load scaling multiplier applied to the reference transaction cost. The default setting returns an error if the automatically provided value uses a multiplier greater than 10x. However, production Stream ledgers typically have a load multiplier of 1000x.
• The command line syntax does not support fee_mult_max and fee_div_max. For production Stream ledgers, you must provide a Fee value.

• Note: A malicious server can specify excessively high transaction costs, ignoring the values fee_mult_max and fee_div_max.

• Paths - For transactions of type Payment (excluding STM to STM transfers), the Paths field can be auto-populated. Fill in only if build_path is provided.

{
  "id": 2,
  "result": {
    "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C67446304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA81148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8",
    "tx_json": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "value": "1"
      },
      "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": "10",
      "Flags": 2147483648,
      "Sequence": 313,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA",
      "hash": "BD8CD7F28FA90A1336CBB6AA364009096A5222EC639F7D912C04E32D8ED10DBD"
    }
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C67446304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA81148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8",
    "tx_json": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "value": "1"
      },
      "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": "10",
      "Flags": 2147483648,
      "Sequence": 313,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA",
      "hash": "BD8CD7F28FA90A1336CBB6AA364009096A5222EC639F7D912C04E32D8ED10DBD"
    }
  },
  "status": "success"
}

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
  "result": {
    "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C67446304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA81148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8",
    "tx_json": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "value": "1"
      },
      "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": "10",
      "Flags": 2147483648,
      "Sequence": 313,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA",
      "hash": "BD8CD7F28FA90A1336CBB6AA364009096A5222EC639F7D912C04E32D8ED10DBD"
    }
  }
}

Warning: If this command results in an error message, the message can contain the key from the request. Make sure these errors are not visible to others.

• Do not write this error to a log file that can be viewed by multiple people.
• Do not post this error into a public place for debugging.
• Don’t display error messages on your website, even by accident.

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• highFee - The current load-based transaction cost multiplier exceeds the limit for automatically supplying a transaction cost. Specify a higher fee_mult_max value (at least 1000), or manually set the Fee field in tx_json.
• tooBusy - The transaction does not include a path, but the server is too busy to perform pathfinding now. If you connect as administrator, this won't happen.
• noPath - The transaction did not include a path, and the server was unable to find a path where this payment could occur.

The submit method applies the transaction and sends it to the network for confirmation and inclusion in future ledgers.

This command has two modes:

• Commit-only mode takes the signed serialized transaction as a binary blob and submits it to the network as-is. Because signed transaction objects are immutable, no part of the transaction can be modified or automatically filled in after submission.
• The sign and commit mode takes a Transaction object in JSON format, completes and signs the transaction in the same way as the sign command, and then commits the signed transaction. We recommend using this mode only for testing and development.

To make sending transactions as robust as possible, you should sign pre-build it and keep it so that even after an outage you can still access submit it, then use it as a tx_blob. After committing, use the tx command to monitor the network to see if the transaction was successfully applied; if a restart or other problem occurs, you can safely resubmit the tx_blob transaction: since it has the same sequence number as the old transaction, it will not be applied twice.

The submission request contains the following parameters:

Request format:

{
    "id": 3,
    "command": "submit",
    "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C67446304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA81148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8"
}

{
    "method": "submit",
    "params": [
        {
            "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C67446304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA81148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8"
        }
    ]
}

#Syntax: submit tx_blob
submit 1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C67446304402200167648A76219C3E1C6BE70B932468156F20377FC5559E4295490DFEAC1F6A1B022023BB17B6A0F2198C074839204462FA97C8B93173F8780DF5229A351BDAACD2EA81148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8

• Supply a secret value and ignore the key_type field. The value can be formatted as a base58 seed, RFC-1751, hexadecimal or string password. (secp256k1 key only)
• Supply a key_type value and only one of seed, seed_hex or passphrase. Omit the secret field. (Not supported by command line syntax).

{
  "id": 2,
  "command": "submit",
  "tx_json" : {
      "TransactionType" : "Payment",
      "Account" : "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Destination" : "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount" : {
         "currency" : "USD",
         "value" : "1",
         "issuer" : "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
      }
   },
   "secret" : "s████████████████████████████",
   "offline": false,
   "fee_mult_max": 1000
}

{
    "method": "submit",
    "params": [
        {
            "offline": false,
            "secret": "s████████████████████████████",
            "tx_json": {
                "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
                "Amount": {
                    "currency": "USD",
                    "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
                    "value": "1"
                },
                "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
                "TransactionType": "Payment"
            },
            "fee_mult_max": 1000
        }
    ]
}

#Syntax: submit secret json [offline]
streamd submit s████████████████████████████ '{"Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV", "Amount": { "currency": "USD", "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV", "value": "1" }, "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV", "TransactionType": "Payment", "Fee": "10000"}'

{
  "id": 2,
  "result": {
    "engine_result": "temREDUNDANT",
    "engine_result_code": -275,
    "engine_result_message": "Sends same currency to self.",
    "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C674473045022100E9DBF1323A39E65C5E6085CD12C49383059365A9F664466327742E0ACB975339022069CF3C84706C19419B31FD182816598BABE5410F72C3728AEA9B933C11660FF281148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8",
    "tx_json": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "value": "1"
      },
      "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": "10",
      "Flags": 2147483648,
      "Sequence": 313,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "3045022100E9DBF1323A39E65C5E6085CD12C49383059365A9F664466327742E0ACB975339022069CF3C84706C19419B31FD182816598BABE5410F72C3728AEA9B933C11660FF2",
      "hash": "A9F6F788C0576969648738CECA450FD8AC82CAF0CF32540A3D2F1C7A13CBF98E"
    }
  },
  "status": "success",
  "type": "response"
}

{
  "result": {
    "engine_result": "temREDUNDANT",
    "engine_result_code": -275,
    "engine_result_message": "Sends same currency to self.",
    "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C674473045022100E9DBF1323A39E65C5E6085CD12C49383059365A9F664466327742E0ACB975339022069CF3C84706C19419B31FD182816598BABE5410F72C3728AEA9B933C11660FF281148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8",
    "tx_json": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "value": "1"
      },
      "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": "10",
      "Flags": 2147483648,
      "Sequence": 313,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "3045022100E9DBF1323A39E65C5E6085CD12C49383059365A9F664466327742E0ACB975339022069CF3C84706C19419B31FD182816598BABE5410F72C3728AEA9B933C11660FF2",
      "hash": "A9F6F788C0576969648738CECA450FD8AC82CAF0CF32540A3D2F1C7A13CBF98E"
    }
  }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
  "result": {
    "engine_result": "temREDUNDANT",
    "engine_result_code": -275,
    "engine_result_message": "Sends same currency to self.",
    "tx_blob": "1200002280000000240000013961D4838D7EA4C6800000000000000000000000000055534400000000008B17262A312E4FF5BE1138A85301428C74628BB868400000000000000A73210338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C674473045022100E9DBF1323A39E65C5E6085CD12C49383059365A9F664466327742E0ACB975339022069CF3C84706C19419B31FD182816598BABE5410F72C3728AEA9B933C11660FF281148B17262A312E4FF5BE1138A85301428C74628BB883148B17262A312E4FF5BE1138A85301428C74628BB8",
    "tx_json": {
      "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Amount": {
        "currency": "USD",
        "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
        "value": "1"
      },
      "Destination": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
      "Fee": "10",
      "Flags": 2147483648,
      "Sequence": 313,
      "SigningPubKey": "0338B02E376397CE1600D338500584CC79E54094C8544DE2400E01E7CE4447F2C6",
      "TransactionType": "Payment",
      "TxnSignature": "3045022100E9DBF1323A39E65C5E6085CD12C49383059365A9F664466327742E0ACB975339022069CF3C84706C19419B31FD182816598BABE5410F72C3728AEA9B933C11660FF2",
      "hash": "A9F6F788C0576969648738CECA450FD8AC82CAF0CF32540A3D2F1C7A13CBF98E"
    }
  }
}

Warning: Even though a WebSocket response has "status":"success", which indicates that the command was successfully received, it does indicate that the transaction was successfully executed. Many circumstances may prevent a transaction from being successfully processed, such as a missing trust line connecting the two accounts in the payment, or a change in account status since the transaction was constructed. Even if there are no errors, it may take several seconds to close and verify the version of the ledger containing the transaction. See the full list of transaction responses for details, and do not consider the results of a transaction final until they appear in a verified version of the ledger.

Warning: If this command results in an error message, the message can contain the key from the request. (This is not a problem if the request contains a signed tx_blob.) Make sure these errors are not visible to others.

• Do not write errors, including keys, to a log file visible to multiple people.
• Do not paste bugs including keys into a public place for debugging.
• Do not display error messages containing your key on websites, even accidentally.

• Any common error type.
• amendmentBlocked - The transaction could not be submitted to the network because the streamd server was blocked by modification.
• highFee- The fee_mult_max parameter was specified, but the server's current fee multiplier exceeds the specified value. (Sign and Commit modes only)
• internalJson - An internal error occurred while serializing the transaction to JSON. This can be caused by many aspects of the transaction, including incorrect signatures or malformed fields.
• internalSubmit - An internal error occurred while submitting the transaction. This can be caused by many aspects of the transaction, including incorrect signatures or malformed fields.
• internalTransaction - An internal error occurred while processing the transaction. This can be caused by many aspects of the transaction, including incorrect signatures or malformed fields.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• invalidTransaction - The transaction format is incorrect or invalid.
• noPath - The transaction does not include a path, and the server cannot find a path where this payment can occur. (Sign and Commit modes only)
• tooBusy - The transaction does not include a path, but the server is too busy to perform pathfinding now. If you connect as administrator, this won't happen. (Sign and Commit modes only)

{
  "id": 4,
  "command": "book_offers",
  "taker": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
  "taker_gets": {
    "currency": "STM"
  },
  "taker_pays": {
    "currency": "USD",
    "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
  },
  "limit": 10
}

{
    "method": "book_offers",
    "params": [
        {
            "taker": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "taker_gets": {
                "currency": "STM"
            },
            "taker_pays": {
                "currency": "USD",
                "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            },
            "limit": 10
        }
    ]
}

#Syntax: book_offers taker_pays taker_gets [taker [ledger [limit] ] ]
streamd book_offers 'USD/vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV' 'EUR/vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV'

{
  "id": 4,
  "result": {
    "ledger_current_index": 168798,
    "offers": [],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "ledger_current_index": 168798,
    "offers": [],
    "validated": false
  },
  "status": "success",
  "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• lgrNotFound - A ledger created by ledger_hash or ledger_index that does not exist, or does exist but is not found by the server.
• srcCurMalformed- The field in the taker_pays request is not in the correct format.
• dstAmtMalformed- The field in the taker_gets request is not in the correct format.
• srcIsrMalformed - The issuer field in taker_pays is invalid.
• dstIsrMalformed - The issuer field in taker_gets is invalid.
• badMarket - the required order does not exist; for example, exchange currency for yourself.

When using subscriptions, you can have the server push updates to the client when various events occur so that you can know and react immediately. Subscriptions are only supported in the WebSocket API, you can receive other responses in the same channel.

JSON-RPC support for subscription callbacks is deprecated and may not work as expected.

{
  "id": "Example watch Bitstamp's hot wallet",
  "command": "subscribe",
  "accounts": ["vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"]
}

{
    "id": "Example subscribe to STM/GateHub USD order book",
    "command": "subscribe",
    "books": [
        {
            "taker_pays": {
                "currency": "STM"
            },
            "taker_gets": {
                "currency": "USD",
                "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
            },
            "snapshot": true
        }
    ]
}

{
  "id": "Example watch for new validated ledgers",
  "command": "subscribe",
  "streams": ["ledger"]
}

• server - Sends a message whenever the streamd server's status (e.g. network connection) changes
• ledger - Sends a message whenever the consensus process declares a new validated ledger
• transactions - Sends a message whenever a transaction is included in a closed ledger
• transactions_proposed - Message sent whenever a transaction is included in the closed ledger, and for some transactions that are not yet included in the validating ledger, and may never be. Not all proposed transactions appear before verification Note: Even some unsuccessful transactions are included in the verified ledger as they are subject to anti-spam transaction fees.
• validations - Message sent whenever the server receives a validation message from a server it trusts. (streamdPersonal claims validate the ledger when the server receives a quorum of validation messages from at least one trusted validator.)
• peer_status - (Admin only) Information about the connected peer streamd server, specifically about the consensus process.

{
  "id": "Example watch Bitstamp's hot wallet",
  "status": "success",
  "type": "response",
  "result": {}
}

• accounts and accounts_proposed - no field returned
• Stream: Server - Information about the status of the server, such as load_base (the current load level of the server), random (randomly generated value), etc., may change.
• Stream: transactions, Stream: transactions_proposed and Stream: validation - no fields returned
• Stream: Ledger - Information about the ledger and the current fee schedule, such as fee_base (current base fee for STM transactions), fee_ref (current base fee for fee unit transactions), ledger_hash (hash of the latest verified ledger), reserve_base (minimum reserve for the account), etc.
• books - No fields are returned by default. If "snapshot": true is set in the request, return offers (an array of item definition objects defining the order book)

• Any universal error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• noPermission - Include the url field in the request, but do not connect as an administrator.
• unknownStream- One or more members of the streams request field are not valid stream names.
• malformedStream- streams The requested field format is incorrect.
• malformedAccount - One of the addresses in the request's accounts or accounts_proposed fields is not a properly formatted STM ledger address. (Note: You can subscribe to the stream of an address that does not yet have an entry in the global ledger to receive a message when that address is funded.)
• srcCurMalformed - One or more taker_pays fields in the requested books are malformed.
• dstAmtMalformed - One or more taker_gets fields in the requested books are malformed.
• srcIsrMalformed - The issuer in one or more taker_pays fields in the requested books is invalid.
• dstIsrMalformed - The issuer in one or more taker_gets fields in the requested books is invalid.
• badMarket- books There is no required order for one or more books on site; for example, exchanging currency for yourself.

The ledger flow only sends ledgerClosed messages when the consensus process declares a new valid ledger. This message identifies the ledger and provides some information about its contents.

{
  "type": "ledgerClosed",
  "fee_base": 10,
  "fee_ref": 10,
  "ledger_hash": "687F604EF6B2F67319E8DCC8C66EF49D84D18A1E18F948421FC24D2C7C3DB464",
  "ledger_index": 7125358,
  "ledger_time": 455751310,
  "reserve_base": 20000000,
  "reserve_inc": 5000000,
  "txn_count": 7,
  "validated_ledgers": "32570-7125358"
}

The fields in the ledger flow message are as follows:

Many subscriptions result in messages about transactions, including the following:

• The transactionsflow
• The transactions_proposed flow
• accounts Subscription
• accounts_proposed Subscription
• book (order book) subscription

The transactions_proposed stream is, strictly speaking, a superset of the transactions stream: it includes all validated transactions, as well as some proposed transactions that have not yet been incorporated into a valid ledger and may never be included. You can identify these "in progress" transactions by their fields:

• The validated field is missing or has the value false.
• No meta or metadata field.
• Instead of the ledger_hash and ledger_index fields specifying the ledger version in which transactions were completed, there is a ledger_current_index field specifying the ledger version in which they are currently presented.

Otherwise, messages in the transactions_proposed stream are the same as messages in the transactions stream.

Since the only thing that can modify an account or order is a transaction, these messages are sent as a result of a specific subscription, accounts or books are also in the form of transaction messages, the same as those in the transactions stream. The only difference is that you only receive messages for transactions that affect the account or order you are watching.

The accounts_proposed subscription works the same way, but it also includes unconfirmed transactions, such as the transactions_proposed stream, for the account you are watching.

{
  "status": "closed",
  "type": "transaction",
  "engine_result": "tesSUCCESS",
  "engine_result_code": 0,
  "engine_result_message": "The transaction was applied.",
  "ledger_hash": "989AFBFD65D820C6BD85301B740F5D592F060668A90EEF5EC1815EBA27D58FE8",
  "ledger_index": 7125442,
  "meta": {
    "AffectedNodes": [
      {
        "ModifiedNode": {
          "FinalFields": {
            "Flags": 0,
            "IndexPrevious": "0000000000000000",
            "Owner": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "RootIndex": "ABD8CE2D1205D0C062876E9E1F3CBDC902ED8EF4E8D3D071B962C7ED0E113E68"
          },
          "LedgerEntryType": "DirectoryNode",
          "LedgerIndex": "0BBDEE7D0BE120F7BF27640B5245EBFE0C5FD5281988BA823C44477A70262A4D"
        }
      },
      {
        "DeletedNode": {
          "FinalFields": {
            "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "BookDirectory": "892E892DC63D8F70DCF5C9ECF29394FF7DD3DC6F47DB8EB34A03920BFC5E99BE",
            "BookNode": "0000000000000000",
            "Flags": 0,
            "OwnerNode": "000000000000006E",
            "PreviousTxnID": "58A17D95770F8D07E08B81A85896F4032A328B6C2BDCDEC0A00F3EF3914DCF0A",
            "PreviousTxnLgrSeq": 7125330,
            "Sequence": 540691,
            "TakerGets": "4401967683",
            "TakerPays": {
              "currency": "BTC",
              "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
              "value": "0.04424"
            }
          },
          "LedgerEntryType": "Offer",
          "LedgerIndex": "386B7803A9210747941B0D079BB408F31ACB1CB98832184D0287A1CBF4FE6D00"
        }
      },
      {
        "DeletedNode": {
          "FinalFields": {
            "ExchangeRate": "4A03920BFC5E99BE",
            "Flags": 0,
            "RootIndex": "892E892DC63D8F70DCF5C9ECF29394FF7DD3DC6F47DB8EB34A03920BFC5E99BE",
            "TakerGetsCurrency": "0000000000000000000000000000000000000000",
            "TakerGetsIssuer": "0000000000000000000000000000000000000000",
            "TakerPaysCurrency": "0000000000000000000000004254430000000000",
            "TakerPaysIssuer": "92D705968936C419CE614BF264B5EEB1CEA47FF4"
          },
          "LedgerEntryType": "DirectoryNode",
          "LedgerIndex": "892E892DC63D8F70DCF5C9ECF29394FF7DD3DC6F47DB8EB34A03920BFC5E99BE"
        }
      },
      {
        "ModifiedNode": {
          "FinalFields": {
            "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
            "Balance": "11133297300",
            "Flags": 0,
            "OwnerCount": 9,
            "Sequence": 540706
          },
          "LedgerEntryType": "AccountRoot",
          "LedgerIndex": "A6C2532E1008A513B3F822A92B8E5214BD0D413DC20AD3631C1A39AD6B36CD07",
          "PreviousFields": {
            "Balance": "11133297310",
            "OwnerCount": 10,
            "Sequence": 540705
          },
          "PreviousTxnID": "484D57DFC4E446DA83B4540305F0CE836D4E007361542EC12CC0FFB5F0A1BE3A",
          "PreviousTxnLgrSeq": 7125358
        }
      }
    ],
    "TransactionIndex": 1,
    "TransactionResult": "tesSUCCESS"
  },
  "transaction": {
    "Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
    "Fee": "10",
    "Flags": 2147483648,
    "OfferSequence": 540691,
    "Sequence": 540705,
    "SigningPubKey": "030BB49C591C9CD65C945D4B78332F27633D7771E6CF4D4B942D26BA40748BB8B4",
    "TransactionType": "OfferCancel",
    "TxnSignature": "30450221008223604A383F3AED25D53CE7C874700619893A6EEE4336508312217850A9722302205E0614366E174F2DFF78B879F310DB0B3F6DA1967E52A32F65E25DCEC622CD68",
    "date": 455751680,
    "hash": "94CF924C774DFDBE474A2A7E40AEA70E7E15D130C8CBEF8AF1D2BE97A8269F14"
  },
  "validated": true
}

Transaction flow messages have the following fields:

The administrator-only peer_status stream reports a wealth of information about streamd the activity of other servers to which this server is connected, especially their status in the consensus process.

Example of peer status flow message:

{
    "action": "CLOSING_LEDGER",
    "date": 508546525,
    "ledger_hash": "4D4CD9CD543F0C1EF023CC457F5BEFEA59EEF73E4552542D40E7C4FA08D3C320",
    "ledger_index": 18853106,
    "ledger_index_max": 18853106,
    "ledger_index_min": 18852082,
    "type": "peerStatusChange"
}

Peer status stream messages represent events that change the status of a peer streamd server. The messages are JSON objects with the following fields:

actionThe fields of the peer status flow message can have the following values:

{
    "id": "Unsubscribe a lot of stuff",
    "command": "unsubscribe",
    "streams": ["ledger","server","transactions","transactions_proposed"],
    "accounts": ["vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"],
    "accounts_proposed": ["vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"],
    "books": [
        {
            "taker_pays": {
                "currency": "STM"
            },
            "taker_gets": {
                "currency": "USD",
                "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
            },
            "both": true
        }
    ]
}

{
    "id": "Unsubscribe a lot of stuff",
    "result": {},
    "status": "success",
    "type": "response"
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• noPermission - Include the url field in the request, but do not connect as an administrator.
• malformedStream- streams The requested field format is incorrect.
• malformedAccount - One of the addresses in the request's accounts or accounts_proposed fields is not a properly formatted STM ledger address.

• Note: You can subscribe to the stream for addresses that have not yet been entered in the global ledger to receive messages when an address is funded.

• srcCurMalformed - One or more taker_pays fields in the requested books are malformed.
• dstAmtMalformed - One or more taker_gets fields in the requested books are malformed.
• srcIsrMalformed - The issuer in one or more taker_pays fields in the requested books is invalid.
• dstIsrMalformed - The issuer in one or more taker_gets fields in the requested books is invalid.
• badMarket- books There is no required order for one or more books on site; for example, exchanging currency for yourself.

There are also commands that can retrieve information about the current status of the server. These may be useful for monitoring the health of the server or preparing to make additional API methods. For example, you can query the current fee schedule before sending a transaction, or you can see which ledger versions are available before digging into the ledger history for a specific record.

{
  "id": 1,
  "command": "server_info"
}

{
    "method": "server_info",
    "params": [
        {}
    ]
}

#Syntax: server_info
streamd server_info

{
  "id": 1,
  "result": {
    "info": {
      "build_version": "0.1.0",
      "complete_ledgers": "2-168922",
      "hostid": "MOS",
      "io_latency_ms": 1,
      "last_close": {
        "converge_time_s": 2.001,
        "proposers": 2
      },
      "load_factor": 1,
      "peers": 2,
      "pubkey_node": "n9KeFY9ZAmhuk2CDdKthcMhcZLhhaBrCFKSNAc1ondhFZNQgfR5e",
      "server_state": "proposing",
      "validated_ledger": {
        "age": 12,
        "base_fee_stm": 1e-05,
        "hash": "5BED1224009D5FC996B41A5E95041286596346D96DD8F6B4DF18DDD4FC65F54C",
        "reserve_base_stm": 1,
        "reserve_inc_stm": 0.1,
        "seq": 168922
      },
      "validation_quorum": 2
    }
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "info": {
      "build_version": "0.1.0",
      "complete_ledgers": "2-168922",
      "hostid": "MOS",
      "io_latency_ms": 1,
      "last_close": {
        "converge_time_s": 2.001,
        "proposers": 2
      },
      "load_factor": 1,
      "peers": 2,
      "pubkey_node": "n9KeFY9ZAmhuk2CDdKthcMhcZLhhaBrCFKSNAc1ondhFZNQgfR5e",
      "server_state": "proposing",
      "validated_ledger": {
        "age": 12,
        "base_fee_stm": 1e-05,
        "hash": "5BED1224009D5FC996B41A5E95041286596346D96DD8F6B4DF18DDD4FC65F54C",
        "reserve_base_stm": 1,
        "reserve_inc_stm": 0.1,
        "seq": 168922
      },
      "validation_quorum": 2
    }
  },
  "status": "success",
  "type": "response"
}

Note: If the closed_ledger field is present and the seq value is small (less than 8 bits), it indicates that streamd does not currently have a copy of the verified ledger from the peer network. This probably means your server is still syncing. Typically, network synchronization takes approximately 5 minutes, depending on connection speed and hardware specifications.

• Any common error type.

The server_state command asks the server for various machine-readable information about the streamd server's current state. The result is almost the sameserver_info, but in units that are easier to handle than easier to read. (For example, STM values are given in integer decimals, not scientific notation or decimal values, and times are in milliseconds, not seconds.)

Example of request format:

{
  "id": 2,
  "command": "server_state"
}

{
    "method": "server_state",
    "params": [
        {}
    ]
}

#Syntax: server_state
streamd server_state

This request does not require any parameters.

An example of a successful response:

{
  "id": 2,
  "result": {
    "state": {
      "build_version": "0.1.0",
      "complete_ledgers": "2-168954",
      "io_latency_ms": 1,
      "last_close": {
        "converge_time": 2001,
        "proposers": 2
      },
      "load_base": 256,
      "load_factor": 256,
      "peers": 2,
      "pubkey_node": "n9KiKNomfCpaMgocLawVjQv7VvvBbDTw1Kcy8YMTNJJBdoQM4sGZ",
      "server_state": "proposing",
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 575963230,
        "hash": "16388D25CD429747F753DF68438FC8C0173AAF4F971870C4B0A4625530C178F8",
        "reserve_base": 1000000,
        "reserve_inc": 100000,
        "seq": 168954
      },
      "validation_quorum": 2
    }
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "state": {
      "build_version": "0.1.0",
      "complete_ledgers": "2-168954",
      "io_latency_ms": 1,
      "last_close": {
        "converge_time": 2001,
        "proposers": 2
      },
      "load_base": 256,
      "load_factor": 256,
      "peers": 2,
      "pubkey_node": "n9KiKNomfCpaMgocLawVjQv7VvvBbDTw1Kcy8YMTNJJBdoQM4sGZ",
      "server_state": "proposing",
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 575963230,
        "hash": "16388D25CD429747F753DF68438FC8C0173AAF4F971870C4B0A4625530C178F8",
        "reserve_base": 1000000,
        "reserve_inc": 100000,
        "seq": 168954
      },
      "validation_quorum": 2
    }
  },
  "status": "success",
  "type": "response"
}

Responses follow a standard format, with successful results containing a state object as the only field.

The state object may have the following fields:

Possible errors:

• Any common error type.

With the online_delete and advisory_delete configuration options enabled, the can_delete method notifies the ripple server of the latest ledger that may have been deleted.

The can_delete method is an administrator command that cannot be run by unprivileged users.

Example of request format:

{
  "id": 2,
  "command": "can_delete",
  "can_delete": 11320417
}

{
    "method": "can_delete",
    "params": [
        {
            "can_delete": 11320417
        }
    ]
}

#Syntax can_delete [<ledger_index>|<ledger_hash>|now|always|never]
streamd can_delete 11320417

The request contains the following optional parameters:

If no parameters are specified, no changes are made.

Responses follow the standard format, with successful results containing the following fields:

Use this command without parameters to query existing can_delete settings.

Possible errors:

• Any common error type.
• notEnabled - Not enabled in configuration.
• notReady - Not ready to handle this request.
• lgrNotFound - ledger not found.
• invalidParams - Invalid parameters.

{
    "id": 99,
    "command": "consensus_info"
}

{
    "method": "consensus_info",
    "params": [
        {}
    ]
}

#Syntax: consensus_info
streamd consensus_info

{
   "result" : {
      "info" : {
         "acquired" : {
            "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired"
         },
         "close_granularity" : 10,
         "close_percent" : 50,
         "close_resolution" : 10,
         "close_times" : {
            "486082972" : 1,
            "486082973" : 4
         },
         "current_ms" : 1003,
         "have_time_consensus" : false,
         "ledger_seq" : 13701086,
         "our_position" : {
            "close_time" : 486082973,
            "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
            "propose_seq" : 0,
            "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
         },
         "peer_positions" : {
            "5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : {
               "close_time" : 486082973,
               "peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C",
               "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
               "propose_seq" : 0,
               "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
            },
            "EFC49EB648E557CC50A72D715249B80E071F7705" : {
               "close_time" : 486082973,
               "peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
               "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
               "propose_seq" : 0,
               "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
            }
         },
         "previous_mseconds" : 2005,
         "previous_proposers" : 5,
         "proposers" : 5,
         "proposing" : false,
         "state" : "consensus",
         "synched" : true,
         "validating" : false
      },
      "status" : "success"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "info" : {
         "acquired" : {
            "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired"
         },
         "close_granularity" : 10,
         "close_percent" : 50,
         "close_resolution" : 10,
         "close_times" : {
            "486082972" : 1,
            "486082973" : 4
         },
         "current_ms" : 1003,
         "have_time_consensus" : false,
         "ledger_seq" : 13701086,
         "our_position" : {
            "close_time" : 486082973,
            "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
            "propose_seq" : 0,
            "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
         },
         "peer_positions" : {
            "5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : {
               "close_time" : 486082973,
               "peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C",
               "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
               "propose_seq" : 0,
               "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
            },
            "EFC49EB648E557CC50A72D715249B80E071F7705" : {
               "close_time" : 486082973,
               "peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
               "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
               "propose_seq" : 0,
               "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
            }
         },
         "previous_mseconds" : 2005,
         "previous_proposers" : 5,
         "proposers" : 5,
         "proposing" : false,
         "state" : "consensus",
         "synched" : true,
         "validating" : false
      },
      "status" : "success"
   }
}

• Any common error type.

{
    "id": 91,
    "command": "fetch_info",
    "clear": false
}

{
    "method": "fetch_info",
    "params": [
        {
            "clear": false
        }
    ]
}

#Syntax: fetch_info [clear]
streamd fetch_info

{
   "result" : {
      "info" : {
         "348928" : {
            "hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010",
            "have_header" : true,
            "have_state" : false,
            "have_transactions" : true,
            "needed_state_hashes" : [
               "BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922",
               "34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F",
               "BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765",
               "41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975",
               "6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA",
               "6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF",
               "1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7",
               "FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640",
               "19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033",
               "5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9",
               "DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9",
               "3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0",
               "0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3",
               "4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE",
               "08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4",
               "779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE"
            ],
            "peers" : 2,
            "timeouts" : 0
         }
      },
      "status" : "success"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "info" : {
         "348928" : {
            "hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010",
            "have_header" : true,
            "have_state" : false,
            "have_transactions" : true,
            "needed_state_hashes" : [
               "BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922",
               "34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F",
               "BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765",
               "41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975",
               "6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA",
               "6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF",
               "1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7",
               "FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640",
               "19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033",
               "5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9",
               "DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9",
               "3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0",
               "0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3",
               "4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE",
               "08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4",
               "779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE"
            ],
            "peers" : 2,
            "timeouts" : 0
         }
      },
      "status" : "success"
   }
}

• Any common error type.

{
  "id": "list_all_features",
  "command": "feature"
}

{
  "id": "reject_multi_sign",
  "command": "feature",
  "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373",
  "vetoed": true
}

{
    "method": "feature",
    "params": [
        {
            "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373",
            "vetoed": false
        }
    ]
}

#Syntax: feature [<feature_id> [accept|reject]]
streamd feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373 accept

Note: You can configure the server to support a new amendment by specifying its ID in the feature field, even if the server does not yet know how to apply it. For example, you may want to do this if you plan to upgrade soon to a streamd version that supports the amendment.

{
  "id": "list_all_features",
  "status": "success",
  "type": "response",
  "result": {
    "features": {
      "42426C4D4F1009EE67080A9B7965B44656D7714D104A72F9B4369F97ABF044EE": {
        "enabled": false,
        "name": "FeeEscalation",
        "supported": true,
        "vetoed": false
      },
      "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
        "enabled": false,
        "name": "MultiSign",
        "supported": true,
        "vetoed": false
      },
      "6781F8368C4771B83E8B821D88F580202BCB4228075297B19E4FDC5233F1EFDC": {
        "enabled": false,
        "name": "TrustSetAuth",
        "supported": true,
        "vetoed": false
      }
    }
  }
}

{
    "id": "reject_multi_sign",
    "status": "success",
    "type": "response",
    "result": {
        "features": {
            "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
                "enabled": false,
                "name": "MultiSign",
                "supported": true,
                "vetoed": true
            }
        }
    }
}

200 OK
{
    "result": {
        "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
            "enabled": false,
            "name": "MultiSign",
            "supported": true,
            "vetoed": false
        },
        "status": "success"
    }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
    "result": {
        "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
            "enabled": false,
            "name": "MultiSign",
            "supported": true,
            "vetoed": false
        },
        "status": "success"
    }
}

Note: The name of an amendment does not strictly indicate what the amendment does. The name is not guaranteed to be unique or consistent between servers.

• Any universal error type.
• badFeature - The format specified by feature is invalid, or the server does not know a revision with that name.

{
    "id": 90,
    "command": "get_counts",
    "min_count": 100
}

{
    "method": "get_counts",
    "params": [
        {
            "min_count": 100
        }
    ]
}

#Syntax: get_counts [min_count]
streamd get_counts 100

{
   "result" : {
      "AL_hit_rate" : 48.36725616455078,
      "HashRouterEntry" : 3048,
      "Ledger" : 46,
      "NodeObject" : 10417,
      "SLE_hit_rate" : 64.62035369873047,
      "STArray" : 1299,
      "STLedgerEntry" : 646,
      "STObject" : 6987,
      "STTx" : 4104,
      "STValidation" : 610,
      "Transaction" : 4069,
      "dbKBLedger" : 10733,
      "dbKBTotal" : 39069,
      "dbKBTransaction" : 26982,
      "fullbelow_size" : 0,
      "historical_perminute" : 0,
      "ledger_hit_rate" : 71.0565185546875,
      "node_hit_rate" : 3.808214902877808,
      "node_read_bytes" : 393611911,
      "node_reads_hit" : 1283098,
      "node_reads_total" : 679410,
      "node_writes" : 1744285,
      "node_written_bytes" : 794368909,
      "status" : "success",
      "treenode_cache_size" : 6650,
      "treenode_track_size" : 598631,
      "uptime" : "3 hours, 50 minutes, 27 seconds",
      "write_load" : 0
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "AL_hit_rate" : 48.36725616455078,
      "HashRouterEntry" : 3048,
      "Ledger" : 46,
      "NodeObject" : 10417,
      "SLE_hit_rate" : 64.62035369873047,
      "STArray" : 1299,
      "STLedgerEntry" : 646,
      "STObject" : 6987,
      "STTx" : 4104,
      "STValidation" : 610,
      "Transaction" : 4069,
      "dbKBLedger" : 10733,
      "dbKBTotal" : 39069,
      "dbKBTransaction" : 26982,
      "fullbelow_size" : 0,
      "historical_perminute" : 0,
      "ledger_hit_rate" : 71.0565185546875,
      "node_hit_rate" : 3.808214902877808,
      "node_read_bytes" : 393611911,
      "node_reads_hit" : 1283098,
      "node_reads_total" : 679410,
      "node_writes" : 1744285,
      "node_written_bytes" : 794368909,
      "status" : "success",
      "treenode_cache_size" : 6650,
      "treenode_track_size" : 598631,
      "uptime" : "3 hours, 50 minutes, 27 seconds",
      "write_load" : 0
   }
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.

The ledger_cleaner command controls the Ledger Cleaner, an asynchronous maintenance process that finds and repairs corruption in the streamd ledger database.

The ledger_cleaner method is an administrator command that cannot be run by unprivileged users.

Example of request format:

{
    "command": "ledger_cleaner",
    "max_ledger": 13818756,
    "min_ledger": 13818000,
    "stop": false
}

The request contains the following parameters:

An example of a successful response:

200 OK
{
   "result" : {
      "message" : "Cleaner configured",
      "status" : "success"
   }
}

Responses follow a standard format, with successful results containing the following fields:

Possible errors:

• Any common error type.
• internalIf a parameter is specified incorrectly. (This is an error; the expected error code is invalidParams.)

{
    "id": "ll1",
    "command": "log_level",
    "severity": "debug",
    "partition": "PathRequest"
}

#Syntax: log_level [[partition] severity]
streamd log_level PathRequest debug

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "status" : "success"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "levels" : {
         "AmendmentTable" : "Error",
         "Application" : "Error",
         "CancelOffer" : "Error",
         "Collector" : "Error",
         "CreateOffer" : "Error",
         "DeferredCredits" : "Error",
         "FeeVote" : "Error",
         "InboundLedger" : "Error",
         "JobQueue" : "Error",
         "Ledger" : "Error",
         "LedgerCleaner" : "Error",
         "LedgerConsensus" : "Error",
         "LedgerEntrySet" : "Error",
         "LedgerMaster" : "Error",
         "LedgerTiming" : "Error",
         "LoadManager" : "Error",
         "LoadMonitor" : "Error",
         "NetworkOPs" : "Error",
         "NodeObject" : "Error",
         "OrderBookDB" : "Error",
         "Overlay" : "Error",
         "PathRequest" : "Debug",
         "Payment" : "Error",
         "Peer" : "Error",
         "PeerFinder" : "Error",
         "Protocol" : "Error",
         "RPC" : "Error",
         "RPCErr" : "Error",
         "RPCHandler" : "Error",
         "RPCManager" : "Error",
         "Resolver" : "Error",
         "Resource" : "Error",
         "StreamCalc" : "Error",
         "SHAMap" : "Error",
         "SHAMapStore" : "Error",
         "SNTPClient" : "Error",
         "STAmount" : "Error",
         "SerializedLedger" : "Error",
         "Server" : "Error",
         "SetAccount" : "Error",
         "SetTrust" : "Error",
         "TaggedCache" : "Error",
         "TransactionAcquire" : "Error",
         "TransactionEngine" : "Error",
         "UVL" : "Error",
         "UniqueNodeList" : "Error",
         "Validations" : "Error",
         "WALCheckpointer" : "Error",
         "WebSocket" : "Trace",
         "base" : "Error"
      },
      "status" : "success"
   }
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.

{
    "id": 0,
    "command": "validation_create",
    "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
}

{
    "method": "validation_create",
    "params": [
        {
            "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
        }
    ]
}

#Syntax: validation_create [secret]
streamd validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"

Note: The security of the validator depends on the entropy of your seed. Do not use secret values ​​for practical business purposes unless generating strong randomness. Stream recommends that secret be omitted when generating new credentials for the first time.

{
   "result" : {
      "status" : "success",
      "validation_key" : "FAWN JAVA JADE HEAL VARY HER REEL SHAW GAIL ARCH BEN IRMA",
      "validation_public_key" : "n9Mxf6qD4J55XeLSCEpqaePW4GjoCR5U1ZeGZGJUCNe3bQa4yQbG",
      "validation_seed" : "ssZkdwURFMBXenJPbrpE14b6noJSu"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "status" : "success",
      "validation_key" : "FAWN JAVA JADE HEAL VARY HER REEL SHAW GAIL ARCH BEN IRMA",
      "validation_public_key" : "n9Mxf6qD4J55XeLSCEpqaePW4GjoCR5U1ZeGZGJUCNe3bQa4yQbG",
      "validation_seed" : "ssZkdwURFMBXenJPbrpE14b6noJSu"
   }
}

• Any common error type.
• badSeed - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string in a different format, such as an account address or a verification public key.

The logrotate command closes and reopens the log file. This is intended to aid log rotation on Linux file systems.

The logrotate method is an admin command that cannot be run by non-privileged users.

Example of request format:

{
    "id": "lr1",
    "command": "logrotate"
}

streamd logrotate

The request does not contain parameters.

An example of a successful response:

200 OK
{
   "result" : {
      "message" : "The log file was closed and reopened.",
      "status" : "success"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "message" : "The log file was closed and reopened.",
      "status" : "success"
   }
}

Responses follow a standard format, with successful results containing the following fields:

Possible errors:

• Any common error type.

The validation_seed command temporarily sets the secret value used by streamd for sign verification. When the server is restarted, this value will be reset according to the configuration file.

This validation_seed request is an admin command that cannot be run by an unprivileged user!

Example of request format:

{
    "id": "set_seed_1",
    "command": "validation_seed",
    "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
}

#Syntax: validation_seed [secret]
streamd validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'

The request contains the following parameters:

An example of a successful response:

200 OK
{
   "result" : {
      "status" : "success",
      "validation_key" : "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE",
      "validation_public_key" : "n9Jx6RS6zSgqsgnuWJifNA9EqgjTKAywqYNReK5NRd1yLBbfC3ng",
      "validation_seed" : "snjJkyBGogTem5dFGbcRaThKq2Rt3"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "status" : "success",
      "validation_key" : "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE",
      "validation_public_key" : "n9Jx6RS6zSgqsgnuWJifNA9EqgjTKAywqYNReK5NRd1yLBbfC3ng",
      "validation_seed" : "snjJkyBGogTem5dFGbcRaThKq2Rt3"
   }
}

Responses follow a standard format, with successful results containing the following fields:

Possible errors:

• Any common error type.
• badSeed - The request provided an invalid secret value. This usually means that the secret value appears to be a valid string in a different format, such as an account address or a verification public key.

{
    "id": 2,
    "command": "peers"
}

streamd peers

{
  "id": 2,
  "status": "success",
  "type": "response",
  "result": {
    "cluster": {},
    "peers": [
      {
        "address": "1.1.1.1:51235",
        "complete_ledgers": "18828845 - 18828973",
        "latency": 99,
        "ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
        "load": 60,
        "public_key": "n9LDBRoqPYY7RdkNXbX1dqZXVtUKcSqzs2CZPhTH7ymA9X7Xzmpj",
        "uptime": 99625,
        "version": "streamd-0.30.1-rc4"
      }
    ]
  }
}

{
   "result" : {
      "cluster" : {},
      "peers" : [
         {
            "address" : "1.1.1.1:51235",
            "complete_ledgers" : "18828830 - 18828957",
            "latency" : 137,
            "ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
            "load" : 54,
            "public_key" : "n9LDBRoqPYY7RdkNXbX1dqZXVtUKcSqzs2CZPhTH7ymA9X7Xzmpj",
            "uptime" : 99566,
            "version" : "streamd-0.30.1-rc4"
         }
      ],
      "status" : "success"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "cluster" : {},
      "peers" : [
         {
            "address" : "5.1.1.1:51235",
            "complete_ledgers" : "18850253 - 18851277",
            "latency" : 63,
            "ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
            "load" : 36,
            "public_key" : "n9MT5EjnV912KGuBUqPs4tpdhzMPGcnDBrTuWkD9sWQHJ1kDcUcz",
            "uptime" : 51,
            "version" : "streamd-0.30.1"
         }
      ],
      "status" : "success"
   }
}

• Any common error type.

{
    "id": "print_req_1",
    "command": "print"
}

streamd print

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "app" : {
         "ledgercleaner" : {
            "status" : "idle"
         },
         "peers" : {
            "peerfinder" : {
               "bootcache" : {
                  "entries" : 109
               },
               "config" : {
                  "auto_connect" : "true",
                  "features" : "",
                  "max_peers" : 21,
                  "out_peers" : 10,
                  "port" : 51235,
                  "want_incoming" : "true"
               },
               "counts" : {
                  "accept" : 0,
                  "close" : 0,
                  "cluster" : "0",
                  "connect" : 0,
                  "fixed" : "0",
                  "in" : "0/11",
                  "out" : "10/10",
                  "total" : "10"
               },
               "fixed" : 0,
               "livecache" : {
                  "entries" : [
                     {
                        "address" : "1.1.1.1:51235",
                        "expires" : "30000000000 nanoseconds",
                        "hops" : 2
                     }
                  ],
                  "hist" : "0, 10, 74, 10, 0, 0, 0, 0",
                  "size" : "94"
               },
               "peers" : [
                  {
                     "local_address" : "10.1.10.78:48923",
                     "remote_address" : "2.2.2.3:51235",
                     "state" : "active"
                  }
               ]
            }
         },
         "resource" : {
            "admin" : [
               {
                  "balance" : 0,
                  "count" : 1,
                  "name" : "\"127.0.0.1\""
               }
            ],
            "inactive" : [],
            "inbound" : [],
            "outbound" : [
               {
                  "balance" : 23,
                  "count" : 1,
                  "name" : "1.1.1.1:51235"
               }
            ]
         },
         "server" : {
            "active" : "2",
            "hist" : "16",
            "history" : [
               {
                  "bytes_in" : "214",
                  "bytes_out" : "11688",
                  "elapsed" : "0 seconds",
                  "id" : "16",
                  "requests" : 1,
                  "when" : "2017-Jun-16 16:33:50"
               }
            ]
         },
         "validators" : {}
      },
      "status" : "success"
   }
}

• Any common error type.

streamdThe server also provides some commands purely for convenience.

{
    "id": 1,
    "command": "ping"
}

{
    "method": "ping",
    "params": [
        {}
    ]
}

#Syntax: ping
streamd ping

{
  "id": 1,
  "result": {},
  "status": "success",
  "type": "response"
}

200 OK
{
    "result": {
        "status": "success"
    }
}

• Any common error type.

The random command provides a random number that is used as a source of entropy for client-generated random numbers.

Example of request format:

{
    "id": 1,
    "command": "random"
}

{
    "method": "random",
    "params": [
        {}
    ]
}

#Syntax: random
streamd random

The request does not contain parameters.

An example of a successful response:

{
  "id": 1,
  "result": {
    "random": "02869CBC0E17C3039944B24FD1932E65B8E0A4B99F80CBCDC39AE79A2356CEF9"
  },
  "status": "success",
  "type": "response"
}

200 OK
{
  "result": {
    "random": "02869CBC0E17C3039944B24FD1932E65B8E0A4B99F80CBCDC39AE79A2356CEF9"
  },
  "status": "success"
}

Responses follow a standard format, with successful results containing the following fields:

Possible errors:

• Any common error type.
• internal - Some internal error occurred, possibly related to the random number generator.

The json method is a proxy for running other commands and accepts the parameters of that command as JSON values. It is exclusive to the Commandline client and is used when the command line syntax for specifying parameters is insufficient or undesirable.

Example of request format:

# Syntax: json method json_stanza
streamd -q json ledger_closed '{}'

An example of a successful response:

{
   "result" : {
      "ledger_hash" : "8047C3ECF1FA66326C1E57694F6814A1C32867C04D3D68A851367EE2F89BBEF3",
      "ledger_index" : 390308,
      "status" : "success"
   }
}

Responses follow a standard format, regardless of which fields are appropriate for the type of command being executed.

{
    "command": "connect",
    "ip": "192.168.145.88",
    "port": 51235
}

{
    "method": "connect",
    "params": [
        {
            "ip": "192.168.145.88",
            "port": 51235
        }
    ]
}

#Syntax: connect ip [port]
streamd connect 192.168.145.88 51235

{
   "result" : {
      "message" : "connecting",
      "status" : "success"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "message" : "connecting",
      "status" : "success"
   }
}

• Any common error type.
• invalidParams - One or more fields were specified incorrectly, or one or more required fields are missing.
• Unable to connect in standalone mode - Network-related commands are disabled in standalone mode.

Gracefully shut down the server.

This stop request is an administrative command that cannot be run by an unprivileged user!

Example of request format:

{
    "id": 0,
    "command": "stop"
}

{
    "method": "stop",
    "params": [
        {}
    ]
}

streamd stop

The request does not contain parameters.

An example of a successful response:

{
   "result" : {
      "message" : "stream server stopping",
      "status" : "success"
   }
}

Loading: "/etc/streamd.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "message" : "stream server stopping",
      "status" : "success"
   }
}

Responses follow a standard format, with successful results containing the following fields:

Possible errors:

• Any common error type.