RippleAPI

connect(callback)
disconnect(callback)
isConnected()
getServerInfo(callback)
getFee()
getLedgerVersion()
getTransaction( identifier, options, callback) +
identifier: txhash options: {minLedgerVersion: int, maxLedgerVersion: int}
getTransactions( account, options, callback) +
options: { start: txhash, limit: int, minLedgerVersion: int, maxLedgerVersion: int, earliestFirst: bool, excludeFailures: bool, initiated: bool, counterparty: address, types: [string], binary: bool }
getTrustlines( account, options, callback) +
options: {counterparty: address, currency: string, limit: int, ledgerVersion: int}
getBalances( account, options, callback) +
options: {counterparty: address, currency: string, limit: int, ledgerVersion: int}
getPaths( pathfind, callback) +
pathfind: { source: { address: address, currencies: [{ currency: string, counterparty: address }] }, destination: adjustment } adjustment = {address: address, amount: amount, tag?: int} amount = {currency: string, counterparty: address, value: floatstr}
getOrders( account, options, callback) +
options: {limit: int, ledverVersion: int}
getOrderbook( account, orderbook, options, callback) +
orderbook: { base: { currency, counterparty }, counter: { currency, counterparty } } options: {limit: int, ledverVersion: int}
getSettings( account, options, callback) +
options: {ledgerVersion: int}
getAccountInfo( account, options, callback) +
options: {ledgerVersion: int}
preparePayment( account, payment, instructions, callback) +
payment: { source: adjustment, destination: adjustment, paths?: string, slippage?: strfloat, memos?: [{ type: string, format: string, data: string }], invoiceID?: hash256, allowPartialPayment?: bool, noDirectRipple?: bool, limitQuality?: bool } adjustment = {address: address, amount: amount, tag?: int} amount = {currency: string, counterparty: address, value: floatstr} instructions: { sequence: int, fee: floatstr, maxFee: floatstr, maxLedgerVersion: int, maxLedgerVersionOffset: int }
prepareTrustline( account, trustline, instructions, callback) +
trustline: { currency: string, counterparty: address, limit: strfloat, qualityIn?: float, qualityOut?: float, allowRippling?: bool, authorized?: bool, frozen?: bool } instructions: { sequence: int, fee: floatstr, maxFee: floatstr, maxLedgerVersion: int, maxLedgerVersionOffset: int }
prepareOrder( account, order, instructions, callback) +
order: { direction: ("buy"|"sell"), quantity: amount, totalPrice: amount, immediateOrCancel?: bool, fillOrKill?: bool, passive?: bool } amount = {currency: string, counterparty: address, value: floatstr} instructions: { sequence: int, fee: floatstr, maxFee: floatstr, maxLedgerVersion: int, maxLedgerVersionOffset: int }
prepareOrderCancellation( account, sequence, instructions, callback) +
sequence: int instructions: { sequence: int, fee: floatstr, maxFee: floatstr, maxLedgerVersion: int, maxLedgerVersionOffset: int }
prepareSettings( account, settings, instructions, callback) +
settings: { passwordSpent: bool, requireDestinationTag: bool, requireAuthorization: bool, disallowIncomingXRP: bool, disableMasterKey: bool, enableTransactionIDTracking: bool, noFreeze: bool, globalFreeze: bool, defaultRipple: bool, emailHash: hash128, walletLocator: hash256, walletSize: int, messageKey: string, domain: string, transferRate: float, signers: string, regularKey: address } instructions: { sequence: int, fee: floatstr, maxFee: floatstr, maxLedgerVersion: int, maxLedgerVersionOffset: int }
sign( txJSON, secret)
submit( txBlob, callback)
generateWallet()
errors