{ "openapi": "3.0.1", "info": { "title": "FDIC BankFind Scraper for Financial Data", "description": "Retrieve current FDIC BankFind records for U.S. banks and thrifts in one run. Choose institution searches, certificate or quarterly financial records, failures, branches, structure events, or industry summaries. Get normalized rows with financial data and an FDIC source URL.", "version": "0.0", "x-build-id": "2OhqDHYxq3tGH7DFL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~fdic-bankfind/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-fdic-bankfind", "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/maximedupre~fdic-bankfind/runs": { "post": { "operationId": "runs-sync-maximedupre-fdic-bankfind", "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/maximedupre~fdic-bankfind/run-sync": { "post": { "operationId": "run-sync-maximedupre-fdic-bankfind", "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", "required": [ "target" ], "properties": { "target": { "title": "Target", "enum": [ "institutionSearch", "certificateLookup", "quarterlyFinancialRecords", "bankFailures", "branchLocations", "institutionStructureHistory", "industrySummaries" ], "type": "string", "description": "Choose the FDIC data target for this run." }, "institutionName": { "title": "Institution name", "type": "string", "description": "For Institution search, enter all or part of an institution name." }, "activeOnly": { "title": "Active institutions only", "type": "boolean", "description": "For Institution search, leave this on to return active institutions only. Turn it off to include inactive and historical institutions.", "default": true }, "minimumAssets": { "title": "Minimum total assets", "minimum": 0, "type": "number", "description": "For Institution search. Return institutions with total assets at or above this amount in USD." }, "maximumAssets": { "title": "Maximum total assets", "minimum": 0, "type": "number", "description": "For Institution search. Return institutions with total assets at or below this amount in USD." }, "primaryRegulators": { "title": "Primary regulators", "type": "array", "description": "For Institution search, enter one or more primary regulator names to include.", "items": { "type": "string" } }, "resultOrder": { "title": "Result order", "enum": [ "institutionName", "totalAssets", "totalDeposits", "netIncome", "returnOnAssets", "returnOnEquity" ], "type": "string", "description": "For Institution search. Sort results by institution name, total assets, total deposits, net income, return on assets, or return on equity.", "default": "institutionName" }, "certificateId": { "title": "FDIC certificate ID", "minimum": 1, "type": "integer", "description": "For Certificate lookup and Quarterly financial records, enter one FDIC certificate ID." }, "reportingPeriod": { "title": "Reporting period", "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "For Quarterly financial records and Industry summaries, enter a reporting date such as 2024-12-31." }, "statesOrTerritories": { "title": "States or territories", "type": "array", "description": "For Institution search, Bank failures, Branch locations, and Industry summaries, enter one or more US states or territories to include. Other targets ignore this field.", "items": { "type": "string" } }, "charterClasses": { "title": "Charter classifications", "type": "array", "description": "For Institution search and Industry summaries, enter one or more charter classifications to include. Other targets ignore this field.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum items", "minimum": 1, "type": "integer", "description": "Stop after this many returned items. For Certificate lookup, this also limits quarterly financial periods. Leave it empty to get all available results until the source is exhausted." } } }, "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 } } }, "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 } } } } } } } } } }