> For the complete documentation index, see [llms.txt](https://indigo-dc.gitbook.io/cloud-provider-ranker/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://indigo-dc.gitbook.io/cloud-provider-ranker/api.md).

# API

The provided APIs are:

* POST `/rank`

## `/rank`

As already introduced in the [Running the Cloud Provider Ranker](/cloud-provider-ranker/running.md) chapter, it performs the ranking of the services provided by cloud providers based on an internal algorithm which uses weights and normalization parameters (described in the [Ranking Algorithm](/cloud-provider-ranker/ranking_algorithm.md) chapter).

The payload the client must send in a POST HTTP request is described in the [Ranking Algorithm](/cloud-provider-ranker/ranking_algorithm.md) chapter.

The [Ranking JSON request format](/cloud-provider-ranker/json_request_format.md) chapter describes the request the user must submit to the `/rank` API, and the [Ranking JSON response format](/cloud-provider-ranker/json_response_format.md) chapter describes the format of the returned response.