Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Narmi reports API

The reports API from Narmi — 3 operation(s) for reports.

Narmi reports API is one of 44 APIs that Narmi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.sandbox.narmi.dev/.

3 operations 3 paths 7 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.sandbox.narmi.dev/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Narmi reports API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

reports 3
GET
/v1/reports/bai_transaction_types/
List BAI transaction type codes
reports_bai_transaction_types_list → 200
POST
/v1/reports/transactions_download/
Export multi-account transactions
reports_transactions_download_create body → 200400404
POST
/v1/reports/transactions_stats/
Get multi-account transaction statistics
reports_transactions_stats_create body → 200400404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are MultiAccountTransactionsDownloadRequest (6 properties), TransactionStatsResponse (4 properties), BaiTransactionType (3 properties), InvalidRequestError (2 properties). Each schema is shown below with its type and property counts.

NotFoundError
object
2 properties 1 required
InvalidRequestError
object
2 properties
FormatEnum
string
csv - CSV bai2 - BAI2
TransactionStatsResponse
object
4 properties 4 required
BaiTransactionType
object
3 properties 3 required
MultiAccountTransactionsDownloadRequest
object
Serializer for multi-account transaction export requests.
6 properties 3 required
DirectionEnum
string
credit - credit debit - debit misc - misc

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-reports-api-openapi.yml Raw ↑

Other APIs Narmi publishes across the network.

Narmi account balances API
Narmi accounts API
Narmi ach companies API
Narmi ach destinations API
Narmi ach import API
Narmi ach payments API
Narmi ach transfers API
Narmi alerts API
Narmi automatic savings enrollment API
Narmi card linked offers API
Narmi cards API
Narmi data access management API