{ "openapi": "3.0.1", "info": { "title": "Brazil Investment Fund Returns (Fundos CVM)", "description": "Ready-made performance metrics for Brazilian investment funds from CVM open data: period, YTD and 12-month return, volatility, max drawdown, net assets, net inflows, shareholders and % of CDI.", "version": "0.1", "x-build-id": "hfDS1Pwd3LV6yApVe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/br_data_hub~br-cvm-fund-performance/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-br_data_hub-br-cvm-fund-performance", "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/br_data_hub~br-cvm-fund-performance/runs": { "post": { "operationId": "runs-sync-br_data_hub-br-cvm-fund-performance", "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/br_data_hub~br-cvm-fund-performance/run-sync": { "post": { "operationId": "run-sync-br_data_hub-br-cvm-fund-performance", "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": { "fundNameContains": { "title": "Fund name contains", "type": "string", "description": "Type part of a fund or class name, e.g. TESOURO SELIC (case and accents ignored). The largest funds by net assets come first, up to 'Max funds from filters'.", "default": "TESOURO SELIC" }, "cnpjs": { "title": "Fund CNPJs", "type": "array", "description": "Enter fund or class CNPJs, one per line, with or without punctuation (numeric or the new alphanumeric format). A fund with classes under CVM Resolution 175 returns one result per class (and per subclass).", "default": [], "items": { "type": "string" } }, "startDate": { "title": "Period start", "type": "string", "description": "Pick the first day of the analysis period (YYYY-MM-DD). Leave empty for 12 months before the period end." }, "endDate": { "title": "Period end", "type": "string", "description": "Pick the last day of the analysis period (YYYY-MM-DD). Leave empty for today; metrics use the last quota CVM published up to this date." }, "compareWithCdi": { "title": "Compare with CDI", "type": "boolean", "description": "Keep on to add the CDI accumulated over the same dates (Banco Central SGS series 12) and the fund return as % of CDI.", "default": true }, "classification": { "title": "Classification", "type": "string", "description": "Type a CVM or ANBIMA classification to filter the name search, e.g. Renda Fixa, Multimercado, Ações or Cambial. Leave empty for all." }, "fundTypes": { "title": "Fund types", "type": "array", "description": "Enter CVM fund types to filter the name or classification search, e.g. FIF, FI, FIC. Leave empty for all types.", "items": { "type": "string" } }, "maxFunds": { "title": "Max funds from filters", "minimum": 1, "maximum": 200, "type": "integer", "description": "Set how many fund classes to take from the name or classification filters, largest first, e.g. 3. CNPJs you list are always included.", "default": 3 }, "includeSubclasses": { "title": "Include subclasses", "type": "boolean", "description": "Keep on to return one result per share subclass (CVM Resolution 175) when the class reports by subclass. Turn off for class-level results only (classes that report only by subclass are still returned).", "default": true }, "includeCancelled": { "title": "Include cancelled funds", "type": "boolean", "description": "Turn on to let the name and classification filters match cancelled funds and classes too, useful for historical periods.", "default": false } } }, "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 } } } } } } } } } }