Get Started

Authentication

Open by default — keys only when you want more headroom.

Pluid is read-only and read-public. The FREE tier requires no account, no login, and no key. API keys exist purely to raise your rate limits and attribute usage — they never unlock write access, because Pluid never exposes writes.

The FREE Tier (No Login)

Send a request to any /api/v1 route with no credentials. You are identified by IP and rate-limited accordingly. This is the fastest way to prototype.

bash
curl https://pluid.net/api/v1/slot
Genuinely free
No card, no email, no key. The FREE tier is meant for real prototyping, not a trial. Add a key only when your traffic outgrows the per-IP window.

Using an API Key

Pass your key in the x-api-key header. When present, rate limiting is scoped to the key rather than your IP — useful behind shared egress or serverless functions.

bash
curl https://pluid.net/api/v1/balance/5tzFkiKscXHK5ZXCGbXZxdw7gTjjD1mBwuoFbhUvuAi9 \
  -H "x-api-key: pluid_live_xxxxxxxxxxxxxxxxxxxx"
client.tsts
import { PluidClient } from "@pluid/sdk";

const pluid = new PluidClient({ apiKey: process.env.PLUID_API_KEY });
Keep keys server-side
Treat API keys as secrets. Read them from process.env on a server and never ship them in client bundles. For browser apps, proxy reads through your own backend.

The Tier Ladder

Higher tiers raise your request ceiling and burst window. $PLUID holders unlock elevated limits without a subscription — see $PLUID Token.

TierTypeDescription
Freeno keyPer-IP limiter. Full route + receipt access. Best for prototyping.
Buildx-api-keyPer-key limiter with a higher sustained rate and per-key usage analytics.
Scalex-api-keyProduction throughput, larger burst window, priority mesh routing.
Staked$PLUIDLimits scale with held $PLUID — no monthly plan required.

Identifying Your Requests

Every response carries rate-limit headers so you can self-throttle. They reflect whichever identity applied to the request — key if present, otherwise IP.

HeaderTypeDescription
X-RateLimit-LimitintRequests allowed in the current window.
X-RateLimit-RemainingintRequests left in the current window.
X-RateLimit-Resetepoch sWhen the window resets.