Testing in the playground

Every endpoint has a live test console, the playground, so you can try an API before writing any code.

Before you start

You need to be signed in and subscribed to the API. The free Basic plan is enough if it has one. Calls made from the playground are real calls: they count towards your quota and appear in your request logs.

Running a request

1. Open an endpoint from the API's Endpoints list (or click Open Playground).
2. Fill in the Request panel:
   • Path Params and Params (query parameters) are pre-filled with example values where the provider supplied them.
   • Headers: add any extra headers the endpoint needs. Your API key is added for you.
   • Body: for endpoints that take one, edit the JSON example, or choose a file for upload endpoints.
3. Click Test Endpoint.

Reading the result

The Results tab shows:

• the status (for example 200 OK), how long the call took, and the response size;
• the Response as formatted JSON, plain text or raw output, plus its Headers;
• the Request exactly as it was sent;
• Info such as the request ID, which is useful when asking the provider for help.

Images, audio and other binary responses are shown or offered as a download instead of text.

Code snippets

The Code Snippets tab turns the request you've built into ready-to-run code: cURL, JavaScript, Python and more. The snippet already contains the gateway address and your parameters. Replace the key placeholder with your own key, or copy the snippet while signed in and it's filled in for you.

Example responses

The Example Responses tab shows the responses the provider documented, including the error formats, even before you make a call.