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

To get started using Elixir to consume APIs on RapidAPI, add rapid_api to your list of dependencies in mix.exs:

def deps do
    [{:rapid_api, "~> 1.0.2"}]
end

Next, ensure rapid_api is started before your application:

def application do
    [applications: [:rapid_api]]
end

You can now instantiate a new RapidAPI client by creating a new config/config.exs file and adding your ProjectName and ProjectKey like this:

config :rapid_api,
  project: "ProjectName",
  key: "ProjectKey"

To call the API, all you have to do is write the following code:

RapidApi.call('APIName', 'Endpoint', %	 
	 ParameterKey1: "ParameterValue1",
	 ParameterKey2: "ParameterValue2",
	 ParameterKey3: "ParameterValue3",
)