Skip to main content
GET
/
stellar
/
account
/
{publicKey}
Error
A valid request URL is required to generate request examples
{
  "exists": true,
  "hasUsdcTrustline": true,
  "xlmBalance": "<string>",
  "usdcBalance": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Server-held API key. Injected by the BFF (createRelayRoute / createSignerProxyRoute from @buckspay/nextjs). This key must only appear in server-side code and must never be shipped to a browser bundle.

Path Parameters

​
publicKey
string
required

Stellar classic public key (G-address, StrKey encoded).

Pattern: ^G[A-Z2-7]{55}$
Example:

"GABC1234..."

Query Parameters

​
chain
enum<string>
required

Network to query. Stellar network identifier used in facilitator requests.

Available options:
stellar-testnet,
stellar-pubnet

Response

Account state returned.

On-chain account state returned by the /stellar/account/:pk and /stellar/contract/:address endpoints. The SDK adapter normalizes the facilitator's nativeBalance field to xlmBalance and strips null values.

​
exists
boolean
required

Whether the account exists on-chain.

​
hasUsdcTrustline
boolean
required

Whether the account has an active USDC trustline.

​
xlmBalance
string

Native XLM balance as a decimal string (e.g. 10.5000000). Omitted if the facilitator returned null or the account does not exist.

​
usdcBalance
string

USDC balance as a decimal string. Omitted if the account has no trustline or the facilitator returned null.