account_offers RPC Method

Parameters

account

string

REQUIRED

The XRP Ledger account for which the offers are to be retrieved

ledger_index

string

The ledger index of the ledger to use

ledger_hash

string

A 20-byte hex string for identifying the ledger version

limit

integer

Limit the number of offers to retrieve

marker

string

The value from a previous paginated response

strict

boolean

If set to true, only a public key or XRP Ledger address is accepted in the account field. Using a secret or passphrase is not recommended. Default is false

Returns

result

object

The method returns a JSON object with the following properties:

account

string

The XRP Ledger account

limit

integer

The maximum number of offers to return

ledger_hash

string

The hash of the ledger containing the offers

ledger_index

integer

The index of the ledger containing the offers

ledger_current_index

integer

(Omitted if ledger_hash or ledger_index provided) The ledger index of the current in-progress ledger version, which was used when retrieving this data

offers

array

A list of open offers placed by the account

flags

integer

The flags associated with the offer

quality

string

The exchange rate i.e the ratio of the original 'taker_pays' divided by the original 'taker_gets'

seq

integer

The sequence number of the transaction that created the entry

taker_gets

string

The amount the account accepting the offer receives

taker_pays

string

The amount the account accepting the offer provides

validated

boolean

A boolean flag indicating if the information is from a validated ledger

status

string

The status of the request

marker

The value from the paginated response

warnings

array

A list of warnings

id

integer

The warning ID

message

string

The warning message

Request

curl https://docs-demo.xrp-mainnet.quiknode.pro/ \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
    "method": "account_offers",
	"params": [{
        "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
    }],"id":1,"jsonrpc":"2.0"}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "method": "account_offers",
  "params": [
    {
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://docs-demo.xrp-mainnet.quiknode.pro/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests
import json

url = "https://docs-demo.xrp-mainnet.quiknode.pro/"

payload = json.dumps({
  "method": "account_offers",
  "params": [
    {
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "json"
require "net/http"

url = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "method": "account_offers",
  "params": [
    {
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
    }
  ],
  "id": 1,
  "jsonrpc": "2.0"
})

response = https.request(request)
puts response.read_body

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free