Marshall Polaris c640b4c830

Bring docs repo into main repo as new workspace (#369 )

* Bring docs repo into main repo as new workspace

* Pin @types/react to 17.x

2022-05-31 14:30:58 -07:00

11 KiB

Raw Blame History

API

:::caution

Our API is still in alpha — things may change or break at any time!

:::

Manifold currently supports a basic, read-only API for getting information about our markets.

If you have questions, come chat with us on Discord. We’d love to hear about what you build!

List out all markets

`/v0/markets`

Example request
```
http://manifold.markets/api/v0/markets
```

Example response

[
  {
    "id":"FKtYX3t8ZfIp5gytJWAI",
    "creatorUsername":"JamesGrugett",
    "creatorName":"James Grugett",
    "createdTime":1645139406452,
    "closeTime":1647406740000,
    "question":"What will be the best assessment of the Free response feature on March 15th?",
    "description":"Hey guys, let's try this out!\nWe will see how people use the new Free response market type over the next month. Then I will pick the answer that I think best describes the consensus view of this feature on March 15th. Cheers.",
    "tags":[
      "ManifoldMarkets"
    ],
    "url":"https://manifold.markets/JamesGrugett/what-will-be-the-best-assessment-of",
    "pool":null,
    "probability":0,
    "volume7Days":100,
    "volume24Hours":100,
    "isResolved":false,
    ...
  }

Response type: Array of LiteMarket

// Information about a market, but without bets or comments
type LiteMarket = {
  // Unique identifer for this market
  id: string

  // Attributes about the creator
  creatorUsername: string
  creatorName: string
  createdTime: number
  creatorAvatarUrl?: string

  // Market attributes. All times are in milliseconds since epoch
  closeTime?: number // Min of creator's chosen date, and resolutionTime
  question: string
  description: string
  tags: string[]
  url: string

  pool: number
  probability: number
  volume7Days: number
  volume24Hours: number
  isResolved: boolean
  resolutionTime?: number
  resolution?: string
}

Get information about one market

`/v0/market/[marketId]`

Example request

https://manifold.markets/api/v0/market/3zspH9sSzMlbFQLn9GKR

Example response

{
  "id": "3zspH9sSzMlbFQLn9GKR",
  "creatorUsername": "Austin",
  "creatorName": "Austin Chen",
  "createdTime": 1644103005345,
  "closeTime": 1667894340000,
  "question": "Will Carrick Flynn win the general election for Oregon's 6th District?",
  "description": "The Effective Altruism movement usually stays out of politics, but here is a recent, highly-upvoted endorsement of donating to Carrick Flynn as a high-impact area: https://forum.effectivealtruism.org/posts/Qi9nnrmjwNbBqWbNT/the-best-usd5-800-i-ve-ever-donated-to-pandemic-prevention\nFurther reading: https://ballotpedia.org/Oregon%27s_6th_Congressional_District_election,_2022\n\n#EffectiveAltruism #Politics",
  "tags": ["EffectiveAltruism", "Politics"],
  "url": "https://manifold.markets/Austin/will-carrick-flynn-win-the-general",
  "pool": 400.0916328426886,
  "probability": 0.34455568984059187,
  "volume7Days": 326.9083671573114,
  "volume24Hours": 0,
  "isResolved": false,
  "bets": [
    {
      "createdTime": 1644103005345,
      "isAnte": true,
      "shares": 83.66600265340756,
      "userId": "igi2zGXsfxYPgB0DJTXVJVmwCOr2",
      "amount": 70,
      "probAfter": 0.3,
      "probBefore": 0.3,
      "id": "E1MjiVYBM0GkqRXhv5cR",
      "outcome": "NO",
      "contractId": "3zspH9sSzMlbFQLn9GKR"
    },
    {
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "probAfter": 0.3,
      "shares": 54.77225575051661,
      "userId": "igi2zGXsfxYPgB0DJTXVJVmwCOr2",
      "isAnte": true,
      "createdTime": 1644103005345,
      "id": "jn3iIGwD5f0vxOHxo62o",
      "amount": 30,
      "probBefore": 0.3,
      "outcome": "YES"
    },
    {
      "shares": 11.832723364874056,
      "probAfter": 0.272108843537415,
      "userId": "PkBnU8cAZiOLa0fjxiUzMKsFMYZ2",
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "outcome": "NO",
      "amount": 10,
      "id": "f6sHBab6lbGw9PsnVXdc",
      "probBefore": 0.3,
      "createdTime": 1644203305863
    },
    {
      "userId": "BTksWMdCeHfDitWVaAZdjLSdu3o1",
      "amount": 10,
      "id": "Vfui2KOQwy7gkRPP7xc6",
      "shares": 18.12694184700382,
      "outcome": "YES",
      "createdTime": 1644212358699,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "probBefore": 0.272108843537415,
      "probAfter": 0.3367768595041322
    },
    {
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "probAfter": 0.3659259259259259,
      "userId": "BTksWMdCeHfDitWVaAZdjLSdu3o1",
      "probBefore": 0.3367768595041322,
      "amount": 5,
      "outcome": "YES",
      "createdTime": 1644433184238,
      "id": "eGI1VwAWF822LkcmOUot",
      "shares": 8.435122540124937
    },
    {
      "userId": "NHA7Gv9nNpb7b60GpLD3oFkBvPa2",
      "shares": 59.79133423528123,
      "amount": 50,
      "probAfter": 0.24495867768595042,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "createdTime": 1644693685223,
      "probBefore": 0.3659259259259259,
      "id": "fbU0DbmDWMnubggpQotw",
      "outcome": "NO"
    },
    {
      "amount": 25,
      "userId": "iXw2OSyhs0c4QW2fAfK3yqmaYDv1",
      "probAfter": 0.20583333333333328,
      "outcome": "NO",
      "shares": 28.3920247989266,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "createdTime": 1644695698202,
      "id": "k9hyljJD3MMXK2OYxTsR",
      "probBefore": 0.24495867768595042
    },
    {
      "createdTime": 1644716782308,
      "shares": 11.17480183821209,
      "probBefore": 0.20583333333333328,
      "userId": "clvYFhVDzccYu20OUc5NBKJyDxj2",
      "probAfter": 0.1927679500520291,
      "id": "yYkZ4JpLgZHrRQUugpCD",
      "outcome": "NO",
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "amount": 10
    },
    {
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "outcome": "YES",
      "amount": 30,
      "id": "IU2Hb1DesgKIN140BkhE",
      "shares": 58.893424111838016,
      "createdTime": 1644736846538,
      "probBefore": 0.1927679500520291,
      "userId": "BTksWMdCeHfDitWVaAZdjLSdu3o1",
      "probAfter": 0.3289359861591695
    },
    {
      "isSold": true,
      "userId": "5zeWhzi9nlNNf5C9TVjshAN7QOd2",
      "createdTime": 1644751343436,
      "outcome": "NO",
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "amount": 25,
      "probBefore": 0.3289359861591695,
      "id": "fkCxVH7THaDbEhyJjXVk",
      "probAfter": 0.2854194032651529,
      "shares": 30.022082866721178
    },
    {
      "probAfter": 0.2838618650900295,
      "id": "Ao05LRRMXVWw8d7LtwhL",
      "outcome": "NO",
      "probBefore": 0.2854194032651529,
      "shares": 1.1823269994736165,
      "userId": "pUF3dMs9oLNpgU2LYtFmodaoDow1",
      "amount": 1,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "createdTime": 1644768321860
    },
    {
      "id": "LJ8H8DTuK7CH9vN3u0Sd",
      "createdTime": 1644771352663,
      "shares": 113.5114039238785,
      "probAfter": 0.17510453314667793,
      "outcome": "NO",
      "amount": 100,
      "probBefore": 0.2838618650900295,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "userId": "ebX5nzwrs8V0M5UynWvbtcj7KAI2"
    },
    {
      "outcome": "YES",
      "amount": 20,
      "probBefore": 0.17510453314667793,
      "id": "TECEF9I5FqTqt6uTIsJX",
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "createdTime": 1644805061501,
      "shares": 43.88281646028875,
      "userId": "lHxg3179e4amWm5LJhJoJrcWK482",
      "probAfter": 0.24160019644701852
    },
    {
      "amount": -25.908367157311375,
      "id": "G3u2EzETWOyrGo15wtiQ",
      "outcome": "NO",
      "createdTime": 1644847494264,
      "sale": {
        "betId": "fkCxVH7THaDbEhyJjXVk",
        "amount": 25.862948799445807
      },
      "probAfter": 0.26957595409437557,
      "shares": -30.022082866721178,
      "probBefore": 0.24160019644701852,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "userId": "5zeWhzi9nlNNf5C9TVjshAN7QOd2"
    },
    {
      "createdTime": 1644853733891,
      "userId": "lbTXACtCnIacKDloKfXxYkDn0zM2",
      "amount": 10,
      "id": "z443uCkbYRLZW9QdXu1u",
      "probAfter": 0.25822886066938844,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "outcome": "NO",
      "shares": 11.655141043149968,
      "probBefore": 0.26957595409437557
    },
    {
      "userId": "BTksWMdCeHfDitWVaAZdjLSdu3o1",
      "amount": 15,
      "shares": 28.311399392675895,
      "id": "axoryV664uzHZ0jzWSXR",
      "outcome": "YES",
      "probBefore": 0.25822886066938844,
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "createdTime": 1644863335939,
      "probAfter": 0.3033936853512369
    },
    {
      "createdTime": 1644987330420,
      "id": "jHAYDdZRkDw3lFoDXdmm",
      "shares": 26.353902809992064,
      "userId": "BTksWMdCeHfDitWVaAZdjLSdu3o1",
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "probAfter": 0.34455568984059187,
      "probBefore": 0.3033936853512369,
      "amount": 15,
      "outcome": "YES"
    }
  ],
  "comments": [
    {
      "contractId": "3zspH9sSzMlbFQLn9GKR",
      "userUsername": "Celer",
      "userAvatarUrl": "https://lh3.googleusercontent.com/a/AATXAJwp0vAolZgOmT7GbzFq7mOf8lr0BFEB_LqWWfZk=s96-c",
      "userId": "NHA7Gv9nNpb7b60GpLD3oFkBvPa2",
      "text": "It's a D+3 district, and the person we're pushing is functionally an outsider. I maxed my donation, but 25%, what I bought down to, implying even odds on both the general and the primary, seems if anything optimistic.",
      "createdTime": 1644693740967,
      "id": "fbU0DbmDWMnubggpQotw",
      "betId": "fbU0DbmDWMnubggpQotw",
      "userName": "Celer"
    }
  ]
}

Response type: A FullMarket

// A complete market, along with bets and comments
type FullMarket = LiteMarket & {
  bets: Bet[]
  comments: Comment[]
}

type Bet = {
  id: string
  contractId: string

  amount: number // bet size; negative if SELL bet
  outcome: string
  shares: number // dynamic parimutuel pool weight; negative if SELL bet

  probBefore: number
  probAfter: number

  sale?: {
    amount: number // amount user makes from sale
    betId: string // id of bet being sold
  }

  isSold?: boolean // true if this BUY bet has been sold
  isAnte?: boolean

  createdTime: number
}

`/v0/slug/[marketSlug]`

This is a convenience endpoint for getting info about a market from it slug (everything after the last slash in a market’s URL).

Example request

https://manifold.markets/api/v0/slug/will-carrick-flynn-win-the-general

Response type: A FullMarket ; same as above.

Deprecated

Our old Markets API was available at https://us-central1-mantic-markets.cloudfunctions.net/markets
We don’t plan on continuing to change this, but we’ll support this endpoint until 2022-03-30

Changelog

2022-02-28: Add resolutionTime to markets, change closeTime definition
2022-02-19: Removed user IDs from bets
2022-02-17: Released our v0 API, with /markets, /market/[marketId], and /slug/[slugId]

11 KiB Raw Blame History Unescape Escape

API