{ "openapi": "3.0.1", "info": { "title": "OfferUp Scraper | US Marketplace Listings & Prices", "description": "Scrape public OfferUp US marketplace listings for titles, prices, locations, conditions, seller details, images, shipping availability, and listing URLs from keyword searches or filtered explore pages.", "version": "1.0", "x-build-id": "JhwvpRXmYOhJBZjH6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~offerup-us-marketplace-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-offerup-us-marketplace-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/muhammadafzal~offerup-us-marketplace-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-offerup-us-marketplace-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/muhammadafzal~offerup-us-marketplace-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-offerup-us-marketplace-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchQueries": { "title": "Search Keywords", "maxItems": 10, "type": "array", "description": "Use for public OfferUp keyword searches when you do not already have a filtered URL. Example: [\"iphone 15\", \"gaming chair\"]. Searches are routed through OfferUp explore URLs.", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "default": [ "iphone" ] }, "startUrls": { "title": "OfferUp Search URLs", "maxItems": 20, "type": "array", "description": "Optional public OfferUp explore/search URLs. Use this for category, price, condition, or location filters already applied on OfferUp.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "OfferUp URL", "description": "A public https://offerup.com/explore/... or other OfferUp listing/search URL.", "pattern": "^https://(www\\.)?offerup\\.com/" } }, "required": [ "url" ] } }, "maxResults": { "title": "Maximum Listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum unique listings to return and bill for. Use 1 for a low-cost canary; allowed range is 1–500.", "default": 50 }, "maxPagesPerQuery": { "title": "Maximum Pages per Search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum pagination depth per query or start URL. More pages use more requests.", "default": 3 }, "includeDetails": { "title": "Open Listing Details", "type": "boolean", "description": "Open each public listing page to enrich description, seller, condition, shipping, and image fields. This increases run time and request volume.", "default": false }, "maxRequestRetries": { "title": "Request Retries", "minimum": 0, "maximum": 4, "type": "integer", "description": "Bounded retries for transient page failures. Use 0–4; default is 2.", "default": 2 }, "proxyMode": { "title": "Network Route", "enum": [ "apify", "direct", "custom" ], "type": "string", "description": "Choose how OfferUp requests are routed. Use Apify US residential for normal runs (default), Direct only from a permitted US-compatible network, or Owner custom only when the Actor owner configured OFFERUP_PROXY_URL.", "default": "apify" }, "proxyConfig": { "title": "US Proxy Configuration", "type": "object", "description": "Configure Apify Proxy groups for the apify network route. The legacy useApifyProxy switch remains supported when proxyMode is omitted; proxyMode takes precedence.", "properties": { "useApifyProxy": { "type": "boolean", "title": "Use Apify Proxy", "description": "Route public requests through Apify Proxy.", "default": true }, "apifyProxyGroups": { "type": "array", "title": "Apify Proxy Groups", "description": "Proxy groups, such as RESIDENTIAL.", "items": { "type": "string" }, "default": [ "RESIDENTIAL" ] } }, "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }