Predict API

https://dev.predict.fun/llms.txt
Admin
The Predict API provides an interface for authenticating users, managing accounts, creating and...
Tokens:188,792
Snippets:966
Trust Score:7.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install SDK with yarn

Source: https://dev.predict.fun/how-to-create-or-cancel-orders-679306m0

Install the @predictdotfun/sdk package and ethers v6 peer dependency using yarn.

```bash
yarn add @predictdotfun/sdk ethers
```

--------------------------------

### Install SDK with npm

Source: https://dev.predict.fun/how-to-create-or-cancel-orders-679306m0

Install the @predictdotfun/sdk package and ethers v6 peer dependency using npm.

```bash
npm install @predictdotfun/sdk ethers
```

--------------------------------

### Get orders

Source: https://dev.predict.fun/llms.txt

Get a list of your own orders.

```APIDOC
## GET /get-orders

### Description
Get a list of your own orders.

### Method
GET

### Endpoint
/get-orders
```

--------------------------------

### Create and sign a LIMIT order with OrderBuilder

Source: https://dev.predict.fun/how-to-create-or-cancel-orders-679306m0

Use this TypeScript snippet to create and sign a LIMIT strategy buy order. It initializes the OrderBuilder once per signer, sets approvals, calculates order amounts via getLimitOrderAmounts, builds the order, generates typed data, signs it, and computes the order hash. The example uses BNB Mainnet and requires a wallet private key. Note that feeRateBps should be fetched from the GET /markets endpoint, and isNegRisk and isYieldBearing can be fetched via the API.

```TypeScript
import { Wallet } from "ethers";
import { OrderBuilder, ChainId, Side } from "@predictdotfun/sdk";

// Create a wallet for signing orders
const signer = new Wallet(process.env.WALLET_PRIVATE_KEY);

// The main function which initiates the OrderBuilder (only once per signer) and then provides it as dependency to other util functions
async function main() {
  // Create a new instance of the OrderBuilder class. Note: This should only be done once per signer
  const orderBuilder = await OrderBuilder.make(ChainId.BnbMainnet, signer);

  // Call an helper function to create the order and provide the OrderBuilder instance
  await createOrder(orderBuilder);
}

async function createOrder(orderBuilder: OrderBuilder) {
  /**
   * NOTE: You can also call `setApprovals` once per wallet.
   */

  // Set all the approval needed within the protocol (if needed)
  const result = await orderBuilder.setApprovals();

  // Check if the approvals were set successfully
  if (!result.success) {
    throw new Error("Failed to set approvals.");
  }

  // Simple helper function to calculate the amounts for a `LIMIT` order
  const { lastPrice, pricePerShare, makerAmount, takerAmount } = orderBuilder.getLimitOrderAmounts({
    side: Side.BUY,
    pricePerShareWei: 400000000000000000n, // 0.4 USDT (in wei)
    quantityWei: 10000000000000000000n, // 10 shares (in wei)
  });

  // Build a limit order (if you are using a Predict account replace `signer.address` with your deposit address)
  const order = orderBuilder.buildOrder("LIMIT", {
    maker: signer.address,
    signer: signer.address,
    side: Side.BUY, // Equivalent to 0
    tokenId: "OUTCOME_ON_CHAIN_ID", // This can be fetched via the API or on-chain
    makerAmount, // 0.4 USDT * 10 shares (in wei)
    takerAmount, // 10 shares (in wei)
    nonce: 0n,
    feeRateBps: 0, // Should be fetched via the `GET /markets` endpoint
  });

  // Build typed data for the order (isNegRisk and isYieldBearing can be fetched via the API)
  const typedData = orderBuilder.buildTypedData(order, { isNegRisk: true, isYieldBearing: true });

  // Sign the order by providing the typedData of the order
  const signedOrder = await orderBuilder.signTypedDataOrder(typedData);

  // Compute the order's hash
  const hash = orderBuilder.buildTypedDataHash(typedData);

  // Example structure required to create an order via Predict's API
  const createOrderBody = {
    data: {
      order: { ...signedOrder, hash },
      pricePerShare,
      strategy: "LIMIT",
    },
  };
}
```

--------------------------------

### Get positions

Source: https://dev.predict.fun/llms.txt

Get data about your positions.

```APIDOC
## GET /get-positions

### Description
Get data about your positions.

### Method
GET

### Endpoint
/get-positions
```

--------------------------------

### Get categories

Source: https://dev.predict.fun/llms.txt

Get categories.

```APIDOC
## GET /get-categories

### Description
Get categories.

### Method
GET

### Endpoint
/get-categories
```

--------------------------------

### Unsubscribe example

Source: https://dev.predict.fun/request-format-1915501m0

Example of an unsubscribe request. Unsubscribing always acknowledges successfully, whether or not the subscription existed.

```json
{ "method": "unsubscribe", "requestId": 2, "params": ["predictMarketStatus/123"] }
```

--------------------------------

### Subscribe example

Source: https://dev.predict.fun/request-format-1915501m0

Example of a subscribe request. The server replies with a response message (type: "R") carrying the same requestId. For snapshot-backed topics, a snapshot message (type: "M") is also pushed immediately, followed by live updates. Subscribing again to a topic you already hold is a no-op that simply re-acknowledges.

```json
{ "method": "subscribe", "requestId": 1, "params": ["predictMarketStatus/123"] }
```

--------------------------------

### Get positions by address

Source: https://dev.predict.fun/llms.txt

Get positions for a specific wallet address.

```APIDOC
## GET /get-positions-by-address

### Description
Get positions for a specific wallet address.

### Method
GET

### Endpoint
/get-positions-by-address
```

--------------------------------

### GET /v1/leaderboard

Source: https://dev.predict.fun/leaderboardresponse-16921719d0

Documentation for the GET /v1/leaderboard endpoint, which returns the global points leaderboard. Includes the response schema for LeaderboardResponse and LeaderboardEntry.

```APIDOC
## GET /v1/leaderboard

### Description
Retrieves the global points leaderboard. The response contains a list of leaderboard entries, each with rank, total points, name, address, and optionally an image URL.

### Method
GET

### Endpoint
/v1/leaderboard

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Pagination cursor for retrieving the next page of results.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates whether the request was successful.
- **cursor** (string) - Pagination cursor for the next page, if available.
- **data** (array of LeaderboardEntry) - List of leaderboard entries.

#### LeaderboardEntry Object
- **rank** (integer) - Required - First-to-last rank on the global leaderboard. Rank 1 has the highest cumulative points.
- **totalPoints** (number) - Required - Cumulative all-time points balance for this account.
- **name** (string) - Required - Display name of the account, empty string if unset.
- **address** (string) - Required - The account's wallet address.
- **imageUrl** (string) - Optional - Profile image URL, only present when the account's image is public.

#### Response Example
```json
{
  "success": true,
  "cursor": "string",
  "data": [
    {
      "rank": 1,
      "totalPoints": 1234.56,
      "name": "Alice",
      "address": "0x123...",
      "imageUrl": "https://example.com/image.png"
    }
  ]
}
```
```

--------------------------------

### Get all tags

Source: https://dev.predict.fun/llms.txt

Get all tags that have at least one visible category.

```APIDOC
## GET /get-all-tags

### Description
Get all tags that have at least one visible category.

### Method
GET

### Endpoint
/get-all-tags
```

--------------------------------

### Example API Response for Order Book

Source: https://dev.predict.fun/understanding-the-orderbook-685654m0

Example API response showing the order book structure for a market. The `asks` array lists sell prices for the Yes side (best/lowest first), and `bids` lists buy prices (best/highest first). Each entry is a `[price, quantity]` pair.

```json
{
  "success": true,
  "data": {
    "marketId": 1,
    "updateTimestampMs": 1727910141000,
    "asks": [
      [0.492, 30192.26],
      [0.493, 20003]
    ],
    "bids": [
      [0.491, 303518.1],
      [0.49, 1365.44]
    ]
  }
}
```

--------------------------------

### Heartbeat example

Source: https://dev.predict.fun/request-format-1915501m0

Example of a heartbeat answer. Echo the exact timestamp received from the server's heartbeat. The heartbeat request has no requestId or params.

```json
{ "method": "heartbeat", "data": 1736696400000 }
```

--------------------------------

### Get category by slug

Source: https://dev.predict.fun/llms.txt

Get category information and its markets by slug.

```APIDOC
## GET /get-category-by-slug

### Description
Get category information and its markets by slug.

### Method
GET

### Endpoint
/get-category-by-slug
```

--------------------------------

### Get account activity

Source: https://dev.predict.fun/llms.txt

Get a paginated list of trading activity including orders, matches.

```APIDOC
## GET /get-account-activity

### Description
Get a paginated list of trading activity including orders, matches.

### Method
GET

### Endpoint
/get-account-activity
```

--------------------------------

### OpenAPI YAML specification for GET /v1/categories/{slug}

Source: https://dev.predict.fun/get-category-by-slug-25326911e0

Defines the GET /v1/categories/{slug} endpoint with path parameter slug, response schema CategoryResponse, and security using apiKey. Includes CategoryResponse and CategoryWithStats schemas with required fields and descriptions.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/categories/{slug}:
    get:
      summary: Get category by slug
      deprecated: false
      description: Get category information and its markets by slug
      operationId: getCategory
      tags:
        - Categories
        - Categories
      parameters:
        - name: slug
          in: path
          description: a string
          required: true
          example: ''
          schema:
            type: string
            description: a string
      responses:
        '200':
          description: Response 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryResponse'
          headers: {}
          x-apidog-name: ''
      security:
        - apiKey: []
          x-apidog:
            schemeGroups:
              - id: lgUrffrr00N24uTfQqXpy
                schemeIds:
                  - apiKey
            required: true
            use:
              id: lgUrffrr00N24uTfQqXpy
            scopes:
              lgUrffrr00N24uTfQqXpy:
                apiKey: []
      x-apidog-folder: Categories
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/640313/apis/api-25326911-run
components:
  schemas:
    CategoryResponse:
      type: object
      title: CategoryResponse
      description: Response for GET /v1/categories/:slug
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/CategoryWithStats'
      x-apidog-orders:
        - success
        - data
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    CategoryWithStats:
      type: object
      title: CategoryWithStats
      description: Category data with optional inline statistics.
      required:
        - id
        - slug
        - title
        - description
        - imageUrl
        - isNegRisk
        - isYieldBearing
        - marketVariant
        - createdAt
        - publishedAt
        - markets
        - startsAt
        - status
        - isVisible
        - resolutionProvider
        - tags
      properties:
        id:
          type: integer
          format: int64
        slug:
          type: string
        title:
          type: string
        shortTitle:
          type: string
          description: >-
            Short, human-readable label, e.g. `"BTC Up or Down 15m"`. `null`
            when not available.
        description:
          type: string
        imageUrl:
          type: string
        isNegRisk:
          type: boolean
        isYieldBearing:
          type: boolean
        negRiskOnChainId:
          type: string
          description: On-chain NegRisk market ID as a 32-byte hex string.
        marketVariant:
          type: object
          properties: {}
          x-apidog-orders: []
          x-apidog-ignore-properties: []
        variantData:
          description: |-
            Deprecated in favour of `variantDetails`, which says the same thing
            without a type of its own.
          deprecated: true
          allOf:
            - type: object
              properties: {}
              x-apidog-orders: []
              x-apidog-ignore-properties: []
            - type: string
        variantDetails:
          description: What this category is about, replacing `variantData`.
          allOf:
            - $ref: '#/components/schemas/CategoryVariantDetails'
            - type: string
        createdAt:
          type: string
        publishedAt:
          type: string
        markets:
          type: array
          items:
            type: object
            properties: {}
            x-apidog-orders: []
            x-apidog-ignore-properties: []
        startsAt:
          type: string
        endsAt:
          type: string
        status:
          $ref: '#/components/schemas/CategoryStatus'
        isVisible:
          type: boolean
        resolutionProvider:
          type: object
          properties: {}
          x-apidog-orders: []
          x-apidog-ignore-properties: []
        tags:
          type: array
          items:
            type: object
            properties: {}
            x-apidog-orders: []
            x-apidog-ignore-properties: []
        teams:
          type: array
          description: >-
            Deprecated in favour of category-level `variantData`. Teams playing
            in this sports event,
```

--------------------------------

### GET /v1/orders/:hash

Source: https://dev.predict.fun/orderresponse-14037507d0

Documentation for the GET /v1/orders/:hash endpoint, which retrieves order data for a given order hash.

```APIDOC
## GET /v1/orders/:hash

### Description
Retrieves order data for a given order hash. The response includes the order details, market information, and execution status.

### Method
GET

### Endpoint
/v1/orders/:hash

### Parameters
#### Path Parameters
- **hash** (string) - Required - The order hash (max length 66).

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Order data as returned by the API.
  - **order** (object) - Contract order data (the signed order).
    - **hash** (string) - Order hash (max length 66).
    - **salt** (string) - Salt value.
    - **maker** (string) - Maker address.
    - **signer** (string) - Signer address.
    - **taker** (string) - Taker address.
    - **tokenId** (string) - Token ID.
    - **makerAmount** (string) - Maker amount.
    - **takerAmount** (string) - Taker amount.
    - **expiration** (integer) - Unix timestamp in seconds.
    - **nonce** (string) - Nonce value.
    - **feeRateBps** (string) - Fee rate in basis points.
    - **side** (integer) - Order side.
    - **signatureType** (integer) - Signature type.
    - **signature** (string) - Signature (max length 200).
  - **id** (string) - Order ID.
  - **marketId** (integer) - Market ID.
  - **currency** (string) - Currency.
  - **amount** (string) - Order amount.
  - **amountFilled** (string) - Filled amount.
  - **isNegRisk** (boolean) - Whether the order is negative risk.
  - **isYieldBearing** (boolean) - Whether the order is yield bearing.
  - **strategy** (string) - Order execution strategy (MARKET or LIMIT).
  - **status** (string) - Order status (OPEN, FILLED, EXPIRED, CANCELLED, INVALIDATED).
  - **rewardEarningRate** (integer) - Reward earning rate.

#### Response Example
```json
{
  "success": true,
  "data": {
    "order": {
      "hash": "0x...",
      "salt": "0",
      "maker": "0x...",
      "signer": "0x...",
      "taker": "0x...",
      "tokenId": "0",
      "makerAmount": "100",
      "takerAmount": "100",
      "expiration": 1700000000,
      "nonce": "0",
      "feeRateBps": "0",
      "side": 0,
      "signatureType": 0,
      "signature": "0x..."
    },
    "id": "order-id",
    "marketId": 1,
    "currency": "USDC",
    "amount": "100",
    "amountFilled": "50",
    "isNegRisk": false,
    "isYieldBearing": false,
    "strategy": "LIMIT",
    "status": "OPEN",
    "rewardEarningRate": 0
  }
}
```
```

--------------------------------

### OpenAPI specification for Get order match events

Source: https://dev.predict.fun/get-order-match-events-25663812e0

Defines the GET /v1/orders/matches endpoint. Supports query parameters for pagination (first, after) and filtering (marketId, minValueUsdtWei, signerAddress, isSignerMaker). Results are sorted by executedAt DESC. The response includes a success flag, a cursor for pagination, and an array of match data with market details.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/orders/matches:
    get:
      summary: Get order match events
      deprecated: false
      description: >-
        Get a paginated list of order match events with optional filtering by
        category, market, minimum value and signer. The results are sorted by
        `executedAt DESC`.
      operationId: getMatches
      tags:
        - Orders
        - Orders
      parameters:
        - name: first
          in: query
          description: ''
          required: false
          schema:
            type: string
            description: a string to be decoded into a number
        - name: after
          in: query
          description: a string
          required: false
          schema:
            type: string
            description: a string
        - name: marketId
          in: query
          description: ''
          required: false
          schema:
            type: string
            description: a string
        - name: minValueUsdtWei
          in: query
          description: ''
          required: false
          schema:
            type: string
            description: a string
        - name: signerAddress
          in: query
          description: a string
          required: false
          schema:
            type: string
            description: a string
        - name: isSignerMaker
          in: query
          description: >-
            Filter for matches where the signer is the maker if true, taker if
            false, undefined to lookup both
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: >-
              Filter for matches where the signer is the maker if true, taker if
              false, undefined to lookup both
      responses:
        '200':
          description: Response 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: a boolean
                  cursor:
                    type: string
                    description: a string
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        market:
                          type: object
                          properties:
                            id:
                              type: number
                              description: a number
                            imageUrl:
                              type: string
                              description: a non empty string
                              minLength: 1
                            title:
                              type: string
                              description: a non empty string
                              minLength: 1
                            question:
                              type: string
                              description: a non empty string
                              minLength: 1
                            description:
                              type: string
                              description: a non empty string
                              minLength: 1
                            tradingStatus:
                              type: string
                              enum:
                                - OPEN
                                - MATCHING_NOT_ENABLED
                                - CANCEL_ONLY
                                - CLOSED
                            status:
                              type: string
                              enum:
                                - REGISTERED
                                - PRICE_PROPOSED
                                - PRICE_DISPUTED
                                - PAUSED
                                - UNPAUSED
                                - RESOLVED
                                - REMOVED
                            isVisible:
                              type: boolean
                              description: a boolean
                            isNegRisk:
                              type: boolean
                              description: a boolean
                            isYieldBearing:
                              type: boolean
                              description: a boolean
                            feeRateBps:
                              type: number
                              description: a number
                            resolution:
                              type: object
                              properties:
                                name:
                                  type: string
```

--------------------------------

### GET /v1/orders/matches

Source: https://dev.predict.fun/get-order-match-events-25663812e0

API documentation for the GET /v1/orders/matches endpoint, which retrieves a paginated list of order match events with optional filters.

```APIDOC
## GET /v1/orders/matches

### Description
Get a paginated list of order match events with optional filtering by category, market, minimum value and signer. The results are sorted by `executedAt DESC`.

### Method
GET

### Endpoint
/v1/orders/matches

### Parameters
#### Query Parameters
- **first** (string) - Optional - a string to be decoded into a number
- **after** (string) - Optional - a string
- **marketId** (string) - Optional - a string
- **minValueUsdtWei** (string) - Optional - a string
- **signerAddress** (string) - Optional - a string
- **isSignerMaker** (string) - Optional - Filter for matches where the signer is the maker if true, taker if false, undefined to lookup both. Enum: `true`, `false`

### Response
#### Success Response (200)
- **success** (boolean) - a boolean
- **cursor** (string, nullable) - a string
- **data** (array) - an array of objects
  - **market** (object) - market details
    - **id** (number) - a number
    - **imageUrl** (string) - a non empty string
    - **title** (string) - a non empty string
    - **question** (string) - a non empty string
    - **description** (string) - a non empty string
    - **tradingStatus** (string) - enum: OPEN, MATCHING_NOT_ENABLED, CANCEL_ONLY, CLOSED
    - **status** (string) - enum: REGISTERED, PRICE_PROPOSED, PRICE_DISPUTED, PAUSED, UNPAUSED, RESOLVED, REMOVED
    - **isVisible** (boolean) - a boolean
    - **isNegRisk** (boolean) - a boolean
    - **isYieldBearing** (boolean) - a boolean
    - **feeRateBps** (number) - a number
    - **resolution** (object) - resolution details
      - **name** (string) - a string
```

--------------------------------

### OpenAPI Specification for Get order by hash

Source: https://dev.predict.fun/get-order-by-hash-25326901e0

YAML OpenAPI 3.0.1 specification defining the GET /v1/orders/{hash} endpoint. It describes the path parameter 'hash' and the response schema with order properties including maker, taker, amounts, expiration, and signature.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/orders/{hash}:
    get:
      summary: Get order by hash
      deprecated: false
      description: Get the order information for one of your own orders by its hash
      operationId: getOrder
      tags:
        - Orders
        - Orders
      parameters:
        - name: hash
          in: path
          description: a string
          required: true
          example: ''
          schema:
            type: string
            description: a string
      responses:
        '200':
          description: Response 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: a boolean
                  data:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          hash:
                            type: string
                            description: >-
                              An optional string hash for the order, if
                              provided, it must match the hash of the order
                            minLength: 1
                          salt:
                            type: string
                            description: >-
                              A positive i64 bigint string representing the
                              salt, max value is 2^63-1
                            pattern: ^[0-9]+$
                          maker:
                            type: string
                            description: a string
                          signer:
                            type: string
                            description: a string
                          taker:
                            type: string
                            description: a string
                          tokenId:
                            type: string
                            description: >-
                              An integer string for the ERC-1155 outcome's token
                              ID
                            pattern: ^[0-9]+$
                          makerAmount:
                            type: string
                            description: >-
                              An integer string representing the maker amount in
                              wei
                            pattern: ^[0-9]+$
                          takerAmount:
                            type: string
                            description: >-
                              An integer string representing the taker amount in
                              wei
                            pattern: ^[0-9]+$
                          expiration:
                            oneOf:
                              - type: string
                                description: a string matching the pattern ^[0-9]+$
                                pattern: ^[0-9]+$
                              - type: integer
                                description: an integer
                            description: A unix timestamp in seconds, must be in the future
                          nonce:
                            type: string
                            description: >-
                              An i32 positive integer string for the nonce to be
                              used for on-chain cancellations, max value is
                              2^31-1
                            pattern: ^[0-9]+$
                          feeRateBps:
                            type: string
                            description: An integer string for the fee in basis point
                            pattern: ^[0-9]+$
                          side:
                            oneOf:
                              - type: number
                                enum:
                                  - 0
                              - type: number
                                enum:
                                  - 1
                          signatureType:
                            type: number
                            enum:
                              - 0
                            description: The signature type, only 0 is supported
                          signature:
                            type: string
                            description: a string
                        required:
                          - salt
                          - maker
                          - signer
                          - taker
                          - tokenId
                          - makerAmount
                          - takerAmount
                          - expiration
```

--------------------------------

### OpenAPI specification for GET /positions

Source: https://dev.predict.fun/get-positions-43539045e0

OpenAPI 3.0.1 specification for the GET /positions endpoint. Requires JWT authentication. Supports query parameters for pagination (first, after), filtering (marketId, categoryId, isResolved, includeLost), and sorting (sort). The includeLost parameter is off by default. Returns a PositionsResponse on success, with documented error responses for 400, 401, 403, 404, 410, 429, 500, 502, and 503.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /positions:
    get:
      summary: Get positions
      deprecated: false
      description: |-
        Get data about your positions.
        Requires JWT authentication.
      tags:
        - Positions
        - Positions
      parameters:
        - name: first
          in: query
          description: ''
          required: false
          example: 0
          schema:
            type: integer
            format: int32
        - name: after
          in: query
          description: ''
          required: false
          example: ''
          schema:
            type: string
            maxLength: 1024
        - name: marketId
          in: query
          description: ''
          required: false
          example: 0
          schema:
            type: integer
            format: int64
        - name: categoryId
          in: query
          description: ''
          required: false
          example: ''
          schema:
            type: string
            maxLength: 256
        - name: isResolved
          in: query
          description: ''
          required: false
          example: ''
          schema:
            type: boolean
        - name: includeLost
          in: query
          description: |-
            Also list positions in outcomes that settled as losing. Off by
            default, since those need no action from the holder.
          required: false
          example: ''
          schema:
            type: boolean
        - name: sort
          in: query
          description: ''
          required: false
          example: ''
          schema:
            $ref: '#/components/schemas/PositionSort'
      responses:
        '200':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/PositionsResponse'
          headers: {}
          x-apidog-name: ''
        '400':
          description: Bad request (400) - Invalid input or parameters
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized (401) - Missing or invalid authentication
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '403':
          description: Forbidden (403) - Valid auth but insufficient permissions
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '404':
          description: Not found (404) - Resource doesn't exist
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '410':
          description: Gone (410) - Resource has been permanently removed
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '429':
          description: Too many requests (429) - Rate limit exceeded
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '500':
          description: Internal server error (500) - Unexpected error
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '502':
          description: Bad gateway (502) - Upstream API error
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '503':
          description: Service unavailable (503) - Server is temporarily unable to handle the request
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
```

--------------------------------

### OpenAPI Specification for GET /v1/account

Source: https://dev.predict.fun/get-connected-account-25326917e0

Defines the GET /v1/account endpoint that returns account information including name, address, imageUrl, referral, and points. Requires JWT authentication via the jwtAuth security scheme. Two servers are available: testnet (https://api-testnet.predict.fun) and prod (https://api.predict.fun).

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/account:
    get:
      summary: Get connected account
      deprecated: false
      description: Get information for the connected user account
      operationId: getConnectedAccount
      tags:
        - Accounts
        - Accounts
      parameters: []
      responses:
        '200':
          description: Response 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: a boolean
                  data:
                    type: object
                    properties:
                      name:
                        type: string
                        description: a string
                      address:
                        type: string
                        description: a string
                      imageUrl:
                        type: string
                        description: a string
                        nullable: true
                      referral:
                        type: object
                        properties:
                          code:
                            type: string
                            description: a string
                            nullable: true
                          status:
                            type: string
                            enum:
                              - LOCKED
                              - UNLOCKED
                        required:
                          - code
                          - status
                        x-apidog-orders:
                          - code
                          - status
                      points:
                        type: object
                        properties:
                          total:
                            type: number
                            description: a number
                        required:
                          - total
                        x-apidog-orders:
                          - total
                    required:
                      - name
                      - address
                      - imageUrl
                      - referral
                      - points
                    x-apidog-orders:
                      - name
                      - address
                      - imageUrl
                      - referral
                      - points
                required:
                  - success
                  - data
                x-apidog-orders:
                  - success
                  - data
          headers: {}
          x-apidog-name: ''
      security:
        - jwtAuth (prod): []
          x-apidog:
            schemeGroups:
              - id: P9HBuvVZRxA4ME0xKyrGx
                schemeIds:
                  - jwtAuth (prod)
              - id: AnF_kiY980I638e7iCrfI
                schemeIds:
                  - jwtAuth (testnet)
            required: true
            use:
              id: P9HBuvVZRxA4ME0xKyrGx
            scopes:
              zFvpMtev7lnq_-lnYs9-e:
                jwtAuth: []
      x-apidog-folder: Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/640313/apis/api-25326917-run
components:
  schemas: {}
  securitySchemes:
    apiKey:
      name: x-api-key
      type: apikey
      in: header
      description: >-
        Api Key Authentication. Used to Obtain JSON Web Token for Bearer
        Authentication
    jwtAuth:
      type: jwt
      scheme: bearer
      bearerFormat: JWT
    OAuth:
      type: bearer
      description: Bearer OAuth Authentication
      scheme: bearer
    jwtAuth (prod):
      group:
        - id: 438142
        - id: 438143
      type: combination
    ApiKeyAuth:
      type: apikey
      description: API key authentication via the `x-api-key` header.
      name: x-api-key
      in: header
    BearerAuth:
      type: jwt
      description: 'Bearer authentication via the `Authorization: Bearer <token>` header.'
      scheme: bearer
      bearerFormat: JWT
    jwtAuth (testnet):
      type: bearer
      scheme: bearer
servers:
  - url: https://api-testnet.predict.fun
    description: Testing Env
  - url: https://api.predict.fun
    description: Prod Env
security: []

```

--------------------------------

### GET /v1/account/activity

Source: https://dev.predict.fun/activityresponse-14037452d0

Retrieves account activity events. The response includes a success flag, an optional cursor for pagination, and an array of activity events.

```APIDOC
## GET /v1/account/activity

### Description
Retrieves account activity events for the authenticated user.

### Method
GET

### Endpoint
/v1/account/activity

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **cursor** (string) - Pagination cursor for next page of results
- **data** (array of ActivityEvent) - List of activity events

#### Response Example
{
  "success": true,
  "cursor": "string",
  "data": [
    {
      "name": "CREATE",
      "createdAt": "string",
      "transactionHash": "string",
      "amountFilled": "string",
      "priceExecuted": "string",
      "order": {
        "quoteType": "string",
        "amount": "string",
        "price": "string",
        "fee": "string"
      },
      "market": {},
      "outcome": "string"
    }
  ]
}
```

--------------------------------

### OpenAPI spec for GET /positions/{address}

Source: https://dev.predict.fun/get-positions-by-address-43539046e0

OpenAPI 3.0.1 specification for the GET /positions/{address} endpoint. It defines the path parameter address, optional query parameters (first, after, marketId, categoryId, isResolved, includeLost, sort), and response schemas for 200, 400, 401, 403, 404, 410, 429, 500, and 502. The includeLost parameter is off by default.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /positions/{address}:
    get:
      summary: Get positions by address
      deprecated: false
      description: Get positions for a specific wallet address.
      tags:
        - Positions
        - Positions
      parameters:
        - name: address
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: first
          in: query
          description: ''
          required: false
          example: 0
          schema:
            type: integer
            format: int32
        - name: after
          in: query
          description: ''
          required: false
          example: ''
          schema:
            type: string
            maxLength: 1024
        - name: marketId
          in: query
          description: ''
          required: false
          example: 0
          schema:
            type: integer
            format: int64
        - name: categoryId
          in: query
          description: ''
          required: false
          example: ''
          schema:
            type: string
            maxLength: 256
        - name: isResolved
          in: query
          description: ''
          required: false
          example: ''
          schema:
            type: boolean
        - name: includeLost
          in: query
          description: |-
            Also list positions in outcomes that settled as losing. Off by
            default, since those need no action from the holder.
          required: false
          example: ''
          schema:
            type: boolean
        - name: sort
          in: query
          description: ''
          required: false
          example: ''
          schema:
            $ref: '#/components/schemas/PositionSort'
      responses:
        '200':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/PositionsResponse'
          headers: {}
          x-apidog-name: ''
        '400':
          description: Bad request (400) - Invalid input or parameters
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized (401) - Missing or invalid authentication
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '403':
          description: Forbidden (403) - Valid auth but insufficient permissions
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '404':
          description: Not found (404) - Resource doesn't exist
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '410':
          description: Gone (410) - Resource has been permanently removed
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '429':
          description: Too many requests (429) - Rate limit exceeded
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '500':
          description: Internal server error (500) - Unexpected error
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
        '502':
          description: Bad gateway (502) - Upstream API error
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: ''
```

--------------------------------

### Get the orders for a OAuth connection

Source: https://dev.predict.fun/llms.txt

This endpoint is not available for general use.

```APIDOC
## GET /get-the-orders-for-a-oauth-connection

### Description
This endpoint is not available for general use.

### Method
GET

### Endpoint
/get-the-orders-for-a-oauth-connection
```

--------------------------------

### GET /v1/account/activity

Source: https://dev.predict.fun/get-account-activity-32534697e0

Retrieves a paginated list of trading activity including orders, matches, conversions, merges, and splits for the authenticated user. Requires JWT authentication.

```APIDOC
## GET /v1/account/activity

### Description
Get a paginated list of trading activity including orders, matches, conversions, merges, and splits for the authenticated user. Requires JWT authentication.

### Method
GET

### Endpoint
/v1/account/activity

### Parameters
#### Query Parameters
- **first** (integer) - Optional - Number of items to return
- **after** (string) - Optional - Cursor for pagination
- **eventTypes** (array) - Optional - Filter by event types (comma-separated or repeated)

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **cursor** (string) - Cursor for pagination
- **data** (array) - List of activity events

#### Response Example
{
  "success": true,
  "cursor": "string",
  "data": []
}

#### Error Responses
- **400** - Bad request (400) - Invalid input or parameters
- **401** - Unauthorized (401) - Missing or invalid authentication
- **403** - Forbidden (403) - Valid auth but insufficient permissions
- **404** - Not found (404) - Resource doesn't exist
- **410** - Gone (410) - Resource has been permanently removed
- **429** - Too many requests (429) - Rate limit exceeded
- **500** - Internal server error (500) - Unexpected error
- **502** - Bad gateway (502) - Upstream API error
```

--------------------------------

### Get markets

Source: https://dev.predict.fun/llms.txt

Get information about markets.

```APIDOC
## GET /get-markets

### Description
Get information about markets.

### Method
GET

### Endpoint
/get-markets
```
Tokens:
Raw