List all Accounts REST API Endpoint

Please note that this method can be used in streaming mode. To read more about this, visit the streaming section.

Query Parameters

sponsor

string

REQUIRED

An account ID of the sponsor. It is required to provide one of the four values - signer, asset, liquidity pool, or sponsor

asset

string

An asset type associated with the accounts

signer

string

An account ID of the signer

liquidity_pool

string

Using this parameter, the results will include only accounts which have trustlines to the specified liquidity pool

cursor

integer

A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record

order

string

The order of the returned data. The possible value includes ascending and descending order

limit

integer

The maximum number of records to return

Returns

_links

object

The links related to the account data

self

object

The self-reference link

href

string

The URL for self-reference

object

Link to the next set of data

href

string

The URL for next set of data

object

Link to the previous set of data

href

string

The URL for previous set of data

_embedded

object

The embedded account records

records

array

An array of account records

_links

object

The links related to the account record

self

object

The self-reference link

href

string

The URL for self-reference

templated

boolean

A boolean value that indicates whether the link is templated or not

transactions

object

Link to transactions related to the account

href

string

The URL for transactions related to the account

templated

boolean

A boolean value that indicates whether the link is templated or not

operations

object

Link to operations related to the account

href

string

The URL for operations related to the account

templated

boolean

A boolean value that indicates whether the link is templated or not

payments

object

Link to payments related to the account

href

string

The URL for payments related to the account

templated

boolean

A boolean value that indicates whether the link is templated or not

effects

object

Link to effects related to the account

href

string

The URL for effects related to the account

templated

boolean

A boolean value that indicates whether the link is templated or not

offers

object

Link to offers related to the account

href

string

The URL for offers related to the account

templated

boolean

A boolean value that indicates whether the link is templated or not

trades

object

Link to trades related to the account

href

string

The URL for trades related to the account

templated

boolean

A boolean value that indicates whether the link is templated or not

data

object

Link to account data related to specific keys

href

string

The URL for account data related to specific keys

templated

boolean

A boolean value that indicates whether the link is templated or not

string

The Account ID

account_id

string

The Account ID

sequence

string

The account sequence number

sequence_ledger

string

The account sequence number associated with the ledger

sequence_time

string

The account sequence number associated with a timestamp

subentry_count

integer

The number of subentries in the account

inflation_destination

string

The account designated to receive inflation

home_domain

string

The home domain associated with the account

last_modified_ledger

integer

The ledger ID of the last modification

last_modified_time

string

The timestamp of the last modification

thresholds

object

The threshold values for the account

low_threshold

integer

The low threshold value

med_threshold

integer

The medium threshold value

high_threshold

integer

The high threshold value

flags

object

The flags associated with the account

auth_required

boolean

A boolean value that indicates whether authorization is required or not

auth_revocable

boolean

A boolean value that indicates whether authorization is revocable or not

auth_immutable

boolean

A boolean value that indicates whether authorization is immutable or not

auth_clawback_enabled

boolean

A boolean value that indicates whether authorization clawback is enabled or not

balances

array

An array of balance information

balance

string

The current balance

limit

string

The balance limit

buying_liabilities

string

The buying liabilities

selling_liabilities

string

The selling liabilities

last_modified_ledger

integer

The ledger ID of last modification

is_authorized

boolean

A boolean value that indicates whether the account is authorized or not

is_authorized_to_maintain_liabilities

boolean

A boolean value that indicates whether the account is authorized to maintain liabilities

asset_type

string

The type of asset

asset_code

string

An asset code

asset_issuer

string

An asset issuer

signers

array

An array of signers associated with the account

weight

integer

The signer weight

key

string

The signer's public key

type

string

The type of signer key

sponsor

string

The sponsor key

data

object

The account data associated with specific keys

dataurl

object

The account data url associated with the specific keys

num_sponsoring

integer

The number of accounts sponsored by this account

num_sponsored

integer

The number of accounts that sponsor this account

paging_token

string

The paging token

Request

curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/accounts?sponsor=GCIYTA7LEWMA3LFSJKVVIMBDKSR65R7DNZLBNIEEGJHDNOXJXICGYQSZ' \
-H 'Accept: application/json'

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

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

import requests

url = "https://docs-demo.stellar-mainnet.quiknode.pro/accounts?sponsor=GCIYTA7LEWMA3LFSJKVVIMBDKSR65R7DNZLBNIEEGJHDNOXJXICGYQSZ"

payload = {}
headers = {
  'Accept': 'application/json'
}

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

print(response.text)

require "uri"
require "net/http"

url = URI("https://docs-demo.stellar-mainnet.quiknode.pro/accounts?sponsor=GCIYTA7LEWMA3LFSJKVVIMBDKSR65R7DNZLBNIEEGJHDNOXJXICGYQSZ")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"

response = http.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

List all Accounts REST API Endpoint

Lists all accounts based on one of four filters - signer, asset, liquidity pool, or sponsor

Query Parameters

Returns