Playground

Testing the API With the Playground

Overview

Explore the API with the Playground. The Playground is a web-based interface that allows you to interact with the API in real-time. You can test different endpoints, view responses, and experiment with various parameters.

Getting Started

Each reference page includes a "Playground" section where you can test the API. The Playground is designed to be user-friendly and intuitive, allowing you to quickly understand how to use the API.

Playground Preview

Setting the API Key

Once you have your API key, you can set it in the Playground at the Headers section. This will allow you to authenticate your requests and access the API's features.

Playground Headers

Adding Parameters

You can add parameters to your requests in the Playground. This allows you to customize your requests and test different scenarios. The Playground provides a user-friendly interface for adding and modifying parameters.

Playground Params

Response Viewer

After you send a request, the Playground will display the response in a user-friendly format. You can view the response data, headers, and status code. This makes it easy to understand how the API is responding to your requests.

Playground Response

Request Examples

You can also view request examples in the Playground. This allows you to see how to structure your requests and understand the expected response format. The Playground provides examples for different programming languages, making it easy to integrate the API into your applications. Playground Examples

If you have any problem with the playground, use the requests in the curl tab. This will give you the exact request that is being sent to the API, which you can then use in your own code or tools.

On this page