# JS/TS SDK

- [Xaman SDK (Intro)](/js-ts-sdk/xumm-sdk-intro.md): Developers can use the Xaman SDK to easily integrate with the Xaman platform. This allows for easy & secure end user interaction. With your application & the XRP Ledger.
- [Examples / User stories](/js-ts-sdk/examples-user-stories.md)
- [Sign Requests (payloads)](/js-ts-sdk/examples-user-stories/sign-requests-payloads.md): A sign request in Xumm is a prompt to approve a transaction or action on the XRP Ledger. This page will show you how you can create a Sign Request, and how you can deliver the request to the end user.
- [Browser](/js-ts-sdk/examples-user-stories/sign-requests-payloads/browser.md): A sign request in Xumm is a prompt to approve a transaction or action on the XRP Ledger. This page will show you how you can create a Sign Request, and how you can deliver the request to the end user.
- [xApp](/js-ts-sdk/examples-user-stories/sign-requests-payloads/xapp.md): A sign request in Xumm is a prompt to approve a transaction or action on the XRP Ledger. This page will show you how you can create a Sign Request, and how you can deliver the request to the end user.
- [Backend](/js-ts-sdk/examples-user-stories/sign-requests-payloads/backend.md): A sign request in Xumm is a prompt to approve a transaction or action on the XRP Ledger. This page will show you how you can create a Sign Request, and how you can deliver the request to the end user.
- [Verify Payload signature](/js-ts-sdk/examples-user-stories/verify-oauth2-signature.md): You can fetch the corresponding payload to verify the signature, to make sure it's signed by the account you expected to sign the payload.
- [Simple Sign Request](/js-ts-sdk/examples-user-stories/misc-todo.md)
- [SDK (syntax)](/js-ts-sdk/sdk-syntax.md): Developers can use the Xumm SDK to easily interact with the Xumm platform. This section contains the technical documentation for the Javascript/TypeScript API (objects, methods, arguments).
- [Xumm.ping()](/js-ts-sdk/sdk-syntax/xumm.ping.md)
- [Xumm.on(event, fn)](/js-ts-sdk/sdk-syntax/xumm.on-event-fn.md): Events fired by the SDK per environment. For the order of events, see the section per environment after the table with events.
- [Xumm.off(event, fn)](/js-ts-sdk/sdk-syntax/xumm.off-event-fn.md)
- [Xumm.helpers { … }](/js-ts-sdk/sdk-syntax/xumm.helpers.md)
- [ping()](/js-ts-sdk/sdk-syntax/xumm.helpers/ping.md): Contact the Xumm platform to check for connectivity and valid auth.
- [getRates( … )](/js-ts-sdk/sdk-syntax/xumm.helpers/getrates.md): Get aggregated exchange rates vs. XRP for most fiat & crypto assets.
- [getRails()](/js-ts-sdk/sdk-syntax/xumm.helpers/getrails.md): Fetch the available (known) networks and network parameters.
- [getHookHash( … )](/js-ts-sdk/sdk-syntax/xumm.helpers/gethookhash.md): Get meta information for a known Hook, by specifying the Hook Hash (64 hex chars)
- [getHookHashes()](/js-ts-sdk/sdk-syntax/xumm.helpers/gethookhashes.md): Get the meta information for all known Hooks. Object returned contains Hook hash as key, meta as value.
- [getCuratedAssets()](/js-ts-sdk/sdk-syntax/xumm.helpers/getcuratedassets.md): Get the curated assets (shortlist in Xumm) for Trust Lines
- [getNftokenDetail( … )](/js-ts-sdk/sdk-syntax/xumm.helpers/getnftokendetail.md): Get NFT Token details. Only available in JWT context. Please fetch your NFT info from other NFT data sources if possible.
- [getKycStatus( … )](/js-ts-sdk/sdk-syntax/xumm.helpers/getkycstatus.md): Get the KYC status for users, based on a user\_token issued by a successful sign request.
- [verifyUserTokens(\[ … \])](/js-ts-sdk/sdk-syntax/xumm.helpers/verifyusertokens.md): Verify a user token (or multiple), to see if the token is still valid (not expired, not revoked) and can be used to deliver sign requests to user(s)
- [getTransaction( … )](/js-ts-sdk/sdk-syntax/xumm.helpers/gettransaction.md): Fetch an XRPL transaction & metadata. Please don't use this method unless absolutely necessary: please set up your own connection to an XRPL node to fetch this information.
- [Xumm.user { … }](/js-ts-sdk/sdk-syntax/xumm.user.md): Returns information about the signed in user (in case of xApp or Web3 flow).
- [Xumm.environment { … }](/js-ts-sdk/sdk-syntax/xumm.environment.md)
- [Xumm.payload { … }](/js-ts-sdk/sdk-syntax/xumm.payload.md)
- [create( … )](/js-ts-sdk/sdk-syntax/xumm.payload/create.md)
- [createAndSubscribe( … )](/js-ts-sdk/sdk-syntax/xumm.payload/createandsubscribe.md)
- [cancel( … )](/js-ts-sdk/sdk-syntax/xumm.payload/cancel.md)
- [subscribe( … )](/js-ts-sdk/sdk-syntax/xumm.payload/subscribe.md)
- [get( … )](/js-ts-sdk/sdk-syntax/xumm.payload/get.md)
- [Xumm.xapp { … }](/js-ts-sdk/sdk-syntax/xumm.xapp.md)
- [ready()](/js-ts-sdk/sdk-syntax/xumm.xapp/ready.md): When using the native Xumm loader screen for your xApp (until your xApp is ready, fully hydrated, booted, etc.) you call this method to remove the Xumm loading screen.
- [openSignRequest({ … })](/js-ts-sdk/sdk-syntax/xumm.xapp/opensignrequest.md): Open a Sign Request (payload) created with Xumm.payload.create
- [selectDestination({ … })](/js-ts-sdk/sdk-syntax/xumm.xapp/selectdestination.md): Open the Destination Picker: select/find/scan (QR) an XRPL destination account by r-address, slug or PayString
- [scanQr()](/js-ts-sdk/sdk-syntax/xumm.xapp/scanqr.md): Scan a QR code
- [tx({ … })](/js-ts-sdk/sdk-syntax/xumm.xapp/tx.md): Open the Transaction Details panel
- [close({ … })](/js-ts-sdk/sdk-syntax/xumm.xapp/close.md): Close the xApp
- [share({ … })](/js-ts-sdk/sdk-syntax/xumm.xapp/share.md): Use the OS Share-dialog to share text or a URL
- [navigate({ … })](/js-ts-sdk/sdk-syntax/xumm.xapp/navigate.md): Navigate to another xApp (by identifier)
- [openBrowser({ … })](/js-ts-sdk/sdk-syntax/xumm.xapp/openbrowser.md): Open an external URL in the OS default browser
- [on(xAppEvent, fn)](/js-ts-sdk/sdk-syntax/xumm.xapp/on-event-fn.md): Certain events are sent to xApps. These events are usually an asynchronous callback containing data requested by calling one of the xApp UI actions.
- [off(xAppEvent, fn)](/js-ts-sdk/sdk-syntax/xumm.xapp/off-event-fn.md): Certain events are sent to xApps. These events are usually an asynchronous callback containing data requested by calling one of the xApp UI actions.
- [Xumm.userstore { … }](/js-ts-sdk/sdk-syntax/xumm.userstore.md): Client side persistent user bound key/value store.
- [list()](/js-ts-sdk/sdk-syntax/xumm.userstore/list.md): List userstore keys
- [get( … )](/js-ts-sdk/sdk-syntax/xumm.userstore/get.md): Get userstore value (object) by key
- [delete( … )](/js-ts-sdk/sdk-syntax/xumm.userstore/delete.md): Remove userstore key & value by key
- [set( … , { … } )](/js-ts-sdk/sdk-syntax/xumm.userstore/set-...-....md)
- [Xumm.backendstore { … }](/js-ts-sdk/sdk-syntax/xumm.backendstore.md)
- [get()](/js-ts-sdk/sdk-syntax/xumm.backendstore/get.md)
- [set({ … })](/js-ts-sdk/sdk-syntax/xumm.backendstore/set.md)
- [delete()](/js-ts-sdk/sdk-syntax/xumm.backendstore/delete.md)
- [Xumm.push { … }](/js-ts-sdk/sdk-syntax/xumm.push.md)
- [event( … )](/js-ts-sdk/sdk-syntax/xumm.push/event.md)
- [notification( … )](/js-ts-sdk/sdk-syntax/xumm.push/notification.md)
- [Xumm.runtime { … }](/js-ts-sdk/sdk-syntax/xumm.runtime.md)
- [Xumm.authorize()](/js-ts-sdk/sdk-syntax/xumm.authorize.md)
- [Xumm.logout()](/js-ts-sdk/sdk-syntax/xumm.logout.md)