REST API

Pyron Developer API

Build powerful integrations with SeaScope fishery intelligence, CRM data, and authentication services. RESTful, JSON-based, and production-ready.

REST

API Style

JSON

Format

JWT

Auth

TLS 1.3

Security

Base URL

https://api.pyroncompany.com/v1

ℹ️ All API requests must use HTTPS. HTTP requests will be redirected to HTTPS automatically.

🔐 Security

Authentication

Pyron uses Bearer token authentication. Include your API key in the Authorization header of every request.

HTTP Header

Authorization: Bearer YOUR_API_KEY

cURL Example

curl https://api.pyroncompany.com/v1/auth/me \
  -H "Authorization: Bearer pk_live_abc123..."

JavaScript

const response = await fetch('https://api.pyroncompany.com/v1/auth/me', {
  headers: {
    'Authorization': 'Bearer pk_live_abc123...',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

⚠️ Never expose your API key in client-side code. Use environment variables and server-side requests for production.

⏱ Limits

Rate Limits

Rate limits are applied per API key. Exceeding limits returns a 429 Too Many Requests response.

General endpointsFree100 req/min

General endpointsPro1,000 req/min

General endpointsEnterpriseUnlimited

SeaScope fishery dataPro500 req/min

Export endpointsPro50 req/min

Rate Limit Headers

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 847
X-RateLimit-Reset: 1714123456

❌ Errors

Error Handling

All errors return a consistent JSON structure with a machine-readable code and human-readable message.

Error Response

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key",
    "status": 401,
    "timestamp": "2025-04-26T12:00:00Z"
  }
}

200

OK — Request succeeded

201

Created — Resource created

400

Bad Request — Invalid params

401

Unauthorized — Bad API key

403

Forbidden — No permission

404

Not Found — Resource missing

429

Too Many Requests

500

Server Error — Try again