monetr logo
monetr
    GitHub
    ???
    Sign In

    monetr REST API

    Everything the monetr app does, it does through this API. There's no second, private set of endpoints that the app gets and you don't, so anything you can do by clicking, you can do from a script.

    You authenticate with an API key over HTTP Basic auth. Amounts are integers in the currency's smallest unit, and on transactions a positive number means money leaving your account. Those two facts cause more confusion than everything else combined, so the overview covers them before anything else.

    Quickstart

    Overview

    Transactions

    Recurrence Rules

    Every endpoint

    Grouped by the page that documents it.

    Overview

    Cross-cutting behavior. Read this first.

    Quickstart and Recurrence Rules

    Guides rather than reference.

    MethodPath
    GET/api/links
    POST/api/links
    GET/api/links/:linkId
    PATCH/api/links/:linkId
    DELETE/api/links/:linkId

    Bank Accounts

    MethodPath
    GET/api/bank_accounts
    POST/api/bank_accounts
    GET/api/bank_accounts/:bankAccountId
    PATCH/api/bank_accounts/:bankAccountId
    DELETE/api/bank_accounts/:bankAccountId
    GET/api/bank_accounts/:bankAccountId/balances

    Transactions

    MethodPath
    GET/api/bank_accounts/:bankAccountId/transactions
    POST/api/bank_accounts/:bankAccountId/transactions
    GET/api/bank_accounts/:bankAccountId/transactions/:transactionId
    PATCH/api/bank_accounts/:bankAccountId/transactions/:transactionId
    DELETE/api/bank_accounts/:bankAccountId/transactions/:transactionId
    GET/api/bank_accounts/:bankAccountId/transactions/:transactionId/similar

    Spending

    MethodPath
    GET/api/bank_accounts/:bankAccountId/spending
    POST/api/bank_accounts/:bankAccountId/spending
    GET/api/bank_accounts/:bankAccountId/spending/:spendingId
    PUT/api/bank_accounts/:bankAccountId/spending/:spendingId
    PATCH/api/bank_accounts/:bankAccountId/spending/:spendingId
    DELETE/api/bank_accounts/:bankAccountId/spending/:spendingId
    POST/api/bank_accounts/:bankAccountId/spending/transfer
    GET/api/bank_accounts/:bankAccountId/spending/:spendingId/transactions

    Funding Schedules

    MethodPath
    GET/api/bank_accounts/:bankAccountId/funding_schedules
    POST/api/bank_accounts/:bankAccountId/funding_schedules
    GET/api/bank_accounts/:bankAccountId/funding_schedules/:fundingScheduleId
    PATCH/api/bank_accounts/:bankAccountId/funding_schedules/:fundingScheduleId
    DELETE/api/bank_accounts/:bankAccountId/funding_schedules/:fundingScheduleId

    Forecast

    MethodPath
    GET/api/bank_accounts/:bankAccountId/forecast
    POST/api/bank_accounts/:bankAccountId/forecast/spending
    POST/api/bank_accounts/:bankAccountId/forecast/next_funding

    Uploads and Files

    MethodPath
    POST/api/bank_accounts/:bankAccountId/transactions/upload
    GET/api/bank_accounts/:bankAccountId/transactions/upload/:transactionUploadId
    GET/api/bank_accounts/:bankAccountId/transactions/upload/:transactionUploadId/progress
    GET/api/files

    Lunch Flow

    Self-hosted only.

    MethodPath
    GET/api/lunch_flow/link
    POST/api/lunch_flow/link
    GET/api/lunch_flow/link/:lunchFlowLinkId
    GET/api/lunch_flow/link/:lunchFlowLinkId/bank_accounts
    POST/api/lunch_flow/link/:lunchFlowLinkId/bank_accounts/refresh
    POST/api/lunch_flow/link/sync
    GET/api/lunch_flow/link/sync/:linkId/bank_account/:bankAccountId/progress

    Users

    MethodPath
    GET/api/users/me
    GET/api/users/:userId
    PUT/api/users/security/password
    POST/api/users/security/totp/setup
    POST/api/users/security/totp/confirm

    API Keys

    MethodPath
    GET/api/keys
    POST/api/keys
    DELETE/api/keys/:apiKeyId

    Authentication

    The web app's sign-in flow. Not reachable with an API key.

    MethodPath
    POST/api/authentication/login
    POST/api/authentication/multifactor
    GET/api/authentication/logout
    POST/api/authentication/register
    POST/api/authentication/verify
    POST/api/authentication/verify/resend
    POST/api/authentication/forgot
    POST/api/authentication/reset

    Billing

    Hosted only.

    MethodPath
    POST/api/billing/create_checkout
    GET/api/billing/checkout/:checkoutSessionId
    GET/api/billing/portal

    Health and Reference

    MethodPath
    GET/api/health
    HEAD/api/health
    GET/api/locale/currency

    Webhooks

    Inbound only. You never call these.

    MethodPath
    POST/api/plaid/webhook
    POST/api/stripe/webhook

    Internal Endpoints

    These serve the monetr app and can change without notice.

    MethodPath
    GET/api/config
    POST/api/authentication/challenge
    POST/api/icons/search
    GET/api/institutions/:institutionId
    GET/api/plaid/link/token/new
    POST/api/plaid/link/token/callback
    PUT/api/plaid/link/update/:linkId
    POST/api/plaid/link/update/callback
    GET/api/plaid/link/setup/wait/:linkId
    POST/api/plaid/link/sync
    GET/api/mappings
    POST/api/mappings
    POST/api/bank_accounts/:bankAccountId/transactions/import
    GET/api/bank_accounts/:bankAccountId/transactions/import/:transactionImportId
    PATCH/api/bank_accounts/:bankAccountId/transactions/import/:transactionImportId