Public API Reference

The PolyOrbit API allows developers to programmatically access data regarding their chains, positions, and market statuses. This API is RESTful and uses standard HTTP response codes.

Base URL

All requests should be prefixed with the following base URL. https://api.polyorbit.com/v1

Authentication

To access private user data, you must authenticate your requests using an API Key.

1. Generate an API Key from the Settings menu in the dashboard.

2. Include the key in the Authorization header of every request.

Header Format: Authorization: Bearer <YOUR_API_KEY>

Rate Limits

To maintain system stability, the API is rate-limited.

• Standard Plan: 60 requests per minute.

• Pro Plan: 300 requests per minute.

• Exceeding this limit will result in a 429 Too Many Requests response.

Endpoints

1. List Active Chains

Retrieve a list of all currently running automation chains for the authenticated user.

• Method: GET

• Endpoint: /chains

• Parameters:

  • status (optional): Filter by waiting, executing, or failed.

Response Example:

JSON

{
  "chains": [
    {
      "id": "ch_101",
      "status": "waiting",
      "source_id": "0xabc...",
      "target_id": "0xdef...",
      "created_at": "2025-12-17T12:00:00Z"
    }
  ]
}

2. Get Chain Details

Retrieve detailed logs and configuration for a specific chain.

• Method: GET

• Endpoint: /chains/{chain_id}

3. Market Lookup

Search for available markets on Polymarket to use in your chains. This endpoint acts as a cached proxy for the Polymarket CLOB API to reduce latency.

• Method: GET

• Endpoint: /markets/search

• Parameters:

  • query: The search keyword (e.g., "election").

  • sort: Sort by volume or liquidity.

4. Account Summary

Get a snapshot of the user's balances and session key status.

• Method: GET

• Endpoint: /account

Response Example:

JSON

{
  "wallet_address": "0x123...",
  "usdc_balance": 5000.00,
  "session_active": true,
  "session_expiry": "2025-12-17T23:59:59Z"
}

Error Handling

The API uses standard HTTP codes to indicate success or failure.

• 200 OK: Request succeeded.

• 400 Bad Request: Invalid parameters provided.

• 401 Unauthorized: Invalid or missing API Key.

• 404 Not Found: Resource does not exist.

• 500 Server Error: Internal system issue.