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

Headers Sent by API Proxy

Headers sent to the request

If you are an API provider, you will receive some additional headers appended in the request to your servers:

X-RapidAPI-Proxy-Secret
This is a secret unique key for every API that is appended by the proxy on every request. For high security, you can validate this secret server-side and check if it equals the key shown in the API Admin (under the 'Settings' tab at provider.rapidapi.com).

X-RapidAPI-User
The name of the user that's making the request.

X-RapidAPI-Subscription
The name of the subscription (if any). The values can be:

  • FREE
  • BASIC
  • PREMIUM
  • ULTRA
  • CUSTOM (if the user is subscribed to a custom plan.)

X-RapidAPI-Version
The version of the proxy

X-Forwarded-For
The IP address of the client making the request. It could be shown in a comma separated format like "184.73.132.126, 23.23.103.207" where the first IP address belongs to the client and any subsequent IP represents a proxy.

Headers sent as response

When consuming an API on RapidAPI, you will always receive the following headers appended to the response:

server
The current version of the API proxy used by RapidAPI.

x-ratelimit-requests-limit
The number of requests the plan you are currently subscribed to allows you to make, before incurring overages.

x-ratelimit-requests-remaining
The number of requests remaining before you reach the limit of requests your application is allowed to make, before experiencing overage charges.

X-RapidAPI-Proxy-Response
This header is set to true when the RapidAPI proxy generates the response, (i.e. the response is not generated from the provider)

Updated 10 months ago

Headers Sent by API Proxy


Suggested Edits are limited on API Reference Pages

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