API Reference
Pinner has two APIs, each with its own Swagger UI for interactive exploration.
IPFS Plugin API
The primary API for IPFS pinning, uploads, websites, DNS, and IPNS. Served at ipfs.pinner.xyz.
The Pinning endpoints (/pins) are compatible with the IPFS Pinning Service API specification.
Meta API
Portal metadata, plugin bundles, and authentication redirect. Served at pinner.xyz.
Authentication
All IPFS API endpoints require a JWT token obtained from the Portal authentication service, passed in the Authorization header:
Authorization: Bearer <your-api-key>
See API Keys for key management.
Using the SDK instead of raw HTTP
The Pinner SDK wraps authentication, retries, progress events, and TUS resumable uploads. For most use cases, the SDK is the recommended way to interact with the API; no need to integrate TUS libraries or manage JWT tokens yourself.
If you need a type-safe client without the SDK, generate one from the OpenAPI spec using tools like Orval or openapi-typescript.