Parameters

object

object

REQUIRED

The gateway_balances request object.

account

string

REQUIRED

The account for which balances are to be retrieved

ledger_index

string

The index of the ledger to retrieve the balances from

strict

boolean

A boolean flag indicating whether strict validation should be applied

Returns

result

object

An object which contains the following fields:

account

string

The account for which balances were retrieved

obligations

object

(Optional) (Omitted if empty) The total amounts issued to addresses not excluded are returned as a map of currencies to the total value issued

<dynamic_key>

string

Currency code mapped to total issued amount

balances

array

(Optional) (Omitted if empty) The amounts issued to the hot wallet addresses specified in the request are returned as a separate field

assets

object

(Optional) (Omitted if empty) Total amounts held that are issued by others

<dynamic_key>

array

Account address mapped to issued asset balances

currency

string

The currency code

value

string

The balance amount

ledger_index

integer

The index of the ledger from which balances were retrieved

ledger_hash

string

The hash of the ledger containing the balances

ledger_current_index

string

(Optional) Omitted if ledger_current_index is provided) The ledger index of the current in-progress ledger version used to retrieve this information

validated

boolean

(Optional) Indicates if the information is from a validated ledger

status

string

The status of the request

warnings

array

(Optional) An object of warning which contain the following fields. Returned at the JSON-RPC response root on some servers and omitted from the result object

id

integer

The ID of the warning

message

string

The warning message

Request

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "gateway_balances",
6
  "params": [
7
    {
8
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
9
      "ledger_index": "validated",
10
      "strict": true
11
    }
12
  ],
13
  "id": 1
14
}'

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "gateway_balances",
6
  "params": [
7
    {
8
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
9
      "ledger_index": "validated",
10
      "strict": true
11
    }
12
  ],
13
  "id": 1
14
}'

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'gateway_balances',
4
    params: [{"account":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn","ledger_index":"validated","strict":true}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'gateway_balances',
4
    params: [{"account":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn","ledger_index":"validated","strict":true}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "gateway_balances",
9
  "params": [
10
    {
11
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
12
      "ledger_index": "validated",
13
      "strict": True
14
    }
15
  ],
16
  "id": 1
17
})
18
headers = {
19
  'Content-Type': 'application/json'
20
}
21

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

24
print(response.text)

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "gateway_balances",
9
  "params": [
10
    {
11
      "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
12
      "ledger_index": "validated",
13
      "strict": True
14
    }
15
  ],
16
  "id": 1
17
})
18
headers = {
19
  'Content-Type': 'application/json'
20
}
21

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

24
print(response.text)

1
require "uri"
2
require "json"
3
require "net/http"
4

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

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "gateway_balances",
11
  params: [{"account":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn","ledger_index":"validated","strict":true}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

1
require "uri"
2
require "json"
3
require "net/http"
4

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

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "gateway_balances",
11
  params: [{"account":"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn","ledger_index":"validated","strict":true}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

Response

1
{
2
  "result": {
3
    "obligations": {
4
      "USD": "14.0301"
5
    },
6
    "assets": {
7
      "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q": [
8
        {
9
          "currency": "USD",
10
          "value": "0.0001"
11
        }
12
      ]
13
    },
14
    "locked": {
15
      "XRP": "127777"
16
    },
17
    "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
18
    "ledger_index": 102609804,
19
    "ledger_hash": "7735091DF9F32511F41AD963A8BDE4AF24B27D3AA3946903A31E3CFF2B948217",
20
    "status": "success"
21
  },
22
  "warnings": [
23
    {
24
      "id": 2001,
25
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
26
    }
27
  ]
28
}

1
{
2
  "result": {
3
    "obligations": {
4
      "USD": "14.0301"
5
    },
6
    "assets": {
7
      "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q": [
8
        {
9
          "currency": "USD",
10
          "value": "0.0001"
11
        }
12
      ]
13
    },
14
    "locked": {
15
      "XRP": "127777"
16
    },
17
    "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
18
    "ledger_index": 102609804,
19
    "ledger_hash": "7735091DF9F32511F41AD963A8BDE4AF24B27D3AA3946903A31E3CFF2B948217",
20
    "status": "success"
21
  },
22
  "warnings": [
23
    {
24
      "id": 2001,
25
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
26
    }
27
  ]
28
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free