Reading an API listing

Every API has its own listing at apihiver.com/apis/<api-name>. The left-hand menu takes you to each part of it.

Overview

The first page you see. It shows:

• The header: name, logo, the one-line summary, star rating, and badges such as Freemium (there's a free plan to start on).
• Health metrics: popularity, service level and latency over the last 30 days.
• Pricing summary: the monthly price of each plan. The Pricing tab has the full details.
• Documentation: the provider's guide. It usually covers what you get, a quick-start example, a list of endpoints, the errors the API returns, and where its data comes from.
• Provider info (right-hand side): who made the API, how many subscribers it has, its category, when it was published, and links to the provider's website and terms of use.

Endpoints

The Endpoints list in the left-hand menu shows every operation the API offers, with its HTTP method (GET, POST…). Click one to see:

• what it does;
• its parameters: which are required, their types, allowed values and defaults;
• the request body, if it takes one, with example bodies;
• example responses: a real successful response and the errors it can return;
• code snippets in several languages, ready to copy.

Use the search box above the list to find an endpoint by name. The API's current version number is shown above the list.

Pricing

The Pricing tab compares every plan side by side: monthly price, requests per month, rate limit, whether the quota is a hard limit or allows overage, and the features included. Your current plan is marked Current Plan. See Subscribing to a plan.

Playground

Open Playground (or Test Endpoint on any endpoint) lets you send real requests from your browser. See Testing in the playground.

Discussions and reviews

Discussions is a public forum for the API, for questions, bug reports and feature requests. Reviews at the bottom of the Overview show star ratings and comments from other developers. See Discussions, reviews and support.