Welcome to the PocketSmith API. The API is available for anyone to use, and it's free. Everyone benefits from the vibrant developer community fostered around PocketSmith, and the excellent ecosystem of tools available to users as a result. Thanks for taking the interest in hacking on PocketSmith.
Go for a test drive
You can check out the API with your own PocketSmith account using the API Explorer. This will give you a good idea of how the endpoints work and what you can do with them.
How you authorise to the PocketSmith API depends on what your tool is and who will use it.
Tools just for me
If you want to build a tool just for yourself, be it a desktop widget to display your balances or a tool to import transactions from a bank without a bank feed, you can use our developer keys feature. You can issue yourself a key which will give you persistent API access to just your account. When you make any authenticated request, you'll provide your key in the Authorization header with the Key prefix. For example:
curl --header "Authorization: Key b671bd60e7608fc655da352c4c32a247badb9815be266eab42328d6342287ed04780a8051b90d07108aec7afb0fabac1326c949428a2f18441452de428a6d3fd" https://api.pocketsmith.com/v2/me
To enable the developer keys feature for your PocketSmith account, send us an email on email@example.com. You'll find a new menu under Security for managing your keys. You should rotate your keys regularly.
If you want to a create an app for PocketSmith that other PocketSmith users can use, you'll be using OAuth 2.
To register an app with PocketSmith, please email us on firstname.lastname@example.org. Let us know a bit about yourself and what you plan on building. When approved, you will be provided with your
client_secret to start using OAuth. Then, check out our guide for integrating OAuth to get started.
We're currently in beta testing
The PocketSmith API is in beta, because we need a little bit of scope to change things up as we find our feet.
- API endpoints and verbs are subject to change.
- The API may be unstable. Things might break, such is the nature of a beta. Please report any issues to us.
Our promise to you is that any breaking changes will be communicated well in advance, and we'll work with our developers to ensure a smooth transition if necessary. Once we're happy with it, we'll commit to no further breaking changes and stabilise the API.
Get in touch
We would love to hear from you about your app and how you're using the API, and if you have any suggestions or find any issues. Drop us a line on email@example.com.