xrpl.to

XRPL.to API

XRPL token analytics, market data, NFT, trading, and on-chain account API. Usage policy Applies to every caller — no key, Free, and every paid tier alike.…

Finance & banking#cryptocurrency

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

XRPL token analytics, market data, NFT, trading, and on-chain account API.

Usage policy

Applies to every caller — no key, Free, and every paid tier alike.

  • Attribution is required. Any app, website, bot, or dashboard that displays xrpl.to data must show a visible, clickable credit to xrpl.to on the same screen as that data — not buried in an about page. Use: Data by xrpl.to
  • Redistribution needs permission. Storing our data and re-serving it from your own API, dataset, or public dashboard requires written permission first. Email hello@xrpl.to — the answer is usually yes, we just need to know who is doing it.
  • Indexers and aggregators: use the paginated list endpoints instead of looping one item at a time, cache what you fetch, and honour Retry-After on a 429 — a repeated 429 means back off, not retry. Get a key rather than running anonymous so we can raise your limits instead of blocking you.
  • Partner tier (invitation-only, free): 100 req/sec, 20M credits/mo, direct support — for integrations that credit us properly. Email hello@xrpl.to or DM @xrplto on X.

Successful responses on the tiers that pay nothing (anonymous, free, partner) carry an attribution string right after success, restating this requirement. It is informational — safe to ignore in code, but not optional to comply with.

Endpoints 366

Account

  • GETXRP balance with reserves/account/balance/:account
  • POSTBatch balance lookup (max 100)/account/balance
  • GETToken pair balances/account/balance/pair/:account
  • GETOpen DEX offers/account/offers/:account
  • GETFull transaction history/account/tx/:accountOwn rate window: 20 requests/min per IP on Free, 5/min without a key, more on paid tiers (see rateLimits.layers.perEndpoint)
  • GETAccount info with DB enrichment/account/info/:account
  • GETAccount trustlines/account/trustlines/:account
  • GETSingle trustline lookup/account/trustline/:account/:issuer/:currency
  • GETAccount objects/account/objects/:account
  • GETSendable/receivable currencies/account/currencies/:account
  • GETNFTs owned by account/account/nfts/:account
  • GETGateway balances (issuer totals)/account/gateway/:accountReturns 503 "Account too large, retry shortly" on issuer-scale timeouts
  • GETNoRipple check/account/noripple/:account
  • GETPayment channels/account/channels/:account
  • GETCheck deposit authorization/account/deposit-authorized
  • POSTFind payment paths/account/path-findRate limited 5 req/min per IP
  • GETAccount ancestry tree/account/ancestry/:accountRequires Developer tier or above (403 otherwise)
  • GETPer-token trading stats for account/account/token-stats/:account/:md5holdingValue/unrealizedPnl mark the bag at the pool SPOT price. exit is what selling the WHOLE balance returns right now through the swap engine (same fill as…
  • GETTrustlines with token values/trustlines/:account
  • GETGet token watchlist/watchlistAuth: wallet signature
  • POSTAdd/remove token on watchlist/watchlistAuth: wallet signature
  • GETGet NFT watchlist/watchlist/nftAuth: wallet signature
  • POSTAdd/remove NFT on watchlist/watchlist/nftAuth: wallet signature
  • GETRecent trades for an account/account/recent-trades/:account
  • POSTResolve account display names + verification status in bulk (max 50)/account/names
  • GETPoint-in-time XRP + token holdings valued in XRP at a historical ledger (resolve time to ledger via /ledger/at first)/account/snapshot/:account
  • GETCheck ledger objects with live funding status for cashable checks/account/checks/:account
  • GETSearch accounts by display name / X profile/account/search-by-name
  • POSTBatch-resolve admin-verified destination identity (name, logo, tagRequired). Only verified accounts are returned — absence means unknown, which is the safety signal./account/resolve
  • PUTSet verified destination identity (admin only — never user-settable)/account/:address/verified
  • DELETERemove verified destination identity/account/:address/verified
  • GETFull account doc split into editable editorial fields vs read-only ledger/derived state, plus the manualFields lock list, the lockedByChain list (fields tx derives from the ledger) and a derived block (decoded on-chain Domain, attributed domain, desc kind)/account/:address/admin
  • PATCHEdit editorial fields. Each written field is added to manualFields so the owning background service skips it (tokendata + grok-whale-labeler honour this) — null/empty unsets. Raw ledger fields and scam flags are not editable; `domain` returns 409 when the account sets an on-chain Domain, because tx re-derives it from the ledger./account/:address/admin
  • POSTUpload an account logo; served self-hosted at GET /api/account-thumb/{address}/account/:address/logo
  • GETThe picture of an account, as a WebP image, for every valid address: its curated logo, else the NFT its owner chose as its image (a redirect to /nft-thumb), else its XLS-6 icon (the standard hashicon of its X-address)/account-thumb/:addressNeeds an API key (401 without one): send X-Api-Key, or ?apiKey= where headers cannot be sent.

Account Tx Explain

  • GETWallet activity analysis and profiling (20 credits)/account-tx-explain/:account

Analytics

  • GETToken analytics/token/analytics/token/:id
  • GETTop traders for token/token/analytics/token/:id/traders
  • GETTrader cumulative stats/token/analytics/trader/:address
  • GETTrader token-specific metrics/token/analytics/trader/:address/tokens
  • GETAll traders with cumulative stats/token/analytics/traders
  • GETDaily market metrics/token/analytics/market
  • GETTrader volume history/token/analytics/trader/:address/historyReturns a bare JSON array
  • GETTrader trade history/token/analytics/trader/:address/tradesReturns a bare JSON array
  • GETTrader balance snapshots summary/token/analytics/traders/summary
  • GETDistinct trade sourceTags with trader counts and volume totals/token/analytics/sources

Boost

  • GETGet quote for boosting a token/boost/quote/:md5
  • POSTCreate boost payment request. `termHours` is 12 (default) or any multiple of 12 up to 8760, a year; the bid is per 12 hours and ranks the board, the total is the bid once per 12 hours (the quote prints each). At most 8 of the 10 slots can be on long runs: past that a longer run answers 409. A token that holds a slot adds the time to what is left: `packId: "extend"` keeps its bid, a lower bid is refused. `ad` is the Top spot's ad line: one sentence (max 70 chars) and a button word (max 14), linking only to the token's own website/boost/purchase
  • GETVerify payment and apply boost/boost/verify/:invoiceId
  • POSTCreate Stripe checkout for boost (`termHours` and `ad` as in POST /boost/purchase)/boost/stripe
  • GETCheck Stripe boost payment status/boost/stripe/:sessionId
  • GETCurrently active token boosts (admin only)/boost/activeAuth: X-Admin-Key
  • GETQuote price for boosting an NFT collection (slug also accepts "<issuer>:<taxon>")/boost/nft/quote/:slug
  • POSTInitiate XRP-paid NFT collection boost (`termHours` and `ad` as in POST /boost/purchase, linking only to the collection's own website)/boost/nft/purchase
  • GETVerify NFT boost payment/boost/nft/verify/:invoiceId
  • POSTInitiate Stripe-paid NFT collection boost (`termHours` and `ad` as in POST /boost/nft/purchase)/boost/nft/stripe
  • GETCheck Stripe checkout status for NFT boost/boost/nft/stripe/:sessionId

Bridge

  • GETList available exchange currencies/bridge/currencies
  • GETGet exchange rate estimate/bridge/estimate
  • GETGet minimum exchange amount/bridge/min-amount
  • POSTCreate exchange/bridge/create
  • GETGet exchange status/bridge/status
  • GETValidate destination address/bridge/validate-address

Charts & Analytics

  • GETOHLC candlestick data/ohlc/:id
  • GETPrice sparkline/sparkline/:id
  • GETHolder concentration (top10/20/50/100 %)/holders/info/:id
  • GETHolder count history/holders/graph/:id
  • GETPaginated holder richlist with acquisition tracking/holders/list/:id
  • GETRSI indicator data/rsi
  • GETPlatform metrics/stats
  • GETExchange rates between tokens/stats/rates
  • POSTHistorical exchange rates by timestamps (XRP base)/stats/metrics
  • GETDaily OMCF-filtered marketcap (same as homepage gMarketcap) back to 2021-09-26/stats/marketcap-history
  • GETBulk account-to-rank lookup within the holder richlist/holders/ranks/:id
  • GETOne account's stake in a token — balance, share of supply and rank, without building the holder list/holders/position/:id/:address
  • GETBatch sparklines for multiple tokens (each rebuilt on the token's next trade)/sparkline/batch
  • GETZero-balance trustlines (dust/airdrop accounts; precomputed bot accounts excluded)/holders/empty/:id
  • GETTop 24h buyers and sellers by holder balance delta/holders/movers/:id

Chat

  • GETOnline count + unread status/chat/status
  • GETPublic chat history/chat/messages
  • GET5-min WebSocket session token/chat/sessionAuth: X-Api-Key
  • GETCheck chat access for key tier/chat/accessAuth: X-Api-Key

Creator Activity

  • GETToken creator trading activity/creator-activity/:id
  • GETCreator activity filtered by recipient address/creator-activity/:id/receiver/:address
  • GETGlobal whale tape — the newest notable trades across ALL tokens. `tokens` maps each event md5 to its display identity (name, user, slug, verified)/whale-activity/feed
  • GETWhale social-proof trade events — top holders of major tokens, smart money, named accounts, whale-sized and fresh-wallet trades on this token/whale-activity/:id

Embed

  • GETEmbeddable candlestick chart (HTML iframe)/embed/:md5
  • GETEmbeddable token safety-score badge (HTML iframe)/embed/score/:md5

Keys

  • POSTCreate new API key (1 active key on free tier, 5 on paid tiers)/keysRequires wallet signature. Save the API key immediately - it cannot be retrieved later. The project block and agreePolicy record which project the key serves…
  • GETList API keys for wallet/keys/:walletAuth: wallet signature
  • PUTRename an active API key (metadata only)/keys/:wallet/:idAuth: wallet signature. Headers: X-Wallet, X-Signature, X-Timestamp, X-Public-Key
  • DELETERevoke API key (first call revokes; calling again on a revoked key permanently deletes it)/keys/:wallet/:idAuth: wallet signature. Headers: X-Wallet, X-Signature, X-Timestamp, X-Public-Key
  • GETRemaining credits and billing info/keys/:wallet/creditsAuth: wallet signature
  • GETUsage breakdown by key and endpoint/keys/:wallet/usageAuth: wallet signature
  • GETSubscription details, available upgrades and partnerRequest { status: pending|approved|declined, creditUrl, requestedAt, decidedAt, reason } (null when never requested). billingCycle.end is the paid term end: 30 days for a monthly purchase, 365 for yearly. Buying the same tier again before it ends extends the term; an ended term downgrades the wallet and its keys to Free./keys/:wallet/subscriptionAuth: wallet signature
  • POSTTell us an endpoint, field or parameter you needed and did not get, or a value that was wrong. Built for agents: point at the request with its X-Request-ID and pick a kind; there is no free-text field/feedbackEvery response carries X-Request-ID, and a 404 or 500 body carries a ready-made feedback block. With a requestId from your last 50 requests the method, route…
  • POSTApply for the free Partner tier (see usagePolicy.partner)/keys/:wallet/partner-requestNeeds an active key created with project details that has made real requests; one open request per wallet (409 while pending). A person reviews the request…
  • GETAvailable API tiers with live XRP pricing. Developer, Business and Professional are bought for a term (30 days monthly, 365 yearly) and renew by buying the same tier again; Partner is by application./keys/tiers
  • GETCredit top-up packages with pricing/keys/packages
  • GETPer-endpoint credit costs/keys/costs
  • POSTCreate XRP payment request/keys/purchaseInvoice expires in 30 minutes. After payment, call POST /keys/verify-payment with the tx hash.
  • POSTVerify XRP payment and apply credits/tier/keys/verify-payment
  • GETCheck XRP payment status/keys/xrp/status/:txHash
  • POSTCreate Stripe checkout session/keys/stripe/checkout
  • GETCheck Stripe payment status/keys/stripe/status/:sessionId
  • GETLook up processed payment by tx hash/keys/payment/:txHashAuth: wallet signature
  • GETRecent API request logs for a wallet/keys/:wallet/logsAuth: wallet signature
  • GETPayment history for wallet/keys/payments/:walletAuth: wallet signature
  • GETInvoice detail for a payment (sequential INV-YYYY-NNNNN number assigned on first fetch)/keys/invoices/:paymentIdAuth: wallet signature

Launch

  • POSTCreate new token with AMM/launch-tokenEvery wallet the launch will send to (userAddress, bundleRecipients[].address) is checked on the ledger first. One that cannot receive is refused with 400…
  • GETLaunch session status/launch-token/status/:sessionId
  • GETQueue position status/launch-token/queue-status/:sessionId
  • POSTAuthorize trustline (anti-snipe)/launch-token/authorize
  • GETToken authorization info/launch-token/auth-info/:issuer/:currency
  • GETCheck if address is authorized/launch-token/check-auth/:issuer/:currency/:address
  • GETCalculate required XRP funding (400 on invalid params)/launch-token/calculate-funding
  • GETLaunches created with your API key, with total count (a wallet lists its own with /launch-token/my-launches-wallet)/launch-token/my-launches
  • POSTUpload token image (base64, max 500KB)/launch-token/:sessionId/image
  • GETToken launches by wallet with total count/launch-token/my-launches-walletAuth: wallet signature
  • GETVesting schedule for a launched token (response includes truncated flag when escrow list is incomplete)/launch-token/vesting-by-token/:issuer/:currency

Ledger & Tx

  • GETCurrent validated ledger info/ledgerreserve_base_drops / reserve_inc_drops are the validator-voted account reserve settings, in drops. reserve_inc_drops is the Fee an AccountDelete or AMMCreate…
  • GETLedger by index with transactions/ledger/:index
  • GETFetch specific ledger object/ledger/entryMalformed JSON in object params returns 400
  • GETTransaction by hash (64-char hex)/tx/:hash
  • GETResolve a datetime to the last ledger closed at or before it (binary search). Close times are rounded to 10 seconds, so a ledger often closes exactly on the time asked. For a day [start, end): its first ledger is the one returned for start when that closed exactly at start, else the next; its last is the one returned for end, or the one before it when that closed exactly at end/ledger/at

LP Positions

  • GETAMM LP positions with impermanent loss analysis/lp-positions/:account

Mentions

  • GETAgent-friendly search across X/Twitter mentions with full-text + filters. Returns enriched tweets with token name, spam/impostor flags./mentions/searchAuth: Developer tier+ API key
  • GETGlobal social feed with trending tokens, top authors, activity chart, and impostor list/mentions/feedAuth: Developer tier+ API key
  • GETPer-token mention feed with stats, top mentioners, and activity chart/mentions/:md5Auth: Developer tier+ API key
  • GETX Space hosts with full history and inferred schedule (days/hour UTC). Returns all known space hosts sorted by most recent activity./mentions/spacesAuth: Developer tier+ API key
  • GETOpenAPI 3.0 spec for the mentions endpoints (agent/MCP discoverable)/mentions/openapi.jsonAuth: Developer tier+ API key
  • GETFull timeline of tracked influencer tweets (not just token matches)/mentions/timeline
  • GETLive X/Twitter search via scraper (503 if scraper unavailable)/mentions/x-search
  • GETGrok-generated XRPL insight topics with sentiment/mentions/grok-pulse
  • GETLatest X profile snapshot + change history for a handle/mentions/profile/:username

News

  • GETLatest XRP news with sentiment/newsAuth: Developer tier+ API key
  • GETSearch news articles/news/searchAuth: Developer tier+ API key
  • GETNews sources pending approval/news/unapproved-sourcesAuth: Developer tier+ API key
  • GETHistorical sentiment analysis chart/news/sentiment-chartAuth: Developer tier+ API key

NFT

  • GETList NFTs/nft
  • GETNFT by NFTokenID (64-char hex)/nft/:nftId
  • GETBuy/sell offers for NFT/nft/:nftId/offers
  • GETNFT transaction history/nft/history
  • GETLive NFT history/nft/history/:nftId
  • GETRecent NFT activity feed/nft/activity
  • GETNFT transaction by hash/nft/transactions/:hash
  • GETLive buy offers/nft/offers/buy/:nftId
  • GETLive sell offers/nft/offers/sell/:nftId
  • GETList NFT collections/nft/collections
  • GETCollection details/nft/collections/:slug
  • GETNFTs in collection/nft/collections/:slug/nfts
  • GETCollection trait breakdown/nft/collections/:slug/traits
  • GETTop traders/nft/collections/:slug/traders
  • GETCollection orderbook/nft/collections/:slug/orderbook
  • GETCollection metrics snapshot (floor + deltas, volumes, sales, owners, listings)/nft/collections/:slug/metrics
  • GETCollection activity history/nft/collections/:slug/history
  • GETResolve a collection from its XLS-20 on-chain identity (issuer account + taxon) to the full collection object incl. slug/cid. Every {slug} param on /nft/* endpoints ALSO accepts this identity directly as "<issuer>:<taxon>" (e.g. /nft/collections/rLyr...:1234/history)/nft/collections/resolve?account=string&taxon=0
  • GETFloor price history/nft/collections/:slug/floor/history
  • GETCollection OHLC chart data/nft/collections/:slug/ohlc
  • GETNFTs sold on specific date/nft/collections/:slug/ohlc/:date/sales
  • GETCollection floor price sparkline/nft/collections/:slug/sparkline
  • GETOwnership distribution: total owners and the top holders, with how many NFTs each holds/nft/collections/:slug/ownership
  • GETTrader volume stats/nft/traders/:account/volume
  • GETNFTs/collections owned with portfolio value/nft/account/:account/nfts
  • GETNFT offers owned + incoming buy/sell offers (top 500 newest owned NFTs scanned; incomingOffersTruncated flag; fraud/fraudType detection)/nft/account/:account/offers
  • GETGlobal NFT market stats (same source as /nft/global-metrics)/nft/stats/global
  • GETGlobal NFT metrics/nft/global-metrics
  • GETNFT market analytics/nft/analytics/market
  • GETCollection holder list/nft/holders/:slug
  • GETCollections/NFTs held by wallet/nft/holders/address/:account
  • GETHolder distribution by tier (whales/orcas/dolphins/fish/shrimp)/nft/holders/:slug/distribution
  • GETFloor history by collection ID/nft/floor/history/:cid
  • GETBroker fee statistics/nft/brokers/stats
  • GETNFT trader leaderboard/nft/analytics/traders
  • GETSingle NFT trader profile/nft/analytics/trader/:account
  • GETTrader daily history/nft/analytics/trader/:account/historytotal = pre-slice count
  • GETTrader per-collection breakdown/nft/analytics/trader/:account/collections
  • GETTrader trade history/nft/analytics/trader/:account/trades
  • GETTop traders for collection/nft/analytics/collection/:slug/traders
  • GETNFT collection rotation analytics/nft/analytics/rotations
  • GETNFT collection rotations by collection id/nft/analytics/rotations/:cid
  • GETNFT trader rotations history/nft/analytics/trader/:account/rotations
  • GETIPFS pin status by hash/nft/pin/status/:hashhash must be an IPFS CID (Qm… or b…)
  • GETNFT-scam insights snapshot — totals (XRP/token drained, NFTs flagged, scam wallets), monthly timeline, top scammers/victims, tokens drained with XRP values, recent drain feed, and scamIssuersList (flat array of every flagged-issuer address for client-side filtering). For per-NFT checks, use GET /nft/:nftId — it already returns scam + scamType./nft/scam
  • GETListed-price distribution vs floor (buckets at 1x/1.25x/1.5x/2x/3x/5x/10x floor), floor/median/avg/max/nft/collections/:slug/listings/distribution
  • GETDaily listed-count history merged with floor/volume/sales/nft/collections/:slug/listings/history
  • GETDaily holder-count history/nft/collections/:slug/holders/history
  • GETMint counts over time with cumulative total/nft/collections/:slug/mints
  • GETBatch floor sparklines for multiple collections/nft/collections/sparkline/batch
  • GETNFT marketplaces with their collection count, trader count and logo/nft/analytics/marketplaces
  • POSTPin NFT media to platform IPFS node (resolves hash from NFT URI if only NFTokenID given)/nft/pinAdmin key. The node pins in the background (status queued); poll /nft/pin/status/{hash}.
  • POSTEdit collection metadata/nft/collections/:slug/metadataAuth: wallet signature (collection account/issuer or admin)

Platform Report

  • GETFull daily platform report/platform-report404 if no report exists for the date (today's report generates at 00:05 UTC)
  • GETDaily report dates with metadata, newest first/platform-report/dates

Platform Stats

  • GETAggregated trading stats grouped by platform key (numeric SourceTag, or canonical name for memo-identified platforms like SPYDEX)/platform-stats
  • GETTop tokens traded via a single platform; summary covers ALL tokens for the platform/period, not just returned rows/platform-stats/detail/:sourceTag
  • GETHourly breakdown for a single platform/platform-stats/hourly/:sourceTag

Promotion

  • GETGet promotion pool info (status, amounts, expiry)/promotion/pool/:md5
  • GETGet reward status for a token/promotion/reward/:md5/:account
  • GETPer-token promoter leaderboard/promotion/leaderboard/:md5
  • GETGlobal promotion stats/promotion/profile/:account
  • GETPromoter tier metadata/promotion/tiers
  • POSTClaim earned promotion rewards (paid in XRP)/promotion/claim

Referral

  • GETGet soldier profile/referral/:address
  • GETBadge progress and tier stats/referral/:address/stats
  • GETLeaderboard/referral/leaderboard/:type
  • GETTier definitions/referral/meta/tiers
  • GETBadge definitions/referral/meta/badges
  • GETMission quest chains/referral/meta/missions
  • GETSeasonal leaderboard rewards/referral/meta/season
  • GETReferral earnings breakdown for an address/referral/:address/earnings
  • GETReferral fee history; response includes asReferrerTotal/asRecruitTotal for paging/referral/:address/fees
  • GETResolve a referral code to validity/owner/referral/resolve/:code

Scams

  • GETFull scam report with abuse statistics/scams
  • GETTokens issued by one named issuer. issuer is required — this endpoint lists an issuer's tokens, it does not classify them. For a scam verdict use /scams/addresses or /scams/check/{account}./scams/tokens?issuer=stringLists the tokens issued by the named issuer. issuer is REQUIRED and this endpoint makes no scam determination: it does not classify or flag the tokens it…
  • GETKnown scam domains with registrar info/scams/domains
  • GETNFT scam accounts and recent sales/scams/nft
  • GETCheck if account is a known scam. is_scam is true ONLY for accounts on the verified blocklist or confirmed scam NFT issuers — never inferred from an account's token names or token count. Also returns first_seen/age_seconds/new_account (advisory counterparty freshness, independent of is_scam)/scams/check/:accountPre-signature safety check, never cached. is_scam is true ONLY when the account is on the verified blocklist (ledger_v1.scam_accounts) or is a confirmed scam…
  • GETList community scam reports/scams/report-scam
  • GETConfirmations for a reported domain/scams/report/:domain
  • POSTReport a scam domain/scams/report
  • GETTHE canonical scam blocklist: top-level addresses[] is the deduped union of every blocked account (drainers, dust/token spam, phishing, impersonation, fake airdrops, NFT-scam issuers). Check a Destination/counterparty against it BEFORE a user signs. Real-time, never cached (Cache-Control: no-store) — poll every ~5s. Per-category sections (nftPhishing, paymentDrain) are additive metadata and may overlap; addresses is deduped./scams/addressesTHE official blocklist consumption surface: top-level addresses[] is the deduped union of every blocked account (wallet drainers, dust/token spam, phishing,…

Submit

  • POSTSubmit signed transaction/submitengine_result is PRELIMINARY — only a validated ledger is final (xrpl.org, Finality of Results); success means applied to the open ledger, which includes a…
  • POSTDry-run transaction preview (400 on invalid tx input); under fee escalation a tx_json is simulated at the fee that enters the open ledger and reported for the Fee it named; sender_after = simulated sender position {balance, reserve, spendable}, null when no sender AccountRoot change/submit/preview
  • GETEvery transaction type POST /submit relays, each with an example: examples[type] = { json (the reference example, unsigned), txid (a real Mainnet transaction of that type, when the reference names one), summary }/submit/types
  • GETCurrent network fees/submit/fee
  • GETAccount sequence number/submit/account/:address/sequence
  • GETDestination-tag usage of recent inbound payments (send-screening advisory; tagsExpected = recent deposits overwhelmingly tagged)/submit/account/:address/inbound-tags
  • GETLookup a submitted XRPL transaction by hash/submit/tx/:hash
  • GETLookup a Check ledger entry by id/submit/ledger-entry/check/:checkId

Thumbnails

  • GETToken thumbnail (WebP)/thumb/:md5Needs an API key (401 without one): send X-Api-Key, or ?apiKey= where headers cannot be sent. Fetch it from your server and cache it — a key in a public…
  • GETNFT image/thumbnail (original format, CSP-sandboxed for SVG)/nft-thumb/:hashNeeds an API key (401 without one): send X-Api-Key, or ?apiKey= where headers cannot be sent.
  • GETNFT collection cover image/nft-collection-thumb/:hashNeeds an API key (401 without one): send X-Api-Key, or ?apiKey= where headers cannot be sent.

Token Flow

  • GETCreator allocation and distribution analysis (precomputed)/token/flow/:id{id} must be a raw md5 (no slug resolution); serves a precomputed document, no query params. summary.creatorAllocated/Delivered/Locked* describe the creator's…

Token Review

  • GETToken risk assessment (score 1-10, lower = safer), and collapseChance: the chance in percent that the token loses 90% of its price or of the XRP in its pools within 60 days (a model graded on what later happened to past tokens), or { inactive: true } for a quiet token (a month old, under 3 trades a day), or null for an Official (tier 1, admin-verified) company token, which also scores 1/token/review/:id

Tokens

  • GETList all tokens with metrics/tokens
  • GETAll token slugs/tokens/slugs
  • GETSingle token by id (see tokenFields for the token object dictionary)/token/:id
  • POSTSearch tokens, NFTs, collections, and accounts. limit max 100; offset clamped so offset+limit <= 100/search
  • GETList all token tags, and every token origin (launchpads and issuers) with its logo/tags
  • POSTUpdate token metadata. 3s per-token write cooldown./token/:md5/metadataAuth: wallet signature (token creator/issuer or admin)
  • POSTUpload token logo image. 3s per-token write cooldown./token/:md5/imageAuth: wallet signature (token creator/issuer or admin)
  • GETRelated projects: other tokens and NFT collections that share the audience of this token. An edge means wallets hold both and accounts post about both — it is NOT a wallet link and does not assert a shared operator (see /token/review for that)./token/:md5/relatedRelated projects: other tokens and NFT collections that share the audience of this token. An edge means wallets hold both and accounts post about both — it is…

Traders

  • GETFull trader profile/traders/:account
  • GETTop traders for a token/traders/token-traders/:id
  • GETCross-token trader rotation analytics/traders/rotations
  • GETTrader rotations for a specific token/traders/rotations/:tokenIdtokenId must be a raw md5 (no slug resolution)
  • GETPer-account token rotation flow (XRP bought/sold per token in window)/traders/:account/rotations

Trading

  • GETTrade history by token, account, or both/historyCursor pagination: pass meta.nextCursor as cursor; it is null on the last page (meta.hasMore false). One row per Payment and pair (its fills merged), so…
  • GETList AMM pools/amm
  • GETLive AMM pool info/amm/info
  • GETHistorical TVL chart data/amm/liquidity-chart
  • GETTrading pairs for a token/pairs
  • GETLive DEX orderbook/orderbook
  • POSTGet swap quote with routing / path finding (successor to POST /account/path-find). Exact-output via destination_value, or exact-input via source_value/dex/quote
  • GETTrading pairs for a specific token/pairs/:id

Tweet Verify

  • GETTweet verifications for a token (md5) or NFT collection (slug)/tweet/token/:md5
  • GETTweet verifications by account/tweet/account/:account
  • POSTVerify a promotional tweet and credit the wallet. One verification per wallet every 2 hours, up to 6 tokens per X account per UTC day, and a tweet earns from one pool./tweet/verifyAuth: wallet signature

User

  • GETUser tiers with pricing (member, vip, nova, diamond, verified)/user/tiers
  • GETGet user profile/user/:account
  • PUTUpdate username (VIP+ required to change an existing one; tier field is admin-only)/user/:accountAuth: wallet signature
  • POSTCreate user profile/user/:accountAuth: wallet signature
  • GETResolved perks (tier + roles merged)/user/:account/perks
  • GETAll unlocked badges/user/:account/badges
  • GETGet your own wallet labels — private data, owner-authenticated/user/:account/labels
  • POSTCreate/update a wallet label (per-tier cap; 402 when limit reached)/user/:account/labelsAuth: wallet signature
  • GETNFTs owned (with thumbnails)/user/:account/nfts
  • GETBadge system metadata/user/badges/meta
  • GETUsers holding a specific badge/user/badges/:badge/holders
  • PUTSet displayed badge (must be unlocked)/user/:account/display-badgeAuth: wallet signature
  • GETOnly actively-watched wallet labels — private data, owner-authenticated/user/:account/labels/watched
  • PUTToggle live-watch on a label (per-tier watcher cap)/user/:account/labels/:wallet/watchAuth: wallet signature
  • DELETEDelete a wallet label/user/:account/labels/:walletAuth: wallet signature
  • PUTSet avatar from an owned NFT/user/:account/avatarAuth: wallet signature
  • POSTCreate XRP invoice for user tier (expires 30 min)/user/tier/purchase
  • GETVerify tier XRP payment (scans fee collector; expired invoices honored if exact payment exists)/user/tier/verify/:invoiceId
  • POSTStripe checkout for user tier/user/tier/stripe
  • GETCheck Stripe tier payment status/user/tier/stripe/:sessionId
  • POSTGift a tier via XRP invoice/user/tier/gift/purchase
  • GETVerify gift tier payment/user/tier/gift/verify/:invoiceId
  • POSTGift a tier via Stripe/user/tier/gift/stripe

Utilities

  • GETRaw IPFS content by CID, served from our own IPFS node/ipfs/:cidNo API key. Images, video, audio and JSON are served inline; anything else (HTML, PDF, unknown types) is delivered as a download and never rendered. Content…
  • GETService health check with per-service latency/healthService health check. Response: { status, timestamp, version, uptime, services: { database, rippled, cache } }
  • GETLive Testnet XRP balance, reserve, sequence and settings of an account, straight from the network/testnet/:address
  • GETThis documentation (JSON). Browsers (Accept: text/html) are redirected to the human-readable docs./docs

Verify

  • GETVerification tier pricing/verify/pricing
  • GETCheck Stripe verification payment status; fulfills if webhook was missed/verify/stripe/status/:sessionId
  • POSTCreate XRP invoice for token/collection verification/verify/request
  • POSTConfirm verification payment/verify/confirm
  • POSTStripe checkout for verification/verify/stripe/checkout

Xaman

  • POSTCreate a Xaman sign request — returns { uuid, next.always (open in Xaman), refs.qr_png, refs.websocket_status }. xrpl.to surfaces only (platform key); user_token is refused/xaman/payloadTurns a transaction JSON into a Xaman payload: a deep link (next.always) and QR (refs.qr_png) the user opens in their Xaman wallet, signs, and Xaman submits.…
  • GETSign request status (live, never cached): meta.signed/expired/cancelled, response.account (SignIn answer), response.txid (submitted transaction)/xaman/payload/:uuidLive status of a payload (never cached): meta.signed / expired / cancelled / app_opened, payload.request_json + expires_in_seconds, response.account (SignIn…
  • DELETECancel an unsigned sign request (xrpl.to surfaces only)/xaman/payload/:uuidxrpl.to surfaces only (platform key). Returns { uuid, cancelled, reason }.

Presale

  • GETList presales (open by default)/presalePublic list of presales; status=all includes non-open.
  • POSTCreate a presale (issuer + sale wallets are provisioned server-side)/presaleEscrow-based presale: issuer + sale wallets provisioned server-side; buyers escrow XRP and claim tokens via CheckCash after finalize.
  • POSTJoin — checks the wallet can fund the escrow above its reserve, returns the conditional EscrowCreate to sign; an unconfirmed slot may join again, an escrow that already landed is confirmed instead/presale/:id/joinReturns the conditional EscrowCreate transaction for the buyer to sign.
  • POSTConfirm a signed escrow contribution/presale/:id/confirmConfirm an escrow contribution
  • POSTFinalize after deadline/goal: capture escrows, deliver claim Checks, seed AMM, blackhole wallets/presale/:id/finalizeAfter deadline or goal: capture escrows, deliver claim Checks, seed AMM, blackhole wallets. Refunding when soft cap missed.
  • GETPresale status (public view: raise, socials, confirmed contributors, vesting; refreshes claim states on success)/presale/:idPresale status (public view)

Showing 300 of 366 endpoints. Fork the collection to see all of them.

API details

Base URL
https://api.xrpl.to/v1
https://api.xrpl.to/api
Authentication
An API key in the X-Api-Key header
An API key in the X-Signature header
An API key in the X-Admin-Key header
Operations
366 operations on 355 pathsGET 292POST 63PUT 6DELETE 4PATCH 1
Main resources
NFT 53Account 35NFT Studio 24User 23Keys 21Testnet 18Charts & Analytics 15market 13Boost 11Launch 11
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.20

How to test the XRPL.to API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the XRPL.to API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-Api-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “XRP balance with reserves” (GET /account/balance/:account), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the XRPL.to API?

XRPL token analytics, market data, NFT, trading, and on-chain account API. Usage policy Applies to every caller — no key, Free, and every paid tier alike.… It is listed under Finance & banking and has 366 endpoints.

Who publishes the XRPL.to API?

It is listed from xrpl.to's public API description (an OpenAPI document), not published by xrpl.to on Swastik Codes. Anyone who controls xrpl.to can claim the profile by adding a DNS TXT record.

What is the base URL of the XRPL.to API?

Its description lists 2 base URLs: https://api.xrpl.to/v1, https://api.xrpl.to/api. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the XRPL.to API?

It accepts 3 methods: an API key in the X-Api-Key header; an API key in the X-Signature header; an API key in the X-Admin-Key header.

How many endpoints does the XRPL.to API have?

366 operations on 355 paths (292 GET, 63 POST, 6 PUT, 4 DELETE, 1 PATCH). The largest groups are NFT, Account, NFT Studio, User.

Is forking the XRPL.to API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.