Skip to main content

How to use the Spur API and Swagger Environment

Understand how to use our API docs and convert it into curl requests

Updated yesterday

The UI can only take you far enough, that is why we have the Spur API. Docs here.

How to use the Spur API Documentation

When you open the page, you'll get the interactive swagger documentation

The first step is to generate an API key, follow this guide to generate one.

Then click on Authorize, and paste the key there, just paste the key, no need to add "Bearer <key>"

Now you're ready to test, to test, select any API you'd like to test. Then hit "Try it Out"

Check the payload, and then finally hit execute

After the query is complete you'll get the response, if its an error you get the code and error details to debug the response.

How to convert Spur API Request to cURL

  1. Open the network tab by hitting fn + F12

  2. Clear the current requests to avoid any confusion

3. Now hit execute again

4. You'll get the request in the tab, just hit right click and copy as cURL

If there is any API you want, but not in our documentation, just create a feature request here.

Did this answer your question?