{ "openapi": "3.0.1", "info": { "title": "XFree Video Downloader", "description": "Downloads the video files (.mp4) of xfree.com searches, profiles, tags and video pages into your Apify storage, named creator_video-id.mp4, with the creator and OnlyFans link in the row. Optional ZIP of all files and optional full details (tags, views, likes).", "version": "0.3", "x-build-id": "N0kXfU7NSJ6r6YmW4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datawatcher~xfree-video-downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datawatcher-xfree-video-downloader", "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/datawatcher~xfree-video-downloader/runs": { "post": { "operationId": "runs-sync-datawatcher-xfree-video-downloader", "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/datawatcher~xfree-video-downloader/run-sync": { "post": { "operationId": "run-sync-datawatcher-xfree-video-downloader", "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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Site URLs of any supported kind: search, account profile, tag or video page. The kind is found from the URL. xfree.com URLs only: https://www.xfree.com/search?q=..., https://www.xfree.com/, https://www.xfree.com/tag/, https://www.xfree.com/video?id=...", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Searches, each {\"query\": \"...\", \"filter\": \"all\" | \"post\" | \"tag\"} (filter optional, default \"all\"). A plain text line is read as {\"query\": text, \"filter\": \"all\"}. \"post\" and \"tag\" are the site's own search tabs (&f=post, &f=tag)." }, "usernames": { "title": "Usernames", "type": "array", "description": "Account handles, with or without \"@\", or profile URLs. Every video of each account.", "items": { "type": "string" } }, "tags": { "title": "Tags", "type": "array", "description": "Tag names exactly as the site writes them (case and prefixes kept, e.g. pl-Amatorzy), or tag page URLs.", "items": { "type": "string" } }, "tagSort": { "title": "Tag sort", "enum": [ "latest", "popular" ], "type": "string", "description": "The order of tag pages. Empty - the site's default order." }, "videoUrls": { "title": "Video URLs", "type": "array", "description": "Video page URLs. Each is read directly; one row per video.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of videos returned, in total. Shared fairly over the inputs (each search, profile, tag or video URL gets its part; what one cannot fill goes to the others). Free plan Apify users get at most 1000 videos per run, whatever is set here (paying users have no cap).", "default": 100 }, "maxRequests": { "title": "Max requests", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of page requests the run makes, in total (listing pages and load-more steps; a direct video URL is one request).", "default": 200 }, "maxPagesPerSource": { "title": "Max pages per source", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of listing pages read for one search, profile or tag.", "default": 100 }, "maxScrollsPerPage": { "title": "Max scrolls per page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of \"Show more\" / load-more steps on one listing page.", "default": 100 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries of a request that failed on a network error or a server error. A block (403, 429, a challenge page) is never retried.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Time limit of one page request.", "default": 30 }, "extractDetails": { "title": "Extract details", "type": "boolean", "description": "false (default): a short row, files first (id, url, title, creator, duration, size, `storedFile`, dates). true: the full row of the links actor (views, likes, tags, tagged accounts, links ...) plus `storedFile`.", "default": false }, "videoQuality": { "title": "Video quality", "enum": [ "best", "preview" ], "type": "string", "description": "Which file to save. \"best\" is the full-quality .mp4 (`videoFileUrl`), \"preview\" the smaller copy (`previewVideoUrl`).", "default": "best" }, "maxFileSizeMb": { "title": "Max file size (MB)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "A video bigger than this is not saved (its `storedFile.status` is \"skipped\"); its row is still written.", "default": 250 }, "maxTotalDownloadMb": { "title": "Max total download (MB)", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stops saving files when the files of this run together reach this size (the rest are \"skipped\"); rows are still written.", "default": 1024 }, "createZip": { "title": "Create ZIP", "type": "boolean", "description": "Also put all saved files into one `videos.zip` in the Key-Value Store (needs disk space for the whole archive).", "default": false } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }