{ "openapi": "3.0.1", "info": { "title": "Cash and FX Position - Bank Balances, FX Exposure, Liquidity", "description": "Turn bank balances, time deposits, funds and FX debts into one cash and FX position: total and available cash, 30-day liquidity coverage, net FX position per currency, FX sensitivity, maturity calendar and warnings. No investment advice. HTML, PDF, Excel, JSON.", "version": "1.0", "x-build-id": "lqqsYWf8GVbTCtoVo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bloom-consulting~cash-fx-position/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bloom-consulting-cash-fx-position", "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/bloom-consulting~cash-fx-position/runs": { "post": { "operationId": "runs-sync-bloom-consulting-cash-fx-position", "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/bloom-consulting~cash-fx-position/run-sync": { "post": { "operationId": "run-sync-bloom-consulting-cash-fx-position", "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": { "useSampleData": { "title": "Run with sample data", "type": "boolean", "description": "Ignore the fields below and run on a built-in example company (food distributor, 5 banks, TRY/USD/EUR, a fund, a blocked deposit, FX debts). Use this first to see the report. Output produced this way is stamped DEMO.", "default": false }, "treasuryInput": { "title": "Treasury data", "type": "object", "description": "accounts: one row per account with bank, account, type (current | deposit | fund | cash | gold | other), currency (TRY, USD, EUR...), balance (the closing balance on the statement, not a sum of transactions). Deposits: maturity, interestRate (annual %), startDate. Funds: fundCode, units, unitPrice, priceDate, settlementDays. Set blocked: true for pledged or collateral amounts. rates: TRY value of 1 unit of each currency, with source and date (or tick Fetch CBRT rates). fxLiabilities and fxReceivables: item, currency, amount, due. paymentsNext30Days: total TRY outflows expected in the next 30 days. reportDate defaults to today. English and Turkish field names are both accepted." }, "inputFileUrl": { "title": "Input file URL (JSON)", "type": "string", "description": "Alternative to the field above: a public http(s) URL of a JSON file with the same data. Used only when \"Treasury data\" is empty." }, "fetchCbrtRates": { "title": "Fetch CBRT rates", "type": "boolean", "description": "Read today's Central Bank of the Republic of Turkey FX buying rates (today.xml) and use them for the currencies in your data. Only the rates are read; none of your data is sent anywhere.", "default": false }, "previousDataUrl": { "title": "Previous run data URL (optional)", "type": "string", "description": "The data.json record of an earlier run (its key-value store URL). The report then splits the change in total cash into FX effect and balance effect." }, "companyName": { "title": "Company name", "type": "string", "description": "Overrides the company name inside the data. Leave empty to keep it." }, "language": { "title": "Report language", "enum": [ "en", "tr" ], "type": "string", "description": "Language of the position card, report, PDF and spreadsheet.", "default": "en" }, "generatePdf": { "title": "Generate PDF", "type": "boolean", "description": "Print the report to an A4 PDF with headless Chromium. Turn off for a faster, cheaper run.", "default": true } } }, "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 } } } } } } } } } }