{ "openapi": "3.0.1", "info": { "title": "Financial Calculator API (Loans, NPV/IRR, Bonds, Options)", "description": "Loans and mortgages with amortization, savings goals, NPV, IRR and XIRR, bond yield and duration, option Greeks and implied volatility, depreciation and APR/APY, from one line.", "version": "0.1", "x-build-id": "K6SDDQQX41ZH9nhEg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jumblemog~financial-calculator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jumblemog-financial-calculator", "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/jumblemog~financial-calculator/runs": { "post": { "operationId": "runs-sync-jumblemog-financial-calculator", "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/jumblemog~financial-calculator/run-sync": { "post": { "operationId": "run-sync-jumblemog-financial-calculator", "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": { "requests": { "title": "Requests", "type": "array", "description": "One calculation per entry, as a line of text or an object. Loans: '$25,000 car loan at 7.9% for 60 months', '$400k home 20% down 6.5% 30 years, tax 1.2%, insurance $1,500 a year, PMI 0.5%', '$200 extra a month', 'balance after 5 years', '1 point and $4,000 closing costs' (APR), 'how much can I borrow paying $2,000 a month at 6% for 30 years'. Savings: 'save $500 a month for 30 years at 7%', 'how much a month to reach $1,000,000 in 25 years at 6%', 'CAGR from $10,000 to $25,000 over 7 years', '$1,000,000 at 5% withdrawing $60,000 a year, how long'. Cash flows: 'NPV and IRR at 8% of -10000, 3000, 4200, 6800', 'xirr 2024-01-01 -10000, 2025-03-15 12000'. Bonds: '5% coupon bond, 10 years, yield 6%' or 'price 95', 'callable in 3 years at 101'. Options: 'call S=100 K=105 30 days vol 25% r 4%', 'american put ...', 'implied vol of a call priced 4.2 ...'. Depreciation: 'MACRS 7 year on $120,000', 'double declining $50,000, $5,000 salvage, 5 years'. Rates: '6% APR compounded monthly to APY'. Objects take type (loan, savings, cashflows, bond, option, depreciation, rate) and that type's fields, e.g. {\"type\": \"loan\", \"principal\": 250000, \"ratePct\": 6, \"years\": 15}; see the README for every field." }, "currency": { "title": "Currency symbol", "type": "string", "description": "Shown before amounts when a request doesn't use a symbol ($ by default; e.g. €, £)." }, "riskFreePct": { "title": "Risk-free rate (%)", "minimum": -10, "maximum": 100, "type": "number", "description": "For options when a request doesn't give one (4% by default)." }, "charts": { "title": "Draw a chart", "type": "boolean", "description": "A loan's yearly principal, interest and balance; savings growth; cash flows; a bond's price-yield curve; an option's value against the stock; a depreciation schedule.", "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 } } } } } } } } } }