Resources

Providers

These methods read recommendations, savings and costs for one cloud at a time. The provider IDs are aws, gcp, azure and k8s, and every method except List providers takes one.

Only List providers lives on client.providers. That namespace has exactly one method. Everything else on this page is grouped by what it reads, not by where it lives, so the calls sit on client.recommendations and client.costs and take a provider ID as their first argument.

A provider carries data only once you have connected it.

A provider your organization has not connected returns 404 on every provider-scoped path below. Call List providers first rather than assuming an ID is available.

List providers

Returns all configured cloud providers for your account.

providers = client.providers.list()

Recommendations

Get top recommendations

Returns the top 7 recommendations for a specific provider, sorted by savings.

top = client.recommendations.get_top("aws")

List recommendations

Returns a paginated, filterable list of recommendations for a provider.

page = client.recommendations.list_by_provider(
    "aws",
    page=1,
    page_size=50,
    sort_by="monthly_savings",
    sort_order="desc",
    service=["EC2", "RDS"],
    environment=["production"],
    display_status=["available", "pending"],
)

for rec in page:
    print(f"{rec.recommendation_id}: ${rec.monthly_savings}/mo")

Parameters

ParameterTypeDescription
provider_idstringProvider: aws, gcp, azure, k8s
startstringStart date (ISO 8601: YYYY-MM-DD)
endstringEnd date (ISO 8601: YYYY-MM-DD)
pageintPage number (1-indexed)
page_sizeintItems per page
sort_bystringSort field: recommendation_id, service, environment, account, tag, monthly_savings, savings_percentage, status
sort_orderstringasc or desc
servicestring[]Filter by service(s)
environmentstring[]Filter by environment(s)
accountstring[]Filter by account(s)
tagstring[]Filter by tag(s)
display_statusstring[]Filter by status: available, pending, processing, optimized, rejected, unavailable

Pagination has the defaults these parameters fall back to, the page-size cap, and the auto-paginating iterators.

Get recommendations overview

Returns overview metrics for a provider: total spend, available savings, pending savings, and saved-to-date.

overview = client.recommendations.get_provider_overview("aws")

Get recommendation filters

Returns the distinct values available for filtering: environments, accounts, and tags.

filters = client.recommendations.get_provider_filters("aws")

Realized savings

List realized savings

Returns a paginated, filterable list of realized savings for a provider.

page = client.recommendations.audit.list_by_provider(
    "aws",
    page=1,
    page_size=50,
    preset="6M",
    service=["EC2"],
)

Get realized savings summary

Returns aggregate savings totals for a provider.

summary = client.recommendations.audit.get_provider_summary("aws")

Costs

Get costs summary

Returns a costs summary for a specific provider.

costs = client.costs.get_provider_summary("aws")

Get costs filters

Returns distinct services, regions, and accounts available for filtering within a date range.

filters = client.costs.get_provider_filters(
    "aws",
    start="2025-01-01T00:00:00.000Z",
    end="2025-03-31T00:00:00.000Z",
)

List costs

Returns a cost breakdown for a provider in multiple formats: table, chart, csv, raw.

costs = client.costs.list_by_provider(
    "aws",
    format="table",
    page=1,
    page_size=50,
    sort_by="cost",
    sort_order="desc",
)

Get costs timeline

Returns a costs timeline for a provider over a date range.

timeline = client.costs.get_provider_timeline(
    "aws",
    start="2025-01-01T00:00:00.000Z",
    end="2025-03-31T00:00:00.000Z",
)

Potential savings

Get potential savings summary

Returns potential savings summary for a provider.

potential = client.recommendations.get_provider_potential_savings_summary("aws")

List potential savings

Returns a paginated potential savings breakdown for a provider.

page = client.recommendations.list_provider_potential_savings(
    "aws",
    page=1,
    page_size=50,
)

Next

  • Recommendations has the same reads under the recommendations namespace, plus the ones that span every provider
  • Costs does the same for cost breakdowns, and carries the full grouping and tag filter table
  • Savings is realized savings, including the SavedItem response shape
  • Filtering and sorting turns these parameters into recipes you can run
  • /api-reference/providers is the generated REST reference for every endpoint here