API REFERENCE

Build with Power

Integrate Prime Edge Systems into your trading infrastructure with our RESTful API.

Get API KeyView Endpoints
v1.2.0
API Version
<50ms
Avg Response
99.99%
Uptime
45+
Endpoints
AUTHENTICATION

Secure API Access

All API requests require authentication using Bearer tokens. Generate your API key from the dashboard and include it in the Authorization header.

  • API keys never expire, but can be revoked anytime
  • Support for multiple keys per account
  • Scoped permissions for granular access control
  • Automatic rate limiting per key
Request Example
curl -X GET \
  https://api.primeedgesystems.com/v1/trades \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

Explore available endpoints organized by category. Click on any endpoint for detailed documentation.

GET/v1/trades

List all trades for the authenticated user

POST/v1/trades

Create a new trade entry

GET/v1/trades/{id}

Retrieve a specific trade by ID

PUT/v1/trades/{id}

Update an existing trade

DELETE/v1/trades/{id}

Delete a trade entry

GET/v1/analytics/performance

Get performance analytics summary

GET/v1/analytics/metrics

Retrieve detailed trading metrics

GET/v1/sessions

List recorded user sessions

GET/v1/sessions/{id}/events

Get events for a specific session

POST/v1/webhooks

Create a new webhook endpoint

View complete API reference
RATE LIMITS

Fair Usage Policy

Rate limits ensure fair usage and system stability. Limits vary by subscription tier and are applied per API key.

TierRequestsBurst
Free
100per hour
10/min
Pro
1,000per hour
100/min
Enterprise
10,000per hour
1,000/min
CLIENT LIBRARIES

Official SDKs

Get started quickly with our official client libraries. Fully typed, well-documented, and regularly updated.

JS
JavaScript/TypeScript
View SDK
PY
Python
View SDK
GO
Go
View SDK
RB
Ruby
View SDK
RESPONSE FORMAT

Consistent JSON Responses

All API responses follow a consistent format for easy parsing and error handling.

Success Response
{
  "success": true,
  "data": {
    "trades": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 156
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}
Error Response
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests",
    "details": {
      "retry_after": 60,
      "limit": 100
    }
  },
  "meta": {
    "request_id": "req_xyz789",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Ready to Start Building?

Get your API key and start integrating Prime Edge into your trading workflow today.

Get API KeyRead Documentation