favorites

Get favorite events

List the calling user's favorite events with the embedded event.

get/favorite_events

Request

  • Base URL: https://gamma-api.polymarket.com (the document declares no server; this is the origin it was published from)
  • URL: https://gamma-api.polymarket.com/favorite_events
  • Auth: one of:
    • API key in cookie polymarketsession
    • HTTP bearer

Query parameters

addressstring

Wallet address override (admin)

orderstring

Comma-separated field names to sort by

ascendingboolean

Sort ascending when true (default true)

limitinteger

Max results returned

offsetinteger

Number of results to skip

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time nullable required
created_bystring nullable required
event_idstring nullable required
idstring required
published_atstring nullable required
updated_atstring date-time nullable required
updated_bystring nullable required
user_idstring nullable required

Example response

[
  {
    "$schema": "https://example.com/schemas/FavoriteEvent.json",
    "event": {
      "$schema": "https://example.com/schemas/Event.json",
      "eventCreators": [
        {
          "$schema": "https://example.com/schemas/EventCreator.json"
        }
      ],
      "externalPartners": [
        {
          "$schema": "https://example.com/schemas/EventExternalPartnerMapping.json",
          "partner": {
            "$schema": "https://example.com/schemas/Partner.json"
          }
        }
      ],
      "markets": [
        {
          "$schema": "https://example.com/schemas/Market.json",
          "cryptoMarketConfig": {
            "$schema": "https://example.com/schemas/CryptoMarketConfig.json"
          },
          "tags": [
            {
              "$schema": "https://example.com/schemas/Tag.json"
            }
          ]
        }
      ],
      "series": [
        {
          "$schema": "https://example.com/schemas/Series.json"
        }
      ],
      "sport": {
        "$schema": "https://example.com/schemas/SportsMetadata.json",
        "externalPartners": [
          {
            "$schema": "https://example.com/schemas/SportExternalPartnerMapping.json",
            "partner": {
              "$schema": "https://example.com/schemas/Partner.json"
            }
          }
        ]
      },
      "tags": [
        {
          "$schema": "https://example.com/schemas/Tag.json"
        }
      ],
      "teams": [
        {
          "$schema": "https://example.com/schemas/Team.json",
          "externalPartners": [
            {
              "$schema": "https://example.com/schemas/TeamExternalPartnerMapping.json",
              "partner": {
                "$schema": "https://example.com/schemas/Partner.json"
              }
            }
          ]
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.