For AI agents: visit https://xumm.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Xumm for developers
HomeAPI Endpoints
Concepts & SDK DocsXumm Developer ConsoleLog InXumm for developers
API Endpoints
Concepts & SDK DocsXumm Developer ConsoleLog In
HomeAPI Endpoints

Backend API

  • Intro
  • Developer Console
  • Authentication
  • Typescript Definitions
    • 📖 NodeJS/TS tutorial
  • Public stats
  • Platform status
  • API Limits

Payloads

  • payloadpost
  • payload/:payload_uuidget
  • payload/ci/:custom_identifierget
  • payload/:payload_uuiddel

Misc

  • pingget
  • curated-assetsget
  • xrpl-tx/:txidget
  • kyc-status (state)post
  • kyc-status/:account (public)get
  • app-storage
    • Store app-storagepost
    • Get app-storageget
    • Clear app-storagedel
  • rates/:currencyget
  • avatar/:account.png
  • user-tokenspost
  • account-meta/:accountget
  • railsget
  • hookhash/:hookget
  • amm-meta/:asset1,:asset2get

xApps

  • xapp/ott/:tokenget
    • Re-fetch OTT data
    • OTT Response details
  • xapp/eventpost
  • xapp/pushpost

Relevant documentation

  • Introduction
  • Payload workflow
  • Payload life cycle
  • Payload status updates
  • About xApps

JWT (xApp/OAuth2)

  • xApp JWT
    • Intro: xApps + JWT
    • Development (OTT re-fetching)
    • authorizeget
  • OAuth2 JWT
  • jwt/pingget
  • jwt/curated-assetsget
  • jwt/rates/:currencyget
  • jwt/railsget
  • jwt/payloadpost
  • jwt/payload/:uuidget
  • jwt/ci/:idget
  • jwt/payload/:uuiddel
  • jwt/userdataget
    • jwt/userdata/:keysget
    • jwt/userdata/:keypost
    • jwt/userdata/:keydel
Powered by 
  1. Misc

app-storage

The app-storage endpoint allows your application to store max. 60KB of private JSON data for your headless application (eg. POS device) to use to bootstrap / read config / ...

To use App Storage from our Javascript/Typescript SDK, see:
https://github.com/XRPL-Labs/XUMM-SDK#app-storage

Updated over 2 years ago


What's next

  • Store app-storage
  • Get app-storage
  • Clear app-storage

Updated over 2 years ago


What's next

  • Store app-storage
  • Get app-storage
  • Clear app-storage