> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # List Polymarket user positions (https://www.socialfetch.dev/docs/api/v1/polymarket/users/wallet/positions/get) ## Summary List a wallet's open, closed and redeemable Polymarket positions with profit. **Tags:** `Polymarket` ## HTTP - **Method:** GET - **Path:** `/v1/polymarket/users/{wallet}/positions` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.polymarket.listUserPositions({ wallet: "0x93abbc022ce98d6f45d4444b594791cc4b7a9723", status: "open", limit: 10 })` - **Accepted identifiers:** `wallet` (path) - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `wallet` (path) - **Required:** yes - **Constraints:** type `string`; pattern: `^0x[0-9a-fA-F]{40}$` - **Description:** Wallet address: 0x followed by 40 hex digits. ### `status` (query) - **Required:** no - **Constraints:** type `string`; enum: open, closed, redeemable, mergeable - **Description:** Which positions to list. Default: `open`. ### `sort` (query) - **Required:** no - **Constraints:** type `string`; enum: currentValue, totalPnl, realizedPnl, unrealizedPnl, tokens, price - **Description:** Sort field, largest first. Default: `currentValue`. ### `eventId` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^\d{1,10}$` - **Description:** Only positions in this event. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 1000 - **Description:** Items per page, 1–1000. Default: 50. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 6000 - **Description:** Pass `page.nextCursor` from the previous response to get the next page. Keep the other filters the same. ## Pagination This endpoint uses **cursor-based pagination** via the `cursor` query parameter. - Read **hasMore** from `data.page.hasMore`. - When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string). - Omit `cursor` on the **first** request. - Stop when **hasMore** is `false` or **nextCursor** is null (end of list). ## Responses (status codes) - **200**: Polymarket user positions. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Polymarket user positions. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `found` on success. A wallet with no positions, or one that does not exist, returns an empty list. - **wallet** (required) — type `string`. The wallet asked for. - **positions** (required) — type `array`. Positions. - _items:_ - **tokenId** (required) — type `string`; nullable. Outcome token id. - **conditionId** (required) — type `string`; nullable. Condition id of the market. - **market** (required) — type `object`. The market the position is in. - **outcome** (required) — type `string`; nullable. Outcome held. - **outcomeIndex** (required) — type `integer`; nullable. Position of the outcome in the market. - **oppositeOutcome** (required) — type `string`; nullable. The other outcome. - **oppositeTokenId** (required) — type `string`; nullable. Token id of the other outcome. - **status** (required) — type `string`; nullable. `OPEN`, `CLOSED`, `REDEEMABLE` or `MERGEABLE`. - **shares** (required). Shares held now. A number, or an exact decimal string when the value has more digits than a number can hold. - **totalShares** (required). Shares ever bought. A number, or an exact decimal string when the value has more digits than a number can hold. - **averagePrice** (required) — type `number`; nullable. Average entry price. - **entryCost** (required). Dollars paid for the shares held. A number, or an exact decimal string when the value has more digits than a number can hold. - **entryFees** (required). Fees paid when the shares were bought, in dollars. A number, or an exact decimal string when the value has more digits than a number can hold. - **totalCost** (required). Entry cost plus entry fees, in dollars. A number, or an exact decimal string when the value has more digits than a number can hold. - **currentPrice** (required) — type `number`; nullable. Current price of the outcome. - **currentValue** (required). Current value in dollars. A number, or an exact decimal string when the value has more digits than a number can hold. - **realizedPnl** (required). Profit already taken. A number, or an exact decimal string when the value has more digits than a number can hold. - **unrealizedPnl** (required). Profit on paper. A number, or an exact decimal string when the value has more digits than a number can hold. - **totalPnl** (required). Realized plus unrealized profit. A number, or an exact decimal string when the value has more digits than a number can hold. - **percentPnl** (required) — type `number`; nullable. Total profit as a percent of cost. - **percentRealizedPnl** (required) — type `number`; nullable. Realized profit as a percent of cost. - **archived** (required) — type `boolean`; nullable. Whether Polymarket archived the market. - **redeemable** (required) — type `boolean`; nullable. Whether the position can be redeemed. - **mergeable** (required) — type `boolean`; nullable. Whether the position can be merged. - **negRisk** (required) — type `boolean`; nullable. Whether the market is a winner-takes-all group. - **firstEntryAt** (required) — type `string`; nullable. When the position was opened (ISO-8601, UTC). - **lastActivityAt** (required) — type `string`; nullable. When the position last changed (ISO-8601, UTC). - **page** (required) — type `object`. Pagination state for the current page. - **hasMore** (required) — type `boolean`. Whether another page is available. - **nextCursor** (required) — type `string`; nullable. Cursor to pass in the next request when more pages exist; null on the last page. - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "wallet": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "positions": [ { "tokenId": "42699080635179861375280720242213672850141860123562672932351602811041149946128", "conditionId": "0xcd1b6b71a1964f15e2c14809594cbfa0d576270e8ef94c8c24913121097e09e5", "market": { "title": "Will Donald Trump win the popular vote in the 2024 Presidential Election?", "slug": "will-donald-trump-win-the-popular-vote-in-the-2024-presidential-election", "eventSlug": "presidential-election-popular-vote-winner-2024", "icon": "https://polymarket-upload.s3.us-east-2.amazonaws.com/will-donald-trump-win-the-popular-vote-in-the-2024-presidential-election-20e4382f-7bc6-4d9b-aecc-d5f857dc3802.png", "eventId": "903216", "endDate": "2024-11-05" }, "outcome": "Yes", "outcomeIndex": 0, "oppositeOutcome": "No", "oppositeTokenId": "52646153159016006621189163812433115969858888637703551736022048114666679879653", "status": "CLOSED", "shares": 0, "totalShares": 13175255.227, "averagePrice": 0.3695, "entryCost": 0, "entryFees": 0, "totalCost": 0, "currentPrice": 1, "currentValue": 0, "realizedPnl": 8303171.2313, "unrealizedPnl": 0, "totalPnl": 8303171.2313, "percentPnl": 0, "percentRealizedPnl": 170.5559, "archived": false, "redeemable": false, "mergeable": false, "negRisk": true, "firstEntryAt": "2024-10-14T15:15:52.000Z", "lastActivityAt": "2024-11-12T14:57:05.000Z" } ], "page": { "hasMore": true, "nextCursor": "eyJvIjoicG9seW1hcmtldC51c2VyLnBvc2l0aW9ucy5saXN0IiwiYyI6ImV5SmtZWFJoSWpwN0luUjVjR1VpT2lKd2IzTnBkR2x2Ym5NaUxDSndZWEpoYlhNaU9uc2liQ0k2TWl3aVpDSTZNaXdpYXlJNklqWXdOakV4TkRBdU1UZ3dORFk0TURBd01EQXdJaXdpZENJNklqUXpPRGs0TURFNU1UZzRORFF6TVRBNU1qVTBOVFEwTURFeE5qUTBNVFF4TURrMU56UTRNekkzTkRNek9UUTNNek0yTXpJMk5UWTFNakl3T0RZeE5EQTV…" } }, "meta": { "requestId": "req_91cfb424-6616-4b5b-ac1b-a5117e70a4ad", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.polymarket.listUserPositions({ wallet: "0x93abbc022ce98d6f45d4444b594791cc4b7a9723", status: "open", limit: 10, }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/polymarket/users/0x93abbc022ce98d6f45d4444b594791cc4b7a9723/positions?status=open&limit=10", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/polymarket/users/0x93abbc022ce98d6f45d4444b594791cc4b7a9723/positions?status=open&limit=10" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/polymarket/users/0x93abbc022ce98d6f45d4444b594791cc4b7a9723/positions?status=open&limit=10", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: next page (pagination) After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string): ```javascript const previous = await response.json(); const nextCursor = previous?.data?.page?.nextCursor; const hasMore = previous?.data?.page?.hasMore; if (!hasMore || nextCursor == null) { // no more pages } else { const nextUrl = new URL("https://api.socialfetch.dev/v1/polymarket/users/value/positions"); nextUrl.searchParams.set("cursor", nextCursor); // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest"); const nextResponse = await fetch(nextUrl.toString(), { headers: { "x-api-key": "YOUR_API_KEY" }, }); const nextData = await nextResponse.json(); } ```