canonical: https://jentic.com/apis/ntropy.network/ntropy-transaction-api-v1

# Ntropy Network Ntropy Transaction API

The Ntropy Transaction API classifies and enriches bank transactions. This version of the spec exposes the batch-results endpoints: given a batch id, it returns the classification results for a set of business transactions or a set of consumer transactions. Each result carries the category and enrichment Ntropy assigned to the transaction, which an agent reads to label and organise financial activity. It suits teams building bookkeeping, lending, or personal-finance features that need clean transaction categories rather than raw bank descriptions.

## For AI agents

Retrieve the results of a business or consumer transaction classification batch by its id, and read the category and enrichment assigned to each transaction. Authenticates with an Ntropy API key.

## Scope

Does not submit transactions for classification, aggregate bank accounts, or move money. Use for retrieving business and consumer transaction classification batch results by id only.

## Capabilities

- Retrieve the results of a business transaction classification batch by id
- Retrieve the results of a consumer transaction classification batch by id
- Read the category assigned to each transaction in a batch
- Read the enrichment Ntropy attached to each classified transaction
- Poll a batch id until its classification results are available

## Use cases

### Categorise business transactions for bookkeeping

A bookkeeping agent submits a batch of business transactions to Ntropy for classification and then retrieves the results by batch id to read each transaction's assigned category. It uses those categories to post entries to the right ledger accounts without a person coding each line. Through Jentic the agent discovers the batch-results operation by intent and calls it with the batch id.

Example prompt: Retrieve the classification results for a given business transaction batch id and return each transaction's category

### Enrich consumer transactions in a finance app

A personal-finance app reads Ntropy's consumer batch results to turn raw bank descriptions into clean merchant names and spending categories. An agent fetches the results for a batch id once processing is complete and maps each transaction to a budget category in the app. This gives users readable, grouped spending without manual tagging.

Example prompt: Retrieve the consumer classification results for a batch id and map each transaction to its spending category

### Poll a batch until results are ready

Because classification runs as a batch, an agent polls the batch-results endpoint by id until the results are available, then reads them in one pass. This lets a pipeline wait for a large batch without holding a request open. The agent handles the not-ready case and retries on a backoff.

Example prompt: Poll the business batch-results endpoint for a given batch id until results are returned, then read them

## Key resources

- **Business classification batches** — Retrieve business transaction classification results by batch id
- **Consumer classification batches** — Retrieve consumer transaction classification results by batch id

## Why Jentic

- **Setup:** Wiring the Ntropy Transaction API by hand means configuring its API key even though the spec does not declare the scheme, formatting the business and consumer batch-results calls, and polling each batch id to completion yourself. Through Jentic you install once, import the Ntropy Transaction API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** This version of the Ntropy Transaction API is read-only and addresses each batch by an id in the URL path, so you can scope the agent to the batch-results operations and the batches it needs. There are no write or delete operations to allow.
- **Credential handling:** Your Ntropy API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get transaction classification results', and Jentic returns the matching Ntropy operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **MX API** — Bank-data aggregation with its own transaction cleansing and categorisation versus Ntropy's classification results.
- **Yodlee API** — A financial-data platform that aggregates and categorises transactions across institutions.
- **Plaid API** — Plaid pulls the raw bank transactions that Ntropy can then classify and enrich.

## FAQ

### What authentication does the Ntropy Transaction API use?

Ntropy authenticates with an API key that you supply on each request. The published OpenAPI spec does not declare the security scheme, so provide the API key as described in Ntropy's own documentation. Through Jentic the key is stored encrypted by your own Jentic One instance and supplied to requests at execution time, so the agent never sees the raw value.

### What does this version of the Ntropy Transaction API return?

It exposes the batch-results endpoints: given a batch id, it returns the classification results for a set of business transactions or a set of consumer transactions. Each result carries the category and enrichment Ntropy assigned, so an agent reads clean categories rather than raw bank descriptions.

### How do I read classification results with the Ntropy Transaction API?

Call the business or consumer batch-results endpoint with the batch id you want. Because classification runs as a batch, an agent typically polls by id until the results are ready, then reads each transaction's assigned category in one pass and maps it into the app.

### What are the rate limits for the Ntropy Transaction API?

The OpenAPI spec does not declare rate limits for the Ntropy Transaction API. Apply conservative client-side throttling, back off on HTTP 429 responses, and check Ntropy's developer documentation for the current published limits.

### Can I limit what my agent is allowed to do with the Ntropy Transaction API?

Yes. This version of the API is read-only: both operations retrieve batch results and neither changes any data. Because each batch is addressed by an id in the URL path, you choose which operations the agent may call and can keep it to the batches it needs, and every call it makes is logged.

### Is there an Ntropy Transaction API MCP server?

You don't need an MCP server to give your agent the Ntropy Transaction API. Jentic connects it directly from the API Directory: import it, store the key once, and your agent calls the batch-results operations on demand without a separate server to run.

### How do I retrieve Ntropy classification results through Jentic?

Search Jentic for an intent like 'get transaction classification results', which returns the matching Ntropy operation with its input schema so the agent supplies the batch id and reads back the categorised transactions. To run it on your own infrastructure, install Jentic One from its GitHub repo.
