Skip to main content

Sandbox & Interactive Testing

Scalar interactive console​

A live interactive console is available directly on the API server at /docs/scalar. You can type in any address, fill out request parameters, and execute real API calls in your browser — no code required.

Every endpoint in the API Reference also includes a Try It panel where you can send requests inline.

Using a sandbox API key​

warning

Do not paste your production API key into browser-based tools. Use your sandbox key for all interactive testing.

Your sandbox key is available in the dashboard under API Keys → Sandbox. It has the same endpoint access as your production key but is rate-limited and isolated from production billing.

Testing with curl​

All examples in this documentation use curl. The fastest way to test any endpoint is to copy an example, replace YOUR_API_KEY, and run it in your terminal.

# Verify your key works
curl https://api.padstats.io/health -H "X-API-Key: YOUR_API_KEY"
# Expected: {"status": "healthy", "version": "..."}

Postman collection​

A Postman collection with all 30 endpoints is available for download. Import it into Postman to get pre-built requests for every endpoint with example parameters:

Download padstats-api.postman_collection.json

After importing:

  1. Open the collection settings (click the ... menu → Edit)
  2. Go to the Authorization tab
  3. Replace YOUR_API_KEY with your actual API key

All requests inherit the API key automatically — no need to set it per request. The base URL defaults to https://api.padstats.io.

What is Postman?

Postman is a free tool for testing APIs visually. Instead of writing curl commands, you fill in parameters in a form, click Send, and see the response. It's the fastest way to explore an API.