Open documentation ↗Overview
Money management, personal budgeting and cashflow forecasting with PocketSmith, the best personal finance software on the web. Connect multiple bank accounts securely.
PocketSmith is a finance API from pocketsmith.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 56 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Finance
- Base URL
https://api.pocketsmith.com/v2- Version
- 2.0
- Endpoints
- 56
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.pocketsmith.com/v2/currencies" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://api.pocketsmith.com/v2/currencies", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.pocketsmith.com/v2/currencies",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /accounts/{id} | Get account |
| PUT | /accounts/{id} | Update account |
| DELETE | /accounts/{id} | Delete account |
| GET | /accounts/{id}/transactions | List transactions in account |
| GET | /attachments/{id} | Get attachment |
| PUT | /attachments/{id} | Update attachment |
| DELETE | /attachments/{id} | Delete attachment |
| GET | /categories/{id} | Get category |
| PUT | /categories/{id} | Update category |
| DELETE | /categories/{id} | Delete category |
| POST | /categories/{id}/category_rules | Create category rule in category |
| GET | /categories/{id}/transactions | List transactions in categories |
| GET | /currencies | List currencies |
| GET | /currencies/{id} | Get currency |
| GET | /events/{id} | Get event |
| PUT | /events/{id} | Update event |
| DELETE | /events/{id} | Delete event |
| GET | /institutions/{id} | Get institution |
| PUT | /institutions/{id} | Update institution |
| DELETE | /institutions/{id} | Delete institution |
| GET | /institutions/{id}/accounts | List accounts in institution |
| GET | /me | Get the authorised user |
| GET | /scenarios/{id}/events | List events in scenario. |
| POST | /scenarios/{id}/events | Create event in scenario |
| GET | /time_zones | List time zones |
| GET | /transaction_accounts/{id} | Get transaction account |
| PUT | /transaction_accounts/{id} | Update transaction account |
| GET | /transaction_accounts/{id}/transactions | List transactions in transaction account |
| POST | /transaction_accounts/{id}/transactions | Create a transaction in transaction account |
| GET | /transactions/{id} | Get a transaction |
| PUT | /transactions/{id} | Update a transaction |
| DELETE | /transactions/{id} | Delete transaction |
| GET | /transactions/{id}/attachments | List attachments in transaction |
| POST | /transactions/{id}/attachments | Assigns attachment to transaction |
| DELETE | /transactions/{transaction_id}/attachments/{attachment_id} | Unassigns attachment in transaction |
| GET | /users/{id} | Get user |
| PUT | /users/{id} | Update user |
| GET | /users/{id}/accounts | List accounts in user |
| POST | /users/{id}/accounts | Create an account in user |
| PUT | /users/{id}/accounts | Update the display order of accounts in user |
| GET | /users/{id}/attachments | Lists attachments in user |
| POST | /users/{id}/attachments | Create attachment in user |
| GET | /users/{id}/budget | List budget for user |
| GET | /users/{id}/budget_summary | Get budget summary for user |
| GET | /users/{id}/categories | List categories in user |
| POST | /users/{id}/categories | Create category in user |
| GET | /users/{id}/category_rules | List category rules in user |
| GET | /users/{id}/events | List events in user. |
| DELETE | /users/{id}/forecast_cache | Delete forecast cache for user |
| GET | /users/{id}/institutions | List institutions in user |
| POST | /users/{id}/institutions | Create institution in user |
| GET | /users/{id}/labels | List labels in user |
| GET | /users/{id}/saved_searches | List saved searches in user |
| GET | /users/{id}/transaction_accounts | List transaction accounts in user |
| GET | /users/{id}/transactions | List transactions in user |
| GET | /users/{id}/trend_analysis | Get trend analysis for user |
Questions
Does the PocketSmith API need an API key?
Yes. The PocketSmith API uses API key authentication; the documentation explains how to get credentials.
Does the PocketSmith API support HTTPS?
Yes, the PocketSmith API is served over HTTPS.
How many endpoints does the PocketSmith API have?
Its OpenAPI description lists 56 endpoints in version 2.0. All of them are shown on this page.
What are alternatives to the PocketSmith API?
Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.
Similar finance APIs
Compare alternatives →
Stripe
FinancePayment processing, subscriptions, and financial management
SEC EDGAR Data
FinanceAPI to access annual reports of public US companies
Plaid
FinanceConnect with user's bank accounts and access transaction data
Fed Treasury
FinanceU.S. Department of the Treasury Data
Razorpay IFSC
FinanceIndian Financial Systems Code (Bank Branch Codes)
Klarna
FinanceKlarna payment and shopping service
Listed from APIs.guru (CC0).