Skip to content
GridRouterhome

Search

Search providers, capabilities and pages

Docs
Waterfalls

Estimate a waterfall

POST
/v1/waterfalls/estimate

Price a waterfall before running it, without calling any vendor: per-step quote, p50 latency, fill and reach, plus worst-case and expected cost (micro-USD) and ETA. Pass a definition, or a template id with the same pins/speed/max_cost_micro choices as waterfall_create_from_template.

Authorization

bearer
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/waterfalls/estimate" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "waterfall_estimate",  "steps": [    {      "stage_id": "string",      "step_id": "string",      "endpoint_id": "string",      "provider": "string",      "eligible": true,      "reason": "circuit_open",      "quote_micro": 0,      "p50_ms": 0,      "fill": 0,      "rps": 0,      "reach": 0    }  ],  "worst_case_cost_micro": 0,  "expected_cost_micro": 0,  "expected_ms": 0,  "worst_case_ms": 0,  "expected_fill": 0,  "issues": [    {      "path": "string",      "message": "string"    }  ]}