{ "openapi": "3.0.1", "info": { "title": "Trader Calendar (forexfactory.com)", "description": "Scrape the Forex Factory economic calendar: NFP, CPI, GDP, PMI, rate decisions and more. Get actual, forecast and previous values, impact level and a better/worse-than-forecast signal. Filter by date range, currency, impact and keyword in any time zone. Export JSON, CSV, Excel or use the API.", "version": "1.0", "x-build-id": "NLgbg1Hx0GKMmLXho" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pintostudio~trader-calendar-forexfactory-com/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pintostudio-trader-calendar-forexfactory-com", "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/pintostudio~trader-calendar-forexfactory-com/runs": { "post": { "operationId": "runs-sync-pintostudio-trader-calendar-forexfactory-com", "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/pintostudio~trader-calendar-forexfactory-com/run-sync": { "post": { "operationId": "run-sync-pintostudio-trader-calendar-forexfactory-com", "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": { "period": { "title": "Period", "enum": [ "today", "tomorrow", "yesterday", "this_week", "next_week", "last_week", "this_month", "next_month", "last_month", "specific_day", "specific_week", "specific_month", "custom_range" ], "type": "string", "description": "Which days to scrape. Choose a ready-made period, or one of the 'Specific…' / 'Custom range' options and fill in the matching date field below.", "default": "this_week" }, "date": { "title": "Date", "type": "string", "description": "Used when Period is 'Specific day' or 'Specific week'. Format YYYY-MM-DD. For a week, any day inside it works (weeks run Sunday → Saturday)." }, "month": { "title": "Month", "pattern": "^\\d{4}-\\d{2}$", "type": "string", "description": "Used when Period is 'Specific month'. Format YYYY-MM, e.g. 2026-11." }, "startDate": { "title": "Start date", "type": "string", "description": "Used when Period is 'Custom range'. Format YYYY-MM-DD." }, "endDate": { "title": "End date", "type": "string", "description": "Used when Period is 'Custom range'. Format YYYY-MM-DD. Ranges of up to 731 days (~2 years) are supported." }, "currencies": { "title": "Currencies", "type": "array", "description": "Only keep events for these currencies. Leave empty for all. 'ALL' = global events such as OPEC meetings.", "items": { "type": "string", "enum": [ "USD", "EUR", "GBP", "JPY", "AUD", "NZD", "CAD", "CHF", "CNY", "ALL" ], "enumTitles": [ "USD – US dollar", "EUR – Euro", "GBP – British pound", "JPY – Japanese yen", "AUD – Australian dollar", "NZD – New Zealand dollar", "CAD – Canadian dollar", "CHF – Swiss franc", "CNY – Chinese yuan", "ALL – Global events" ] } }, "impacts": { "title": "Impact", "type": "array", "description": "Only keep events with these impact levels. Leave empty for all.", "items": { "type": "string", "enum": [ "high", "medium", "low", "holiday" ], "enumTitles": [ "🔴 High", "🟠 Medium", "🟡 Low", "⚪ Holiday / non-economic" ] } }, "search": { "title": "Search in title", "maxLength": 60, "type": "string", "description": "Only keep events whose title contains this text (case-insensitive), e.g. 'CPI', 'Non-Farm', 'Rate'." }, "timezone": { "title": "Time zone", "type": "string", "description": "IANA time zone used for the 'date' and 'time' fields, e.g. UTC, America/New_York, Europe/London, Asia/Tokyo.", "default": "UTC" }, "includeRaw": { "title": "Include raw data", "type": "boolean", "description": "Add a 'raw' object to each event with every original field from ForexFactory.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The Actor works without a proxy in most cases. Enable a proxy only if you see blocked requests.", "default": { "useApifyProxy": false } }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a failed page request before switching to the fallback method.", "default": 2 } } }, "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 } } } } } } } } } }