The RapidAPI Developer Hub

Welcome to the RapidAPI developer hub. You'll find comprehensive guides and documentation to help you start working with RapidAPI as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides

Add an API (Basics)

How to add an API to RapidAPI in a few quick steps

This guide will walk you through the easy process of adding your API to RapidAPI by using the Provider Dashboard. Listing your API exposes it to over a million developers in a matter of minutes! The RapidAPI Provider Dashboard is our main hub for adding and managing APIs.

To add an API click Add New API on the left-hand side of the dashboard

The first screen that will appear is where you'll define the name of your API, a short description that appears in search, and the category your API will be included under.

Specifying Your API

There are several different options for specifying your API. By default, an API will use the UI definition through RapidAPI. If you would like to automate this process by uploading an API spec file, simply select "OpenAPI" and upload your OpenAPI file.


Open API Provisioning

Within Open API Provisioning, we currently support:

  • swagger: “2.0”
  • openapi: “3.0.0"
  • openapi: “3.0.1”
  • openapi: "3.0.2"

You can also choose to import a Postman Collection by simply uploading the Postman Collection file.

RapidAPI supports GraphQL APIs, so you can specify using a GraphQL Schema if applicable.

Best Practices for Naming Your API

  • Chose a name that is easily discoverable and descriptive
  • Capitalize the API's name
  • Remove API from the name

Overview Tab

After clicking 'Add API', the next page that you will see is the API overview definition. This is where you can add in more detailed information such as a longer description that appears on the API listing, a website URL, terms of use, and a logo for your API.

Updated 8 months ago

What's Next

The next step is to begin the process of Documenting your API.

Settings - Base URL, Access Control
Security - Threat Protection
Plans & Pricing

Add an API (Basics)

How to add an API to RapidAPI in a few quick steps

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.