{ "openapi": "3.0.1", "info": { "title": "ForexFactory Calendar Scraper - Economic Events API", "description": "Get the ForexFactory calendar as clean data: every economic release, speech and holiday with time in UTC, currency, impact, actual, forecast, previous and revision. Current week or history back to 2007, filtered by currency and impact, for traders, bots and fintech apps.", "version": "0.1", "x-build-id": "GchGb7hXeunMCg9jA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~forexfactory-calendar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-forexfactory-calendar", "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/s-r~forexfactory-calendar/runs": { "post": { "operationId": "runs-sync-s-r-forexfactory-calendar", "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/s-r~forexfactory-calendar/run-sync": { "post": { "operationId": "run-sync-s-r-forexfactory-calendar", "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", "custom" ], "type": "string", "description": "Period in timezone; weeks run Monday through Sunday. Use custom for date_from and date_to.", "default": "this_week" }, "date_from": { "title": "Date from", "type": "string", "description": "First local date, YYYY-MM-DD, on or after 2007-01-01. Required for period custom." }, "date_to": { "title": "Date to", "type": "string", "description": "Last local date, inclusive. Defaults to date_from. The period may contain at most 366 days." }, "currencies": { "title": "Currencies", "type": "array", "description": "Currencies to include: USD, EUR, GBP, JPY, AUD, CAD, CHF, NZD, CNY, ALL. Case insensitive; empty means all. ALL selects worldwide events.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "ISO country codes (including EU), or ForexFactory aliases UK, JN, EZ, GE, SZ, SP, WW. CH means Switzerland; CN or FF:CH means China. Prefix any ForexFactory code with FF: to select its source meaning. Empty means all.", "items": { "type": "string" } }, "impacts": { "title": "Impacts", "type": "array", "description": "Impact levels: high, medium, low, holiday. Case insensitive; empty means all.", "items": { "type": "string" } }, "released_only": { "title": "Released only", "type": "boolean", "description": "Only return events with a nonempty actual value. Past speeches without a numeric release are excluded.", "default": false }, "keyword": { "title": "Keyword", "maxLength": 200, "type": "string", "description": "Case insensitive substring in the event title." }, "timezone": { "title": "Timezone", "maxLength": 100, "type": "string", "description": "IANA time zone used for local dates, period boundaries and time_local. Masked events retain their source date and have no exact timestamp.", "default": "UTC" }, "max_items": { "title": "Max items", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum delivered events across all cursor pages, after filters. Keep this value unchanged when continuing.", "default": 1000 }, "cursor": { "title": "Cursor", "minLength": 1, "maxLength": 4096, "type": "string", "description": "Opaque next_cursor from the previous response. Keep the original filters and max_items. Apify follows it automatically." } } }, "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 } } } } } } } } } }