Quickstart

This guide will help you get ready to use the Rankbid API. We’ll cover how to authenticate and how to make your first request.

API keys

Before you can make requests to the Rankbid API, you will need to generate an API key from the dashboard settings. You will find it under Settings » API keys.

Making your first API request

After generating your API key, you are ready to make your first call to the Rankbid API. The root URL for the API is https://www.rankbid.io/api/v1/. Below, you can see how to send a GET request to the Auctions endpoint to get a list of all your auctions. In the cURL example, results are limited to 10 auctions. The default page length is 100.

curl -G https://www.rankbid.io/api/v1/auctions \
  -H "Authorization: Bearer {api_key}" \
  -d limit=10

Testing your integration

If you need to test your integration with the Rankbid API, you can request an access to our test envirionment. To do so, please contact us.

What's next?

You are now set up and ready to use the API. Here are a few links that might be handy as you venture further into the Rankbid API:

• Check out the Auctions endpoint
• Check out the Bids endpoint
• Learn about paginated results