Data & Analytics

Batch/bulk financing decisions

Stateless batch scoring: accepts an array of inline scenarios and returns ranked decisions per item in one call, so a backend can score a whole portfolio without persisted cohorts or per-borrower HTTP loops. Each scenario is evaluated by the same decision engine that powers /v1/simulate-decision (single source of truth); the MCP batch_decisions tool and the consumer-app Playground batch mode call this route. Per-item engine misses are partial successes (status: no_qualifying_offer) and never fail the whole batch.

Billing: each scenario counts as one API call (a 25-scenario batch bills 25 calls); a rejected batch (4xx) bills a single call.

Authentication required: Pass your API key in the X-API-Key header.

post/v1/decisions/batch

Request

  • Base URL: https://api.rateapi.dev
  • URL: https://api.rateapi.dev/v1/decisions/batch
  • Auth: API key in header X-API-Key

Request body

statestring

Optional default 2-letter US state applied to scenarios lacking one.

credit_scoreinteger

Optional default credit score applied to scenarios lacking one.

max_providersinteger

Top-N offers returned per scenario. Defaults to 3.

Example request

{
  "state": "CA",
  "credit_score": 740,
  "max_providers": 3
}

Response

Ranked decisions per scenario. Rows are ranked 1..n across the batch by best-offer APR ascending; rows with no qualifying offer rank last.

countinteger

Equals scenarios.length.

Changes

No recorded changes to this operation across all 1 revision of this API.