Skip to content

API

Escalake as infrastructure

A REST API for series, values and computed adjustments. Call it from procurement, ERP or accounts payable so the adjusted price lands where the work already happens.

The Escalake REST API exposes the same objects the interface uses: index series, observations, price adjustment models, and computed adjustments for any period. Filter observations by version, preliminary, final, or revised, or ask for the value as it stood on a given date, and the response states which version it returned. Confirmation state from the sign-off step is included on the adjustment response. Call it from procurement, an ERP, or accounts payable so the adjusted price lands where the work already happens, reading from the same versioned data layer as the app.

GET /v1/pams/:id/adjustment?version=FINAL
curl https://api.escalake.com/v1/pams/steel-frame-2024/adjustment?version=FINAL \
  -H "Authorization: Bearer $ESCALAKE_KEY"

{
  "period": "2024-Q3",
  "adjustmentPct": 4.71,
  "cumulativeAdjustmentPct": 11.38,
  "dataVersion": "FINAL",
  "formulaVersion": 3,
  "confirmed": { "buyer": "2024-10-14", "supplier": "2024-10-15" },
  "components": [
    { "series": "PPI: Steel Mill Products", "weight": 0.55, "change": 6.9 },
    { "series": "ECI: Manufacturing",       "weight": 0.30, "change": 3.1 }
  ]
}
ENDPOINTS

Read series, values and computed adjustments

The same objects the interface uses. List and fetch index series, pull observations for a range, list price adjustment models, and get the computed adjustment for any period.

v1 resources

GET/v1/series
GET/v1/series/:id/values
GET/v1/pams
GET/v1/pams/:id
GET/v1/pams/:id/adjustment
VERSIONS

Versioned data on every request

Filter observations by PRELIMINARY, FINAL or REVISED. Ask for the value as it stood on a given date. The response states which version it returned, so downstream systems record the same thing Escalake did.

GET /v1/series/PPI-WPU101/values?version=FINAL

2024-08134.02
versionFINAL
asOf2024-11-13

Details

What you get around the endpoints

Bearer-key auth

Keys are scoped per tenant and stored encrypted. Rotate without downtime.

Pagination and limits

Cursor pagination on list endpoints, with published rate limits per plan.

Webhooks

Event delivery on confirmation and data refresh is on the roadmap.

The API, common questions

What can the Escalake API do?

List and fetch index series, pull observations for a date range, list price adjustment models, and get the computed adjustment for any period. These are the same objects the web interface uses, returned as JSON over REST v1.

How does API authentication work?

Requests use a bearer key in the Authorization header. Keys are scoped per tenant and stored encrypted, and you can rotate a key without downtime by issuing a new one before retiring the old.

Does the API return versioned index data?

Yes. Filter observations by PRELIMINARY, FINAL, or REVISED, or request the value as of a specific date. Every response states the version it returned, so a downstream system records the same figure Escalake used.

Are there rate limits and pagination?

List endpoints use cursor pagination, and each plan has a published rate limit. The adjustment endpoints return the full component breakdown, cumulative adjustment, and confirmation dates in a single response.

Automate the mechanism, not the judgement.

Escalake Method

Put the adjusted price where the work is.

REST v1, versioned, tenant-scoped.