{ "openapi": "3.0.1", "info": { "title": "Consumer Complaints Scraper (CFPB)", "description": "Search the US government's Consumer Financial Protection Bureau complaint database: complaints against banks, lenders and fintechs by company, product, issue, state and date, with the consumer narrative and company response. Monitor mode for new complaints. No API key.", "version": "0.1", "x-build-id": "SrdZpOdWdvWvta9m1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemint~cfpb-complaints-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemint-cfpb-complaints-scraper", "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/scrapemint~cfpb-complaints-scraper/runs": { "post": { "operationId": "runs-sync-scrapemint-cfpb-complaints-scraper", "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/scrapemint~cfpb-complaints-scraper/run-sync": { "post": { "operationId": "run-sync-scrapemint-cfpb-complaints-scraper", "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": { "companies": { "title": "Companies", "type": "array", "description": "Companies to pull complaints for, one per line, as the CFPB spells them (\"WELLS FARGO & COMPANY\", \"CAPITAL ONE FINANCIAL CORPORATION\"). Matched exactly. If a company returns nothing, try a keyword under Search terms instead.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Free-text searches across complaints, one per line (\"zelle scam\", \"overdraft fee\"). Use these when you do not know a company's exact name or want an issue across companies.", "items": { "type": "string" } }, "product": { "title": "Product", "enum": [ "", "Checking or savings account", "Credit card", "Credit reporting or other personal consumer reports", "Debt collection", "Mortgage", "Money transfer, virtual currency, or money service", "Payday loan, title loan, or personal loan", "Vehicle loan or lease", "Student loan", "Prepaid card" ], "type": "string", "description": "Limit to one product type (applied to every company and search). Leave empty for all." }, "state": { "title": "State", "type": "string", "description": "Limit to one US state by two-letter code (\"CA\", \"NY\"). Leave empty for nationwide." }, "sinceDays": { "title": "Received within (days)", "minimum": 0, "maximum": 7300, "type": "integer", "description": "Only complaints received in the last N days. 0 = no date limit (goes back through history as far as the row cap allows).", "default": 90 }, "withNarrativeOnly": { "title": "Only complaints with a narrative", "type": "boolean", "description": "Only complaints where the consumer wrote a description of what happened (the most useful ones). About a third of complaints have a published narrative.", "default": false }, "includeNarrativeText": { "title": "Include narrative text", "type": "boolean", "description": "Include the full consumer narrative in each row. Turn off for smaller rows when you only need the structured fields.", "default": true }, "newOnly": { "title": "Monitor mode: new complaints only", "type": "boolean", "description": "Remember complaints already returned and emit only ones not seen before. Run on a schedule for a clean feed of new complaints - quiet runs cost nothing.", "default": false }, "maxPerQuery": { "title": "Complaints per company or search", "minimum": 1, "maximum": 20000, "type": "integer", "description": "How many complaints to return per company or search term, newest first.", "default": 100 }, "maxRows": { "title": "Max rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows in total.", "default": 2000 } } }, "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 } } } } } } } } } }