Profile

GET /user/profile

Retrieve the authenticated user's profile, including current plan and storage usage.

Example request

curl https://api.ipfs.ninja/user/profile \
  -H "X-Api-Key: bws_your_api_key_here"

Response 200 OK

{
  "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "user@example.com",
  "name": "Jane Developer",
  "plan": "nirvana",
  "storageUsedMB": 12.5,
  "fileCount": 37,
  "gatewaySlug": "a1b2c3d4",
  "gatewayUrl": "https://a1b2c3d4.gw.ipfs.ninja",
  "gatewayTokenRequired": false,
  "gatewayAllowedOrigins": ["https://myapp.com"],
  "gatewayBandwidthUsedMB": 1200,
  "gatewayIpWhitelist": ["203.0.113.1"],
  "createdAt": 1704067200000,
  "planSource": null,
  "planExpiresAt": null
}

TIP

gatewayUrl is null for Dharma and Bodhi plans. Upgrade to Nirvana to activate your dedicated gateway.

TIP

planSource and planExpiresAt are non-null when your plan comes from a manually-granted upgrade rather than an active subscription — e.g. "planSource": "manual_grant" with planExpiresAt set to the grant's expiry timestamp. Both are null for a normal paid or free-tier plan.