Settle API

The Settle API lets developers create app’s that are integrated with core Settle services like chat, portfolio and price feed.


Currently you can:

  • Create your app in the developer tools
  • Authenticate your API requests
  • Pull data specific to your app like installed users
  • Send a notification to a user
  • Pull a users portfolio data like transactions or holdings
  • Pull current and historic ticker data for any token


Register an app to make requests to settle: Authentication


Settle SDK

For Javascript apps – Use our NPM module

// install the sdk
npm install settlesdk
// import and use
const Settle = require(‘settlesdk’)
Settle.PriceFeed.Ticker({token: ‘Bitcoin’})


View the API reference for:


User Specific Apps

When your app or chat plugin is loaded inside of settle, we will pass a token get param (?token) along with the app mode (?mode).

A token is passed into your app, which you can convert to a guid with Settle.exchangeTokenForGuid(token)

// get the “token” GET param from the url, pass it into the exchange function
// Receive a GUID to make requests for this user