API Documentation

The AIPaul platform provides a set of RESTful APIs that allow external developers, integrators, and dApps to programmatically interact with prediction markets, retrieve prediction results, and access token staking information.

All APIs are secured via API keys or public access verification, depending on endpoint sensitivity.

---

API Base URL

https://api.aipaul.club/v1

---

Authentication

• Public Endpoints: No authentication required.

• Private Endpoints (e.g., staking records, governance voting history): Require API Key authentication.

Authorization Header Example:

Authorization: Bearer YOUR_API_KEY

---

Available Endpoints

---

1. Retrieve Live Prediction Events

GET /events/live

Returns a list of currently active prediction events.

Request:

GET https://api.aipaul.club/v1/events/live

Response Example:

[
  {
    "eventId": "123456",
    "eventName": "Team A vs Team B",
    "startTime": "2025-05-01T20:00:00Z",
    "status": "open"
  },
  ...
]

---

2. Submit Prediction

POST /predictions/submit

Submit a user's prediction for a given event.

Request Example:

POST https://api.aipaul.club/v1/predictions/submit
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Payload:

{
  "eventId": "123456",
  "predictedOutcome": 0,  // 0: Home Win, 1: Away Win, 2: Draw
  "stakeAmount": 50
}

Response Example:

{
  "success": true,
  "transactionHash": "0xabc123...789"
}

---

3. Fetch Prediction Results

GET /predictions/results/:eventId

Retrieve the official result and settlement status for a completed event.

Request Example:

GET https://api.aipaul.club/v1/predictions/results/123456

Response Example:

{
  "eventId": "123456",
  "outcome": 0,
  "settled": true,
  "rewardClaimable": true
}

---

4. View User Staking Information

GET /staking/user/:walletAddress

Fetch staking records associated with a user's wallet address.

Request Example:

GET https://api.aipaul.club/v1/staking/user/0xYourWalletAddress

Response Example:

{
  "walletAddress": "0xYourWalletAddress",
  "stakedAmount": 1500,
  "rewardsPending": 250
}

---

Error Codes

Code	Meaning	Description
200	OK	Successful request
400	Bad Request	Invalid input parameters
401	Unauthorized	Invalid or missing API key
404	Not Found	Resource does not exist
500	Internal Error	Server error