{ "openapi": "3.0.1", "info": { "title": "Excel XLSX to JSON and CSV Converter", "description": "Convert Excel .xlsx workbooks to JSON rows keyed by the header row, plus a CSV per sheet. Use when you need spreadsheet data as JSON or CSV for code or an API.", "version": "0.0", "x-build-id": "iRePrAZ9pWBd4t1kU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plainpipe~xlsx-to-json/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plainpipe-xlsx-to-json", "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/plainpipe~xlsx-to-json/runs": { "post": { "operationId": "runs-sync-plainpipe-xlsx-to-json", "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/plainpipe~xlsx-to-json/run-sync": { "post": { "operationId": "run-sync-plainpipe-xlsx-to-json", "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": { "fileUrls": { "title": "Excel file URLs", "type": "array", "description": "Direct links to Excel .xlsx workbooks, one per line, e.g. https://raw.githubusercontent.com/pandas-dev/pandas/main/pandas/tests/io/data/excel/test1.xlsx. The link must return the file itself, not a web page that shows it.", "items": { "type": "string" } }, "excelFile": { "title": "Upload an Excel file (optional)", "type": "string", "description": "Or upload one .xlsx workbook here instead of (or in addition to) giving URLs. Example: a sales-report.xlsx from your computer." }, "sheets": { "title": "Sheets", "type": "array", "description": "Names of the sheets to convert, not case sensitive, e.g. Sheet1 or Orders. Leave empty (default) to convert every sheet.", "items": { "type": "string" } }, "headerRow": { "title": "Header row", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Row number that holds the column names (default 1 = first row), e.g. 3 when the sheet starts with a title block. Rows above it are ignored. Use 0 when the sheet has no header row; columns are then named column_A, column_B and so on.", "default": 1 }, "skipEmptyRows": { "title": "Skip empty rows", "type": "boolean", "description": "On (default): leave out rows where every cell is empty. Skipped rows are not returned and not charged.", "default": true }, "dateFormat": { "title": "Date format", "enum": [ "iso", "raw" ], "type": "string", "description": "iso (default): dates as ISO 8601 text, e.g. 2024-05-31 or 2024-05-31T14:30:00Z. raw: dates as Excel serial numbers (days since 1899-12-30), e.g. 45443.", "default": "iso" }, "rawValues": { "title": "Keep value types", "type": "boolean", "description": "On (default): numbers stay numbers and TRUE/FALSE stay booleans, e.g. 0.98. Off: every cell value is returned as text, e.g. \"0.98\". Formulas always return their last calculated result.", "default": true }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many spreadsheet rows in total across all files and sheets (default 100, e.g. 50000 for a large sheet). You are charged per returned row.", "default": 100 } } }, "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 } } } } } } } } } }