logo
API docs by Redocly

StellarExpert API (1.4.0)

E-mail: info@stellar.expert URL: https://stellar.expert/ License: MIT Terms of Service

Intro

StellarExpert Open APIs are publicly available for developers, free of charge.

Open API enpoints do not require authentication and can be used directly from the browser.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Rate Limiting and Caching Considerations

The effective API request rate may be a subject to rate limiting. In such cases the server returns 429 HTTP status code error. To avoid potential problems caused by those limitations it is advised to consider response caching or group queries on the caller side in case of heavy API utilization.

Directory API

Directory entries

Returns the list of directory entries with paging navigation links. Optionally filtered by address, tag, or arbitrary search string. This API endpoint follows Stellar Horizon API response format convention. A response result contains records and navigation links.

Query examples:

Fetch information about multiple accounts in one call

curl -g "https://api.stellar.expert/explorer/directory?address[]=GA6HCMBLTZS5VYYBCATRBRZ3BZJMAFUDKYYF6AH6MVCMGWMRDNSWJPIH&address[]=GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"

Search for Kraken's deposit account

curl "https://api.stellar.expert/explorer/directory?search=kraken"

Find accounts tagged as malicious or unsafe

curl -g "https://api.stellar.expert/explorer/directory?tag[]=malicious&tag[]=unsafe"

Lookup addresses reported for "staking"-related scams

curl -g "https://api.stellar.expert/explorer/directory?tag[]=malicious&search=stacking"

query Parameters
address
Array of strings (AccountAddress) [ 1 .. 50 ] items unique
Example: address=GA2VRL65L3ZFEDDJ357RGI3MAOKPJZ2Z3IJTPSC24I4KDTNFSVEQURRA

Applies a filter by the addresses list (up to 50 per request)

tag
Array of strings [ 1 .. 10 ] items unique
Example: tag=custodian&tag=anchor

Applies a filter by tags

search
string >= 5 characters

Applies a full-test search filter by an entry address, name, or domain

cursor
string (AccountAddress) /^G[ABCDEFGHIJKLMNOPQRSTUVWXYZ234567]{55}$/
Example: cursor=GAB6FD5BCBVVQINU5USYV5K4JDAEO6RDL2GZU4K5BILPI6B4FIOF6QWW

An address from which to continue search (refers to the paging_token value from a results set)

order
string (ResultsSortOrder)
Enum: "asc" "desc"
Example: order=desc

Results sorting order

limit
number (ResultsLimit) [ 1 .. 200 ]
Default: 10
Example: limit=10

Results data page size

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Address Directory info

Returns Directory information for a given account address.

path Parameters
address
required
string (AccountAddress) /^G[ABCDEFGHIJKLMNOPQRSTUVWXYZ234567]{55}$/
Example: GA2VRL65L3ZFEDDJ357RGI3MAOKPJZ2Z3IJTPSC24I4KDTNFSVEQURRA

The address of the account to check

Responses

Response samples

Content type
application/json
{
  • "address": "GA2VRL65L3ZFEDDJ357RGI3MAOKPJZ2Z3IJTPSC24I4KDTNFSVEQURRA",
  • "paging_token": "GA2VRL65L3ZFEDDJ357RGI3MAOKPJZ2Z3IJTPSC24I4KDTNFSVEQURRA",
  • "domain": "stellar.org",
  • "name": "SDF Escrow Jan 1 2023",
  • "tags": [
    ]
}

All Directory tags

Returns a list of all categories that can be used to tag accounts.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Blocked domains list

Returns the list of domains reported by the community for fraudulent acitivity. This API endpoint follows Stellar Horizon API response format convention. A response result contains records and navigation links.

query Parameters
search
string >= 2 characters
Example: search=org.ro

Case-insesitive search by domain or part of the domain

cursor
string

An address from which to continue search (refers to the paging_token value from a results set)

order
string (ResultsSortOrder)
Enum: "asc" "desc"
Example: order=desc

Results sorting order

limit
number (HugeResultsLimit) [ 1 .. 1000 ]
Default: 1000
Example: limit=100

Results data page size

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Check domain

Searches through the blocked malicious domains list to determine if the requested domain or its top-level domain is in the blocklist.

path Parameters
domain
required
string
Example: stellar.org.am

Domain to verify (case-insensitive)

Responses

Response samples

Content type
application/json
{
  • "domain": "sub.stellar.org.am",
  • "blocked": true
}

Payment Locator API

Asset Info API

List of assets

Returns a list of assets that exist on Stellar network. It support searching by asset code, issuer, home domain, and metadata from associated stellar.toml file.

Possible sorting options:

  • rating - composite asset rating derived from on-chain stats
  • created - asset age
  • payments - total number of payments
  • trades - total number of trades
  • trustlines - number of established trustlines
  • volume - overall trading volume
  • volume7d - weekly trading volume
path Parameters
network
required
string (Network)
Enum: "public" "testnet"
Example: testnet

Stellar network

query Parameters
search
string
Example: search=dollar

Arbitrary search term (asset code, issuer, associated home domain, or information from asset TOML metadata)

sort
string
Default: "rating"
Enum: "rating" "created" "payments" "trades" "trustlines" "volume" "volume7d"

Results sorting parameter

order
string (ResultsSortOrder)
Enum: "asc" "desc"
Example: order=desc

Results sorting order

limit
number (ResultsLimit) [ 1 .. 200 ]
Default: 10
Example: limit=10

Results data page size

cursor
integer

A position from which to continue search (refers to the paging_token value from a results set)

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Asset rating

To solve the problem of assets ranking on StellarExpert, we designed a system of technical indicators based purely on the ledger activity, including

  • asset age (time elapsed sisnce the first payment)
  • established trustlines
  • total number of payments
  • total number of trades
  • weekly trading volume
  • market liquidity (based on the relative slippage of {ASSET}/XLM market)
  • asset interoperability (based on additional asset metadata and supported SEP standards)

All indicators are calculated on the logarithmic scale to normalize distribution for assets with high trading/transfer activity. The compound rating calculated as the average of all seven indicators can be used to roughly estimate the popularity of any Stellar asset purely from the technical point of view.

path Parameters
network
required
string (Network)
Enum: "public" "testnet"
Example: testnet

Stellar network

asset
required
string (Asset)
Example: BTC-GDKIIIL2YPRSCSFAYT7FQCH4VXF34YNBIORTYCOKJK5CZ762LX2ND4L4

Target asset

Responses

Response samples

Content type
application/json
{
  • "asset": "ABC-GAKP6AHQM4JDI55SK2FGEPLOZU7BTEODS3Y5QNT3VMQQIU3WM99T0L4C-1",
  • "rating": {
    }
}

Asset holders list

Returns a list of all accounts holding non-zero amount of the given asset sorted by the balance size. Accounts with an established trustline but with zero balance excluded from the results set. This API endpoint follows Stellar Horizon API response format convention. A response result contains records and navigation links.

path Parameters
network
required
string (Network)
Enum: "public" "testnet"
Example: testnet

Stellar network

asset
required
string (Asset)
Example: BTC-GDKIIIL2YPRSCSFAYT7FQCH4VXF34YNBIORTYCOKJK5CZ762LX2ND4L4

Target asset

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Asset holder rank

Retrieves a relative account balance position among all accounts holding a particular asset.

path Parameters
network
required
string (Network)
Enum: "public" "testnet"
Example: testnet

Stellar network

asset
required
string (Asset)
Example: BTC-GDKIIIL2YPRSCSFAYT7FQCH4VXF34YNBIORTYCOKJK5CZ762LX2ND4L4

Asset used for rating calculation

account
required
string (AccountAddress) /^G[ABCDEFGHIJKLMNOPQRSTUVWXYZ234567]{55}$/
Example: GAB6FD5BCBVVQINU5USYV5K4JDAEO6RDL2GZU4K5BILPI6B4FIOF6QWW

Account address to check

Responses

Response samples

Content type
application/json
{
  • "account": "GDKIJJIKXLOM2NRMPNQZUUYK24ZPVFC6426GZAEP3KUK6KEJLACCWNMX",
  • "asset": "XLM",
  • "balance": "39065991792893022",
  • "position": 3,
  • "total": 7159959
}

Asset supply

Asset supply endpoint returns the total issued supply for an asset. It is handy for displaying the total number of tokens on the website or providing relevant information to third-party platforms. For example, aggregators often require an API endpoint to track the asset supply.

path Parameters
network
required
string (Network)
Enum: "public" "testnet"
Example: testnet

Stellar network

asset
required
string (Asset)
Example: EURT-GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S

Target asset

Responses

Response samples

Content type
text/plain; charset=utf-8
1203229.6298700

Ledger Info API

Find sequence by timestamp

Resolves ledger sequence with a finalization time equal or less than a given timestamp. If the timestamp indicates some time in the future or, vise versa, less than the closing time of the first ledger, server returns 404 Not Found error.

path Parameters
network
required
string (Network)
Enum: "public" "testnet"
Example: public

Stellar network

query Parameters
required
string or integer
Example: timestamp=1642597270

Timestamp to search (UNIX time or RFC 3339 timestamp)

Responses

Response samples

Content type
application/json
{
  • "sequence": 42431435,
  • "timestamp": 1661781078,
  • "date": "2022-08-29T13:51:18.000Z"
}

Find timestamp by sequence

Resolves ledger closing timestamp for a give ledger sequence.

path Parameters
network
required
string (Network)
Enum: "public" "testnet"
Example: public

Stellar network

query Parameters
sequence
required
integer >= 1
Example: sequence=32590807

Ledger sequence

Responses

Response samples

Content type
application/json
{
  • "sequence": 42431435,
  • "timestamp": 1661781078,
  • "date": "2022-08-29T13:51:18.000Z"
}