Quick Start

This guide gets you from account creation to your first APIQuick proxy call. APIQuick proxy URLs hide provider backends, enforce API-key auth, check credits, apply endpoint rate limits, and meter usage.

Prerequisites

• An APIQuick account
• Available account credits
• curl, Postman, or any HTTP client

Create an Account

1. Go to apiquick.io/signup.
2. Create an account and verify your email.
3. Complete your profile so keys, credits, and usage can be attached to your account.

Generate an API Key

1. Open API Keys.
2. Create a key with proxy:invoke. Add apis:read and usage:read if your tooling needs collection metadata or usage data.
3. Copy the plaintext key immediately. It will not be shown again.

X-APIQUICK-API-KEY: aqk_...

Find an Endpoint

List published API collections:

curl "https://api.quickpod.org/apiquick/v1/apis?q=breach"

Then load a collection by slug to get tested, priced proxy endpoints:

curl "https://api.quickpod.org/apiquick/v1/apis/breach-api-7"

{
  "title": "Breach API",
  "slug": "breach-api-7",
  "endpoints": [
    {
      "method": "GET",
      "proxy_url": "https://api.quickpod.org/apiquick/v1/proxy/breach-api-7/get-breach-risk-by-domain",
      "credit_cost": 0.0010,
      "rpm_limit": 60
    }
  ]
}

Your First Proxy Call

curl -X GET "https://api.quickpod.org/apiquick/v1/proxy/breach-api-7/get-breach-risk-by-domain?domain=example.com"   -H "X-APIQUICK-API-KEY: aqk_..."

If the key is valid, the endpoint method matches, the rate limit allows the call, and your wallet has enough credits, APIQuick forwards the request to the hidden provider backend and returns the upstream response. Response headers include the charged cost and remaining balance.

X-APIQuick-Cost-USD: 0.0010
X-APIQuick-Balance-USD: 0.9990

Publish an API

Providers publish through API Onboarding:

1. Upload an OpenAPI or Postman file.
2. Review collection copy and endpoint listing details.
3. Set a positive price per invocation for every endpoint. Imported endpoints default to 0.0010.
4. Test endpoints through the playground. Successful 2xx proxy responses mark endpoints as working.
5. Publish the collection. Public listing pages show only tested, priced endpoints.

Next Steps

• Authentication — API keys, scopes, credits, and rate limits.
• API Reference — Collection and proxy endpoint details.
• Provider Dashboard — Manage collections, usage, analytics, and credits.