Documentation

Find the right Rateplane workflow before you configure it

Start with the product map to understand coverage and setup requirements, then use the guide, account-connection docs, pricing methodology, and API reference to operate each workflow from the right source data.

Product map

Buyers and evaluators

Review supported workflows and whether they are public, connected-account, integration-required, configured, admin-only, or partial.

User guide

FinOps and end users

Follow the operating path from catalog research to connected spend, budgets, allocation, recommendations, and reporting.

Pricing methodology

Finance and platform teams

Understand provider sources, normalization, freshness expectations, and where public catalog pricing differs from customer spend.

API reference

Developers and platform teams

Use documented endpoints for catalog search, comparisons, CSV export, and price-alert workflows.

Base URL

https://rateplane.com

Format

JSON responses, CSV exports

Coverage

8 documented endpoints

Capability coverage

Rateplane separates public catalog research from workspace features, connected-account workflows, integration-required setup, configured controls, admin-only operations, and partial or future-facing features. Use the product map when evaluating what is available before and after account connection.

Coverage source

The product map documents each workflow with required setup, trust notes, and primary routes.

Open product map

Workflow	Coverage type	Required setup	Details
Catalog and pricing reference	Public catalog	No cloud credentials for public catalog browsing; account required for saved workflows and alerts.	Product map
Compare, shortlist, and saved decisions	Workspace feature	Account required for saved comparisons and saved filters; public browsing still works without sign-in.	Product map
Cloud account connection and sync	Requires connected data	Read-only billing credentials or exports for AWS Cost Explorer, Azure Cost Management, or GCP BigQuery billing export.	Product map
Spend analytics and cost reporting	Requires connected data	Connected billing data and successful syncs.	Product map
Budgets, alerts, and guardrails	Requires connected data	Workspace account for saved budgets and alerts; connected spend for spend-based thresholds and forecasts.	Product map
Forecasting, planning, commitments, and contracts	Requires connected data	Connected spend for forecasts; manually entered or imported contract and commitment records for renewal planning.	Product map

Authentication

Endpoints marked Auth required need an authenticated Rateplane session or supported API credential. Public catalog endpoints can be called without authentication, subject to rate limits and fair-use controls.

Need SDK examples?

TypeScript, Python, and direct HTTP usage are covered separately.

Open SDK docs

API endpoint index

Public endpoints support catalog research. Authenticated endpoints use a Rateplane session or supported API credential.

Method	Path	Resource	Access
GET	/api/instances	Catalog	Public
GET	/api/instances/:id	Catalog	Public
GET	/api/regions	Catalog	Public
GET	/api/export	Export	Authenticated
GET	/api/alerts	Price Alerts	Authenticated
POST	/api/alerts	Price Alerts	Authenticated
DELETE	/api/alerts/:id	Price Alerts	Authenticated
GET	/api/compare	Compare	Public

Catalog

Read normalized compute catalog data for pricing analysis, migration planning, and internal cost tools.

Back to index

GET/api/instances

List instances from the normalized catalog with filtering and pagination.

Public

Parameter	Type	Required	Description
`q`	`string`	No	Full-text search across instance name, family, and description.
`provider`	`AWS \| AZURE \| GCP`	No	Filter to a single cloud provider.
`region`	`string`	No	Region name, such as us-east-1, eastus, or us-central1.
`priceType`	`ON_DEMAND \| SPOT \| RESERVED_1YR \| RESERVED_3YR`	No	Price type to sort and filter against. Default: ON_DEMAND.
`familyCategory`	`GENERAL \| COMPUTE \| MEMORY \| STORAGE \| GPU \| HPC`	No	Instance family category.
`minVcpus`	`number`	No	Minimum vCPU count.
`maxVcpus`	`number`	No	Maximum vCPU count.
`minMemoryGb`	`number`	No	Minimum memory in GiB.
`maxMemoryGb`	`number`	No	Maximum memory in GiB.
`maxHourly`	`number`	No	Maximum on-demand hourly price in USD.
`page`	`number`	No	Page number, 1-based. Default: 1.
`pageSize`	`number`	No	Results per page. Default: 50, max: 200.

Example request

curl "https://rateplane.com/api/instances?provider=AWS&minVcpus=8&maxHourly=0.5&pageSize=10"

GET/api/instances/:id

Get a single instance offer by catalog ID.

Public

Example request

curl "https://rateplane.com/api/instances/aws-m7i.large-us-east-1"

GET/api/regions

List regions available in the catalog with display names.

Public

Example request

curl "https://rateplane.com/api/regions"

Export

Download filtered catalog data for finance models, procurement reviews, architecture analysis, or internal tooling.

Back to index

GET/api/export

Export the current filtered catalog view as CSV. Accepts the same query parameters as /api/instances.

Auth required

Parameter	Type	Required	Description
`q`	`string`	No	Full-text search.
`provider`	`string`	No	Cloud provider.
`region`	`string`	No	Region name.
`priceType`	`string`	No	Price type.

Example request

curl -H "Cookie: next-auth.session-token=..." \
  "https://rateplane.com/api/export?provider=GCP&minVcpus=4" \
  -o instances.csv

Price Alerts

Create, list, and remove threshold notifications for instance types and regions your team monitors.

Back to index

GET/api/alerts

List all price alerts for the authenticated user.

Auth required

Example request

curl -H "Cookie: next-auth.session-token=..." \
  "https://rateplane.com/api/alerts"

POST/api/alerts

Create a new price alert. A confirmation email is sent to the alert email address.

Auth required

Parameter	Type	Required	Description
`provider`	`AWS \| AZURE \| GCP`	Yes	Cloud provider.
`instanceName`	`string`	Yes	Instance type name, such as m7i.large.
`instanceLabel`	`string`	Yes	Human-readable instance label.
`regionName`	`string`	Yes	Region identifier.
`regionLabel`	`string`	Yes	Human-readable region name.
`condition`	`BELOW \| ABOVE`	Yes	Trigger condition.
`targetPrice`	`number`	Yes	Target price in USD/hr.
`priceType`	`string`	No	Price type. Default: ON_DEMAND.
`email`	`string`	Yes	Email address for the alert notification.

Example request

curl -X POST -H "Content-Type: application/json" \
  -H "Cookie: next-auth.session-token=..." \
  -d '{"provider":"AWS","instanceName":"m7i.large","instanceLabel":"m7i.large","regionName":"us-east-1","regionLabel":"US East (N. Virginia)","condition":"BELOW","targetPrice":0.09,"email":"you@example.com"}' \
  "https://rateplane.com/api/alerts"

DELETE/api/alerts/:id

Delete a price alert.

Auth required

Example request

curl -X DELETE -H "Cookie: next-auth.session-token=..." \
  "https://rateplane.com/api/alerts/clx..."

Compare

Fetch selected catalog offers for side-by-side reviews across providers, regions, and workload shapes.

Back to index

GET/api/compare

Fetch multiple instances by ID for side-by-side comparison.

Public

Parameter	Type	Required	Description
`id`	`string[]`	Yes	One or more catalog offer IDs. Repeat the param: ?id=a&id=b.

Example request

curl "https://rateplane.com/api/compare?id=aws-m7i.large-us-east-1&id=azure-Standard_D4s_v5-eastus"

Rate Limits

Limits vary by plan and endpoint family. Use the values below for integration planning, cache catalog reads where possible, and handle 429 responses with retry backoff.

Plan	Catalog reads	Exports	Alerts
Starter	60 req/min	Catalog CSV	5 active
Team	300 req/min	Catalog and connected-data exports where data exists	100 active
Business	600 req/min	Catalog and connected-data exports where data exists	500 active
Enterprise	1,000 req/min	Catalog and connected-data exports where data exists	1,000 active