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

Embat Scenarios API

A `Scenario` represents a forecasting hypothesis in Embat's treasury forecast: a named, currency-denominated projection covering a defined horizon (`startPeriod` to `endPeriod`) at a given time granularity (`periodicity`). Only published scenarios are returned when listing scenarios.Scenarios are the grouping unit for `Forecasts`: each forecast belongs to one scenario, and its figures are only meaningful in the context of that scenario's currency, periodicity and horizon.**Typical flow:** list the company's published scenarios with `GET /scenarios/{companyId}` to discover which forecasting hypotheses are available, then use a scenario's `id` to retrieve its details with `GET /scenarios/{companyId}/{id}` or to filter the related `Forecasts` endpoints.

Embat Scenarios API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 2.120.3.

Requests are made against the base URL https://api.embat.io.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.120.3
Base URL
https://api.embat.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Embat Scenarios API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 2

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

Scenarios 2

A Scenario represents a forecasting hypothesis in Embat's treasury forecast: a named, currency-denominated projection covering a defined horizon (startPeriod to endPeriod) at a gi…

GET
/scenarios/{companyId}
List scenarios
list_scenarios_scenarios__companyId__get 1 param → 200401404422
GET
/scenarios/{companyId}/{id}
Retrieve scenario
retrieve_scenario_scenarios__companyId___id__get 2 params → 200401404422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GetScenarioResponseSchema (10 properties), ValidationError (5 properties), HTTPValidationError (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ListScenariosResponseSchema
object
1 property 1 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
CurrencyEnum
string
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
PeriodicityEnum
string
GetScenarioResponseSchema
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-scenarios-api-openapi.yml Raw ↑

Other APIs Embat publishes across the network.

Embat AccountingAccounts API
Embat AccountingEntries API
Embat Attributes API
Embat Authentication API
Embat Balances API
Embat Banks API
Embat Categories API
Embat Companies API
Embat Contacts API
Embat DebtScheduleConfigs API
Embat Files API
Embat Forecasts API