Authentication

API Key

All API requests require an access key. cURL sends it in the x-access-key header; the official SDKs read POSTPEER_API_KEY automatically or accept the key in the client constructor.

curl -H "x-access-key: YOUR_API_KEY" \
  https://api.postpeer.dev/v1/health/auth

npm install @postpeer/node
export POSTPEER_API_KEY="YOUR_API_KEY"

pip install postpeer
export POSTPEER_API_KEY="YOUR_API_KEY"

You can find your API key in the PostPeer Dashboard.

Verify Your Key

Use the health check endpoint to verify your key is valid:

curl https://api.postpeer.dev/v1/health/auth \
  -H "x-access-key: YOUR_API_KEY"

import PostPeer from '@postpeer/node';

const client = new PostPeer();
const { data } = await client.health.verifyAccessKey();
console.log(data);

from postpeer import PostPeer

with PostPeer() as client:
    result = client.health.verify_access_key()
    print(result)

Response:

{
	"ok": true
}

If the key is invalid, you'll get a 401 or 403 response.

Credits

Each API call that publishes or schedules a post consumes 1 credit.

• Free tier: 20 credits/month
• Paid plans: Starting at $19/month for thousands of credits
• Credit packs: One-time purchases that never expire

Failed posts don't count against your quota.

Rate Limits

Rate limits depend on your plan. We respect each platform's native rate limits and queue posts automatically to avoid throttling.