Get your API key
Enter your email at https://finprim.dev/ to receive your API key instantly.
Install the CLI
npm install -g finprim-cli
Set your API key
export FINPRIM_API_KEY=sk_finprim_xxx
Run your first command
finprim runway
Required to use financial endpoints with real data. Finprim uses Plaid to securely link your bank in seconds.
Connect your bank →Powered by Plaid — read-only access, we never store your credentials.
All API endpoints require your API key in the Authorization header:
curl https://finprim.dev/runway \
-H "Authorization: Bearer sk_finprim_xxx"
Health check — verify the API is running.
Example
curl https://finprim.dev/ping
Response
{
"name": "Finprim API",
"version": "1.0.0",
"status": "ok"
}
Calculate runway from real-time Plaid balance and 90-day burn rate.
Example
curl https://finprim.dev/runway \
-H "Authorization: Bearer sk_finprim_xxx"
Response
{
"current_balance": 84200,
"monthly_burn": 12400,
"runway_months": 6.8,
"runway_date": "2026-10-15",
"alert": "WARNING",
"balance_source": "plaid_realtime",
"message": "Warning: at the current burn rate..."
}
Full financial summary for a given month.
Parameters
month YYYY-MM format — defaults to current monthExample
curl "https://finprim.dev/report?month=2026-03" \
-H "Authorization: Bearer sk_finprim_xxx"
Response
{
"period": "2026-03",
"total_spent": 38200,
"monthly_burn": 12733,
"top_categories": [
{ "category": "PAYROLL", "total": 18000 },
{ "category": "SOFTWARE", "total": 6400 },
{ "category": "TRAVEL", "total": 3200 }
],
"transaction_count": 47,
"biggest_transaction": { ... }
}
Recent transactions formatted for LLMs.
Parameters
days Lookback window in days — default: 30Example
curl "https://finprim.dev/transactions?days=30" \
-H "Authorization: Bearer sk_finprim_xxx"
Response
[
{
"date": "2026-03-28",
"amount": 299,
"merchant": "AWS",
"category": "SOFTWARE"
},
...
]
Average monthly burn over N months.
Parameters
months Number of months to analyze — default: 3Example
curl "https://finprim.dev/burn-rate?months=3" \
-H "Authorization: Bearer sk_finprim_xxx"
Response
{
"total_spent": 37200,
"monthly_burn": 12400,
"months_analyzed": 3,
"biggest_expense_category": "PAYROLL"
}
Detect recurring payments automatically from 12 months of transaction history.
Example
curl https://finprim.dev/subscriptions \
-H "Authorization: Bearer sk_finprim_xxx"
Response
[
{
"merchant": "GitHub",
"amount": 21,
"frequency": 12,
"estimated_monthly_cost": 21,
"category": "SOFTWARE"
},
...
]
Expenses grouped by category for a given month.
Parameters
month YYYY-MM format — defaults to current monthExample
curl "https://finprim.dev/categorize?month=2026-03" \
-H "Authorization: Bearer sk_finprim_xxx"
Response
[
{ "category": "PAYROLL", "total": 18000, "count": 4, "percentage": 47.12 },
{ "category": "SOFTWARE", "total": 6400, "count": 18, "percentage": 16.75 },
...
]
Detect abnormal expenses versus 90-day merchant history.
Parameters
threshold Percentage deviation to trigger alert — default: 50Example
curl "https://finprim.dev/anomaly?threshold=50" \
-H "Authorization: Bearer sk_finprim_xxx"
Response
{
"anomalies": [
{
"merchant": "AWS",
"expected_amount": 299,
"actual_amount": 1840,
"delta_percent": 515.38,
"date": "2026-03-01",
"alert": "HIGH"
}
],
"total_anomalies": 1,
"scan_period_days": 90
}
30/60/90-day treasury projection based on average monthly net cash flow.
Example
curl https://finprim.dev/cashflow \
-H "Authorization: Bearer sk_finprim_xxx"
Response
{
"current_balance": 84200,
"avg_monthly_burn": 12400,
"avg_monthly_revenue": 9800,
"avg_monthly_net": -2600,
"projected_balance_30d": 81600,
"projected_balance_60d": 79000,
"projected_balance_90d": 76400,
"trend": "declining",
"weeks_until_critical": 28.8,
"balance_source": "plaid_realtime"
}