Myriad Markets

https://docs.myriad.markets
Admin
Myriad Markets is a blockchain-based prediction platform where users can trade prediction markets on...
Tokens:24,036
Snippets:176
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### JavaScript SDK Installation

Source: https://docs.myriad.markets/builders/javascript-sdk

Instructions on how to install the polkamarkets-js library using npm or yarn.

```APIDOC
## Installation
Install the package via npm or yarn:
```

shell
# npm
npm install polkamarkets-js

# yarn
yarn add polkamarkets-js

```
```

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

### Install polkamarkets-js SDK

Source: https://docs.myriad.markets/builders/javascript-sdk

Instructions for installing the polkamarkets-js library using npm or yarn package managers.

```shell
# npm
npm install polkamarkets-js

# yarn
yarn add polkamarkets-js
```

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

### Install Myriad CLI

Source: https://docs.myriad.markets/builders/ai-agents-and-llms

Installs the Myriad Markets command-line interface globally using npm. This is the primary requirement for accessing market discovery, trading, and MCP server features.

```bash
npm install -g @myriadmarkets/cli
```

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

### Initializing Polkamarkets SDK

Source: https://docs.myriad.markets/builders/javascript-sdk

Example of initializing the Polkamarkets application instance with necessary providers and configurations.

```APIDOC
## Initializing Polkamarkets
Below is an example snippet that creates a new Polkamarkets application instance with social login and various network configurations:
```

javascript
const polkamarkets = new polkamarketsjs.Application({
  web3Provider,
  web3EventsProvider,
  web3PrivateKey
});

```

Once created, `polkamarkets` can be used throughout your app to interact with Polkamarkets smart contracts, handle user logins, track events, and more.
```

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

### Get User Address with polkamarkets-js

Source: https://docs.myriad.markets/builders/javascript-sdk

Example of retrieving the currently logged-in user's wallet address using the `getAddress` method.

```javascript
const userAddress = await polkamarkets.getAddress();
console.log(`User is logged in as: ${address}`);
```

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

### Complete Polkamarkets Workflow

Source: https://docs.myriad.markets/builders/javascript-sdk

A comprehensive example demonstrating SDK initialization, contract instantiation, token approval, and buying outcome shares in a prediction market.

```javascript
import * as polkamarketsjs from 'polkamarkets-js';

const polkamarkets = new polkamarketsjs.Application({
  web3Provider: 'api.mainnet.abs.xyz',
  web3PrivateKey: '',
});

const pm = polkamarkets.getPredictionMarketV3PlusContract({
  contractAddress: '0x3e0F5F8F5Fb043aBFA475C0308417Bf72c463289',
  querierContractAddress: '0x1d5773Cd0dC74744C1F7a19afEeECfFE64f233Ff'
});

const erc20 = polkamarkets.getERC20Contract({
  contractAddress: '0x84a71ccd554cc1b02749b35d22f684cc8ec987e1'
});

await polkamarkets.login();
const userAddress = await polkamarkets.getAddress();

const neededAmount = '100000000';
const spender = '0x4f4988A910f8aE9B3214149A8eA1F2E4e3Cd93CC';

const approved = await erc20.isApproved({
  address: userAddress,
  spenderAddress: spender,
  amount: neededAmount
});

if (!approved) {
  await erc20.approve({
    address: userAddress,
    amount: neededAmount,
    spenderAddress: spender
  });
}

const marketId = 123;
const outcomeId = 0;
const value = 10;
const minOutcomeSharesToBuy = await pm.calcBuyAmount({ marketId, outcomeId, value });

await pm.buy({ marketId, outcomeId, value, minOutcomeSharesToBuy });
const portfolio = await pm.getPortfolio({ user: userAddress });
```

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

### Contract Addresses Overview

Source: https://docs.myriad.markets/builders/contract-addresses

A reference guide for interacting with Myriad Protocol smart contracts on various networks.

```APIDOC
## Contract Addresses Reference

### Description
This documentation lists the deployed addresses for the Myriad Protocol's PredictionMarket and PredictionMarketQuerier contracts, as well as the tokens used for market denomination on supported blockchains.

### Supported Networks
- BNB Smart Chain
- Abstract
- Linea
- Celo

### Deployment Details
#### BNB Smart Chain
- **PredictionMarket**: 0x39E66eE6b2ddaf4DEfDEd3038E0162180dbeF340 (Mainnet)
- **PredictionMarketQuerier**: 0xDeFb36c47754D2e37d44b8b8C647D4D643e03bAd (Mainnet)

#### Abstract
- **PredictionMarket**: 0x3e0F5F8F5Fb043aBFA475C0308417Bf72c463289 (Mainnet)
- **PredictionMarketQuerier**: 0x1d5773Cd0dC74744C1F7a19afEeECfFE64f233Ff (Mainnet)

#### Linea
- **PredictionMarket**: 0x39e66ee6b2ddaf4defded3038e0162180dbef340 (Mainnet)
- **PredictionMarketQuerier**: 0x503c9f98398dc3433ABa819BF3eC0b97e02B8D04 (Mainnet)

### Security
- The prediction market contracts have been audited by Cyfrin.
```

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

### Import polkamarkets-js Library

Source: https://docs.myriad.markets/builders/javascript-sdk

Example of how to import the polkamarkets-js library into your JavaScript project, either all exported modules or specific parts.

```javascript
import * as polkamarketsjs from 'polkamarkets-js';
```

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

### POST /markets/quote_with_fee Request Example (JSON)

Source: https://docs.myriad.markets/builders/myriad-api-reference

This JSON object demonstrates a sample request body for the POST /markets/quote_with_fee endpoint. It includes parameters for a market trade, specifying a frontend fee, sender wallet, and recipient wallet for the fee.

```json
{
  "market_id": 164,
  "outcome_id": 0,
  "network_id": 2741,
  "action": "buy",
  "value": 100,
  "slippage": 0.01,
  "fee": 0.01,
  "from_wallet": "0x0000000000000000000000000000000000000001",
  "to_wallet": "0x0000000000000000000000000000000000000002"
}
```

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

### GET /markets

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves a list of all available markets within the Myriad Protocol.

```APIDOC
## GET /markets

### Description
Fetch a list of all markets currently available on the platform.

### Method
GET

### Endpoint
/markets

### Response
#### Success Response (200)
- **markets** (array) - List of market objects.

#### Response Example
{
  "markets": [
    { "id": "market_1", "name": "Example Market" }
  ]
}
```

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

### Prediction Market Contract Initialization

Source: https://docs.myriad.markets/builders/javascript-sdk

How to get an instance of the Prediction Market V3 Plus contract using the polkamarkets-js SDK.

```APIDOC
## Prediction Market Contract
Before calling these methods, you'll typically create a `pm` instance from your polkamarkets application object:
```

javascript
import * as polkamarketsjs from 'polkamarkets-js';

// Example snippet:
// 1) You've already instantiated `polkamarkets` (see the prior docs).
// 2) Now get the prediction market V3 contract:
const pm = polkamarkets.getPredictionMarketV3PlusContract({
  contractAddress: '0x1234...',       // actual PM contract
  querierContractAddress: '0xabcd...' // optional, if you have a read-only/querier contract
});


```
```

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

### GET /portfolio

Source: https://docs.myriad.markets/builders/javascript-sdk

Retrieves the user's current holdings, claim status, and outcome details.

```APIDOC
## GET /portfolio

### Description
Fetch the user's holdings and claim status for each outcome in markets they have participated in.

### Method
GET

### Parameters
#### Query Parameters
- **user** (string) - Required - The wallet address of the user.

### Response
#### Success Response (200)
- **portfolio** (object) - Object containing market IDs, outcome shares, and claim statuses.

### Response Example
{
  "20": {
    "outcomes": {
      "0": { "shares": 1591.87, "price": 0.6281 }
    },
    "claimStatus": { "winningsToClaim": false }
  }
}
```

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

### GET /markets

Source: https://docs.myriad.markets/builders

Fetch a list of available prediction markets and their current status.

```APIDOC
## GET /markets

### Description
Retrieves a list of all active prediction markets available on the Myriad Protocol.

### Method
GET

### Endpoint
/markets

### Parameters
#### Query Parameters
- **chain_id** (integer) - Optional - Filter markets by specific EVM chain ID.
- **status** (string) - Optional - Filter by market status (e.g., 'open', 'closed', 'resolved').

### Request Example
GET /markets?chain_id=56

### Response
#### Success Response (200)
- **markets** (array) - List of market objects containing IDs, titles, and current odds.

#### Response Example
{
  "markets": [
    {
      "id": "0x123...",
      "title": "Will BTC reach 100k?",
      "status": "open"
    }
  ]
}
```

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

### GET /users/:address/portfolio

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves the portfolio details for a specific user address.

```APIDOC
## GET /users/:address/portfolio

### Description
Retrieve the portfolio holdings and activity for a given user wallet address.

### Method
GET

### Endpoint
/users/:address/portfolio

### Parameters
#### Path Parameters
- **address** (string) - Required - The wallet address of the user.

### Response
#### Success Response (200)
- **portfolio** (object) - The user's portfolio data.

#### Response Example
{
  "address": "0x123...",
  "balance": "100.00"
}
```

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

### POST /markets/quote_with_fee Success Response Example (JSON)

Source: https://docs.myriad.markets/builders/myriad-api-reference

This JSON object represents a successful response from the POST /markets/quote_with_fee endpoint. It includes trade details, fee breakdown (including frontend fee), and the 'calldata' object required for EIP-5792 wallet transactions.

```json
{
    "value": 100,
    "shares": 107.71301097629218,
    "shares_threshold": 107.17444592141072,
    "price_average": 0.9191090203744288,
    "price_before": 0.89954079,
    "price_after": 0.9019004096700267,
    "calldata": {
        "version": "2.0.0",
        "from": "0x0000000000000000000000000000000000000001",
        "chainId": "0xab5",
        "atomicRequired": true,
        "calls": [
            {
                "to": "0x55d398326f99059fF775485246999027B3197955",
                "data": "0x095ea7b300000000000000000000000039e66ee6b2ddaf4defded3038e0162180dbef3400000000000000000000000000000000000000000000000055de6a779bbac0000",
                "value": "0x0"
            },
            {
                "to": "0x55d398326f99059fF775485246999027B3197955",
                "data": "0xa9059cbb00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000de0b6b3a7640000",
                "value": "0x0"
            },
            {
                "to": "0x39E66eE6b2ddaf4DEfDEd3038E0162180dbeF340",
                "data": "0x1281311d0000000000000000000000000000000000000000000000000000000000002327000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000005cf581ebb20ffaa2d000000000000000000000000000000000000000000000055de6a779bbac0000",
                "value": "0x0"
            }
        ]
    },
    "net_amount": 97.02,
    "fees": {
        "treasury": 0,
        "distributor": 0.99,
        "fee": 0.99,
        "frontend": 1
    },
    "approval": {
        "required": true,
        "currentAllowanceWei": "0",
        "requiredAllowanceWei": "99000000000000000000"
    }
}
```

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

### Get Prediction Market V3 Contract Instance

Source: https://docs.myriad.markets/builders/javascript-sdk

Shows how to obtain an instance of the Prediction Market V3 contract, optionally providing a querier contract address for read-only operations.

```javascript
import * as polkamarketsjs from 'polkamarkets-js';

// Example snippet:
// 1) You've already instantiated `polkamarkets` (see the prior docs).
// 2) Now get the prediction market V3 contract:
const pm = polkamarkets.getPredictionMarketV3PlusContract({
  contractAddress: '0x1234...',       // actual PM contract
  querierContractAddress: '0xabcd...' // optional, if you have a read-only/querier contract
});
```

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

### GET /questions

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves a paginated list of questions, including associated markets and outcome summaries. Supports filtering by keyword and market count.

```APIDOC
## GET /questions

### Description
Paginated list of questions with associated markets and outcome summaries.

### Method
GET

### Endpoint
/questions

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Current page number for pagination (default: 1).
- **limit** (integer) - Optional - Number of items per page (default: 20, max: 100).
- **keyword** (string) - Optional - Search term to filter questions by title.
- **min_markets** (integer) - Optional - Minimum number of linked markets a question must have.
- **max_markets** (integer) - Optional - Maximum number of linked markets a question can have.

### Request Example
```plain text
GET /questions?keyword=politics&page=2&limit=20&min_markets=2&max_markets=10
```

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the question.
- **title** (string) - The title of the question.
- **expiresAt** (string) - The expiration timestamp of the question.
- **marketCount** (integer) - The number of markets associated with the question.
- **markets** (array) - An array of market objects:
  - **id** (string) - The blockchain market ID.
  - **slug** (string) - A URL-friendly identifier for the market.
  - **title** (string) - The title of the market.
  - **description** (string) - A description of the market.
  - **state** (string) - The current state of the market (e.g., open, resolved).
  - **networkId** (string) - The ID of the blockchain network.
  - **liquidity** (number) - The total liquidity in the market.
  - **volume** (number) - The total trading volume for the market.
  - **volume24h** (number) - The trading volume in the last 24 hours.
  - **imageUrl** (string) - URL for an image representing the market.
  - **expiresAt** (string) - The expiration timestamp of the market.
  - **topics** (array) - An array of topics associated with the market.
  - **outcomes** (array) - An array of outcome objects:
    - **id** (string) - The ID of the outcome.
    - **title** (string) - The title of the outcome.
    - **price** (number) - The current trading price of the outcome.
    - **shares** (number) - The number of shares available for the outcome.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "title": "Will the next US president be a woman?",
      "expiresAt": "2025-01-20T00:00:00Z",
      "marketCount": 3,
      "markets": [
        {
          "id": "0xabc...",
          "slug": "us-pres-2024-female",
          "title": "US Presidential Election 2024 - Female President",
          "description": "Prediction market for the 2024 US Presidential Election outcome.",
          "state": "open",
          "networkId": "ethereum",
          "liquidity": 10000,
          "volume": 5000,
          "volume24h": 200,
          "imageUrl": "https://example.com/image.png",
          "expiresAt": "2025-01-20T00:00:00Z",
          "topics": ["politics", "usa"],
          "outcomes": [
            {
              "id": "yes",
              "title": "Yes",
              "price": 0.6,
              "shares": 6000
            },
            {
              "id": "no",
              "title": "No",
              "price": 0.4,
              "shares": 4000
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 10,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}
```
```

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

### Getting User Address with Polkamarkets SDK

Source: https://docs.myriad.markets/builders/javascript-sdk

How to retrieve the currently logged-in user's wallet address.

```APIDOC
### 2. Getting the User Address
```

javascript
const userAddress = await polkamarkets.getAddress();
console.log(`User is logged in as: ${address}`);

```
```

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

### GET /users/:address/events - Paginated User Actions

Source: https://docs.myriad.markets/builders/myriad-api-reference

Fetches a paginated list of user actions across markets, ordered by timestamp in descending order. Supports filtering by `market_id`, `market_slug`, `network_id`, and time range (`since`, `until`). Each item includes details about the user, action, market, outcome, shares, value, and timestamp.

```plaintext
GET /users/0x1234.../events?network_id=2741&market_id=144&page=1&limit=50
```

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

### GET /users/:address/markets

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves the portfolio view for a specific user address, aggregated by markets and ordered by recent activity.

```APIDOC
## GET /users/:address/markets

### Description
Returns a portfolio view for a given user address, grouped by market. Results are ordered by the latest user activity in each market.

### Method
GET

### Endpoint
/users/:address/markets

### Parameters
#### Path Parameters
- **address** (string) - Required - The user's wallet address.

#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.
- **limit** (integer) - Optional - Number of items per page (default 10, max 100).
- **min_shares** (number) - Optional - Minimum shares threshold (default 0.1).
- **network_id** (number) - Optional - Filter by network ID.
- **state** (string) - Optional - Filter by market state: 'open', 'closed', or 'resolved'.
- **token_address** (string) - Optional - Filter by ERC20 token address.
- **topics** (string) - Optional - Comma-separated list of topics.
- **keyword** (string) - Optional - Full-text search string.
- **market_ids** (string) - Optional - Comma-separated list of {networkId}:{marketId} pairs.

### Response
#### Success Response (200)
- **market** (object) - Market details.
- **portfolio** (object) - User's positions and liquidity data.

#### Response Example
{
  "market": { "id": "123", "title": "Example Market" },
  "portfolio": {
    "positions": [],
    "liquidity": {}
  }
}
```

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

### GET /users/:address/portfolio - Aggregated User Positions

Source: https://docs.myriad.markets/builders/myriad-api-reference

Provides an aggregated view of a user's positions per market, outcome, and network, ordered by the latest activity. Supports filtering by `market_slug`, `market_id`, `network_id`, `token_address`, and a minimum shares threshold (`min_shares`). Positions with less than 1 share are excluded. The response details market/outcome information, shares held, average buy price, value, profit, ROI, and status.

```plaintext
GET /users/0x1234.../portfolio?network_id=2741&token_address=0x84A71ccD554Cc1b02749b35d22F684CC8ec987e1&page=1&limit=20
```

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

### GET /markets

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieve a paginated list of markets with support for filtering by network, state, topics, keywords, and complex fee structures.

```APIDOC
## GET /markets

### Description
Fetch a paginated list of markets. Supports extensive filtering including keywords, network IDs, market states, and specific protocol fee thresholds.

### Method
GET

### Endpoint
/markets

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination
- **limit** (integer) - Optional - Number of items per page
- **sort** (string) - Optional - Sort field: volume, volume_24h, liquidity, expires_at, published_at, featured
- **order** (string) - Optional - Sort order: asc, desc
- **network_id** (string) - Optional - Comma-separated network IDs
- **state** (string) - Optional - Market state: open, closed, resolved
- **keyword** (string) - Optional - Search term for titles and descriptions
- **{action}_{component}_fee_{operator}** (decimal) - Optional - Fee filters (e.g., buy_lp_fee_lte=0.01)

### Request Example
GET /markets?keyword=eth&network_id=2741&page=1&limit=20&sort=volume_24h

### Response
#### Success Response (200)
- **id** (number) - Blockchain market ID
- **title** (string) - Market title
- **outcomes** (array) - List of market outcomes

#### Response Example
{
  "id": 164,
  "title": "Will ETH reach $4000?",
  "state": "open"
}
```

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

### GET /users/:address/referrals - Paginated User Referrals

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves a paginated list of referrals attributed to a user, ordered by timestamp in descending order. Allows filtering by `market_id`, `market_slug`, `network_id`, time range (`since`, `until`), and `code`. The response includes details about the referrer/user, action, market, outcome, value, timestamp, referral code, and fees.

```plaintext
GET /users/0x1234.../referrals?network_id=2741&market_id=144&page=1&limit=50
```

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

### POST /markets/claim - Get Trade Claim and Transaction Calldata

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves a trade claim and transaction calldata for a specific market. Requires either `market_id` and `network_id` or `market_slug`. The `outcome_id` is optional but required if the market is voided. The market must exist and be resolved. The response includes the `action` (claim_winnings or claim_voided), `outcome_id`, and hex-encoded `calldata` for contract interaction.

```json
{
  "market_id": 164,
  "outcome_id": 0,
  "network_id": 2741
}
```

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

### Initialize Polkamarkets Application Instance

Source: https://docs.myriad.markets/builders/javascript-sdk

Demonstrates how to create a new Polkamarkets application instance with necessary Web3 providers and an optional private key for authentication.

```javascript
const polkamarkets = new polkamarketsjs.Application({
  web3Provider,
  web3EventsProvider,
  web3PrivateKey
});
```

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

### GET /market-prices

Source: https://docs.myriad.markets/builders/javascript-sdk

Fetches current market prices for all outcomes in a specific market.

```APIDOC
## GET /market-prices

### Description
Get the current price of outcomes in a market. Prices are represented as values between 0 and 1.

### Method
GET

### Parameters
#### Query Parameters
- **marketId** (string) - Required - The unique identifier of the market.

### Response
#### Success Response (200)
- **liquidity** (number) - Current liquidity price.
- **outcomes** (object) - Mapping of outcome IDs to their current price.

### Response Example
{
  "liquidity": 0.618,
  "outcomes": { "0": 0.89, "1": 0.10 }
}
```

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

### Connecting Wallet with Polkamarkets SDK

Source: https://docs.myriad.markets/builders/javascript-sdk

How to log in and connect a user's wallet using the polkamarkets-js library.

```APIDOC
## Logging in Polkamarkets-js
After initializing your Polkamarkets instance, you can call other methods (e.g., connecting to the user’s wallet, creating markets, buying/selling outcome shares, adding liquidity, claiming rewards, etc.). These topics can be documented in subsequent sections.
### 1. Connecting Wallet
Before you can check allowances or send transactions, you need to login into the application using the `login` method. This will trigger a wallet popup to authorize the application. If `web3PrivateKey` is sent when initializing polkamarkets this step is not necessary.
```

javascript
await service.login(); // triggers polkamarkets to connect user wallet

```
```

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

### Connect User Wallet with polkamarkets-js

Source: https://docs.myriad.markets/builders/javascript-sdk

Code snippet to initiate the wallet connection process using the `login` method of the Polkamarkets instance. This step is skipped if a private key is provided during initialization.

```javascript
await service.login(); // triggers polkamarkets to connect user wallet
```

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

### GET /markets/:id/referrals

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves paginated referral data for a specific market, ordered by timestamp.

```APIDOC
## GET /markets/:id/referrals

### Description
Fetches a list of referrals for a given market, allowing filtering by time range and referral code.

### Method
GET

### Endpoint
/markets/{id}/referrals

### Parameters
#### Path Parameters
- **id** (string/number) - Required - The market ID or slug.

#### Query Parameters
- **network_id** (number) - Optional - Required when using market ID.
- **page** (number) - Optional - Page number for pagination.
- **limit** (number) - Optional - Items per page.
- **since** (number) - Optional - Start timestamp (unix seconds).
- **until** (number) - Optional - End timestamp (unix seconds).
- **code** (string) - Optional - Referral code filter.

### Request Example
GET /markets/164/referrals?network_id=2741&since=1755600000&until=1755800000&page=1&limit=50

### Response
#### Success Response (200)
- **referrals** (array) - List of referral objects containing user, action, market details, and fee breakdown.
```

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

### Initialize ERC20 Contract Instance

Source: https://docs.myriad.markets/builders/javascript-sdk

Instantiates an ERC20 contract reference using the Polkamarkets SDK. This reference is required for subsequent token-related operations.

```javascript
const erc20 = polkamarkets.getERC20Contract({
  contractAddress: '0xYOUR_ERC20_TOKEN_ADDRESS'
});
```

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

### GET /questions/:id

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves a single question by its ID, including all its associated markets and outcomes.

```APIDOC
## GET /questions/:id

### Description
Get a single question with markets and outcomes.

### Method
GET

### Endpoint
/questions/:id

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the question.

### Request Example
```plain text
GET /questions/1
```

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the question.
- **title** (string) - The title of the question.
- **expiresAt** (string) - The expiration timestamp of the question.
- **markets** (array) - An array of market objects:
  - **id** (string) - The blockchain market ID.
  - **slug** (string) - A URL-friendly identifier for the market.
  - **title** (string) - The title of the market.
  - **description** (string) - A description of the market.
  - **state** (string) - The current state of the market (e.g., open, resolved).
  - **networkId** (string) - The ID of the blockchain network.
  - **liquidity** (number) - The total liquidity in the market.
  - **volume** (number) - The total trading volume for the market.
  - **volume24h** (number) - The trading volume in the last 24 hours.
  - **shares** (number) - The number of shares traded for the market.
  - **imageUrl** (string) - URL for an image representing the market.
  - **expiresAt** (string) - The expiration timestamp of the market.
  - **topics** (array) - An array of topics associated with the market.
  - **fees** (object) - Information about fees associated with the market.
  - **outcomes** (array) - An array of outcome objects:
    - **id** (string) - The ID of the outcome.
    - **title** (string) - The title of the outcome.
    - **price** (number) - The current trading price of the outcome.
    - **shares** (number) - The number of shares available for the outcome.
    - **imageUrl** (string) - URL for an image representing the outcome.

#### Response Example
```json
{
  "data": {
    "id": 1,
    "title": "Will the next US president be a woman?",
    "expiresAt": "2025-01-20T00:00:00Z",
    "markets": [
      {
        "id": "0xabc...",
        "slug": "us-pres-2024-female",
        "title": "US Presidential Election 2024 - Female President",
        "description": "Prediction market for the 2024 US Presidential Election outcome.",
        "state": "open",
        "networkId": "ethereum",
        "liquidity": 10000,
        "volume": 5000,
        "volume24h": 200,
        "shares": 10000,
        "imageUrl": "https://example.com/image.png",
        "expiresAt": "2025-01-20T00:00:00Z",
        "topics": ["politics", "usa"],
        "fees": {
          "tradingFee": "0.02",
          "protocolFee": "0.005"
        },
        "outcomes": [
          {
            "id": "yes",
            "title": "Yes",
            "price": 0.6,
            "shares": 6000,
            "imageUrl": "https://example.com/yes.png"
          },
          {
            "id": "no",
            "title": "No",
            "price": 0.4,
            "shares": 4000,
            "imageUrl": "https://example.com/no.png"
          }
        ]
      }
    ]
  }
}
```
```

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

### GET /markets/:id/events

Source: https://docs.myriad.markets/builders/myriad-api-reference

Fetch historical events for a specific market, such as trades, liquidity changes, and claims.

```APIDOC
## GET /markets/:id/events

### Description
Retrieve a paginated list of actions (trades, liquidity, claims) for a specific market, ordered by timestamp.

### Method
GET

### Endpoint
/markets/{id}/events

### Parameters
#### Path Parameters
- **id** (string/number) - Required - Market slug or ID

#### Query Parameters
- **network_id** (number) - Required (if using ID) - Network ID
- **since** (integer) - Optional - Start timestamp (unix seconds)
- **until** (integer) - Optional - End timestamp (unix seconds)

### Request Example
GET /markets/164/events?network_id=2741&since=1755600000&until=1755800000

### Response
#### Success Response (200)
- **user** (string) - Wallet address
- **action** (string) - Type of event (buy, sell, add_liquidity, etc.)
- **timestamp** (integer) - Event time

#### Response Example
{
  "user": "0x123...",
  "action": "buy",
  "timestamp": 1755600000
}
```

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

### GET /markets/:id/holders

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieves market holders grouped by outcome, showing net shares per user.

```APIDOC
## GET /markets/:id/holders

### Description
Aggregates buy/sell actions to compute net shares per user per outcome, filtered for holders with at least 1 share.

### Method
GET

### Endpoint
/markets/{id}/holders

### Parameters
#### Path Parameters
- **id** (string/number) - Required - The market ID or slug.

#### Query Parameters
- **network_id** (number) - Required - Required when using market ID.
- **page** (number) - Optional - Page number.
- **limit** (number) - Optional - Items per outcome.

### Request Example
GET /markets/164/holders?network_id=2741&page=1&limit=50

### Response
#### Success Response (200)
- **outcomeId** (number) - ID of the outcome.
- **holders** (array) - List of users and their share counts.
```

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

### Fetch User Portfolio (JavaScript)

Source: https://docs.myriad.markets/builders/javascript-sdk

Retrieves the user's current holdings, including shares and claim status for each outcome and liquidity provision. Provides a detailed overview of the user's market activity.

```javascript
const portfolio = await pm.getPortfolio({
	user
});

console.log(portfolio);
```

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

### GET /markets/:id

Source: https://docs.myriad.markets/builders/myriad-api-reference

Retrieve detailed information for a specific market, including price charts for various timeframes.

```APIDOC
## GET /markets/:id

### Description
Get a single market by slug or by market ID combined with a network ID. Includes price chart data for outcomes.

### Method
GET

### Endpoint
/markets/{id}

### Parameters
#### Path Parameters
- **id** (string/number) - Required - Market slug or ID

#### Query Parameters
- **network_id** (number) - Required (if using ID) - The network ID of the market

### Request Example
GET /markets/164?network_id=2741

### Response
#### Success Response (200)
- **id** (number) - Market ID
- **outcomes** (array) - Outcomes including price_charts

#### Response Example
{
  "id": 164,
  "slug": "will-eth-reach-4000",
  "outcomes": []
}
```

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

### POST /markets/quote_with_fee

Source: https://docs.myriad.markets/builders/myriad-api-reference

This endpoint allows select integrators to charge a frontend fee at the time of a trade by using bundled transactions. It returns a trade quote along with an ordered set of EIP-5792 calls that can be sent via `wallet_sendCalls` to approve ERC20 collateral, transfer the frontend fee, and execute the trade.

```APIDOC
## POST /markets/quote_with_fee

### Description
This endpoint allows select integrators to charge a frontend fee at the time of a trade by using bundled transactions. It returns a trade quote along with an ordered set of EIP-5792 calls that can be sent via `wallet_sendCalls` to approve ERC20 collateral, transfer the frontend fee, and execute the trade.

### Method
POST

### Endpoint
/markets/quote_with_fee

### Parameters
#### Request Body
- **market_id** (number) - Required - The ID of the market.
- **outcome_id** (number) - Required - The ID of the outcome.
- **network_id** (number) - Required - The network ID of the market.
- **action** (string) - Required - The action to perform (e.g., "buy", "sell").
- **value** (number) - Required - The amount of tokens to trade or the total amount charged (for buy actions).
- **slippage** (number) - Optional - The maximum acceptable slippage.
- **fee** (number) - Required - Decimal fee rate, between 0 and 0.05 (e.g. `0.01` = 1%).
- **from_wallet** (string) - Required - Wallet that will sign/send the bundle (used for allowance+balance checks).
- **to_wallet** (string) - Required - Fee recipient wallet.

### Request Example
```json
{
  "market_id": 164,
  "outcome_id": 0,
  "network_id": 2741,
  "action": "buy",
  "value": 100,
  "slippage": 0.01,
  "fee": 0.01,
  "from_wallet": "0x0000000000000000000000000000000000000001",
  "to_wallet": "0x0000000000000000000000000000000000000002"
}
```

### Response
#### Success Response (200)
- **value** (number) - The total amount charged (for buy actions) or amount after fee deduction (for sell actions).
- **shares** (number) - The number of shares received or traded.
- **shares_threshold** (number) - The minimum number of shares to receive.
- **price_average** (number) - The average price of the trade.
- **price_before** (number) - The price before the trade.
- **price_after** (number) - The price after the trade.
- **calldata** (object) - Data for `wallet_sendCalls`.
  - **version** (string) - The version of the calldata format.
  - **from** (string) - The sender address.
  - **chainId** (string) - The hex chain ID.
  - **atomicRequired** (boolean) - Whether the transaction must be atomic.
  - **calls** (array) - An array of transaction calls.
    - **to** (string) - The recipient address of the call.
    - **data** (string) - The calldata for the call.
    - **value** (string) - The value to send with the call.
- **net_amount** (number) - The net amount after fees.
- **fees** (object) - Details of fees applied.
  - **treasury** (number) - Treasury fee amount.
  - **distributor** (number) - Distributor fee amount.
  - **fee** (number) - Standard market fee amount.
  - **frontend** (number) - Frontend fee amount.
- **approval** (object) - Details about token approval.
  - **required** (boolean) - Whether approval is required.
  - **currentAllowanceWei** (string, optional) - The current allowance in wei.
  - **requiredAllowanceWei** (string, optional) - The required allowance in wei.

#### Response Example
```json
{
    "value": 100,
    "shares": 107.71301097629218,
    "shares_threshold": 107.17444592141072,
    "price_average": 0.9191090203744288,
    "price_before": 0.89954079,
    "price_after": 0.9019004096700267,
    "calldata": {
        "version": "2.0.0",
        "from": "0x0000000000000000000000000000000000000001",
        "chainId": "0xab5",
        "atomicRequired": true,
        "calls": [
            {
                "to": "0x55d398326f99059fF775485246999027B3197955",
                "data": "0x095ea7b300000000000000000000000039e66ee6b2ddaf4defded3038e0162180dbef3400000000000000000000000000000000000000000000000055de6a779bbac0000",
                "value": "0x0"
            },
            {
                "to": "0x55d398326f99059fF775485246999027B3197955",
                "data": "0xa9059cbb00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000de0b6b3a7640000",
                "value": "0x0"
            },
            {
                "to": "0x39E66eE6b2ddaf4DEfDEd3038E0162180dbeF340",
                "data": "0x1281311d00000000000000000000000000000000000000000000000000000000000023270000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000005cf581ebb20ffaa2d000000000000000000000000000000000000000000000055de6a779bbac0000",
                "value": "0x0"
            }
        ]
    },
    "net_amount": 97.02,
    "fees": {
        "treasury": 0,
        "distributor": 0.99,
        "fee": 0.99,
        "frontend": 1
    },
    "approval": {
        "required": true,
        "currentAllowanceWei": "0",
        "requiredAllowanceWei": "99000000000000000000"
    }
}
```

### Notes
- **Buy fee semantics**: for `action="buy"`, the request `value` is treated as the **total amount charged** from the user. The frontend fee is deducted first, and the trade is quoted/executed with the remaining amount. The response `value` equals the total charged (same as request value).
- **Sell fee semantics**: for `action="sell"`, the frontend fee is charged after the trade, and the response `value` reflects the amount **after** frontend fee deduction.
- Clients should strongly prefer requiring atomic bundling (i.e. `"atomicRequired": true`) so the fee transfer is not executed without the trade.

### Authentication
This endpoint requires API authentication and whitelisting. Please reach out to the Myriad team for access.
```

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

### JavaScript SDK Importing

Source: https://docs.myriad.markets/builders/javascript-sdk

How to import the polkamarkets-js library into your JavaScript project.

```APIDOC
## Importing the Library
In your code, import all exported modules or the parts you need:
```

javascript
import * as polkamarketsjs from 'polkamarkets-js';

```
```

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

### Polkamarkets SDK Configuration Fields

Source: https://docs.myriad.markets/builders/javascript-sdk

Description of the configuration fields used when initializing the Polkamarkets SDK.

```APIDOC
## Configuration Fields
The table below describes each field you see in the initialization object above. Many values are derived from environment variables in this example, but you can hardcode them if you prefer.
Field| Type| Description  
---|---|---
`**web3Provider**`| `string`| Primary Web3 provider endpoint or an instantiated provider object for RPC calls (e.g. MetaMask, Alchemy, Infura).  
`**web3PrivateKey**`| `string`| (Optional) private key of wallet to use, if you want to bypass wallet/social login authentication  
`**web3EventsProvider**`| `string`| (Optional) polkamarkets-rpc web3 endpoint specifically for event subscriptions.  
```

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

### POST /login

Source: https://docs.myriad.markets/builders/javascript-sdk

Authenticates the user with the Polkamarkets SDK using either a private key for direct signing or a social/wallet login flow.

```APIDOC
## POST /login

### Description
Initializes the SDK and authenticates the user. Supports direct signing via private key or standard wallet providers like Metamask.

### Method
POST

### Endpoint
/login

### Parameters
#### Request Body
- **web3Provider** (string) - Required - The RPC URL (e.g., api.mainnet.abs.xyz)
- **web3PrivateKey** (string) - Optional - Private key for direct signing
- **isSocialLogin** (boolean) - Required - Set to true to trigger wallet UI flow

### Request Example
{
  "web3Provider": "api.mainnet.abs.xyz",
  "isSocialLogin": true
}

### Response
#### Success Response (200)
- **status** (string) - Authentication success status

#### Response Example
{
  "status": "authenticated"
}
```
Tokens:
Raw