{ "openapi": "3.0.1", "info": { "title": "CFPB Complaint Search — By Company, Product & State", "description": "Search the CFPB consumer complaint database with 5M+ complaints. Filter by company, product, state, date range, and keyword. Extract complaint details, company responses, and consumer narratives. Free US government data, no API key required.", "version": "1.1", "x-build-id": "vk9qojgIuualdaN6j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ryanclinton~cfpb-consumer-complaints/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ryanclinton-cfpb-consumer-complaints", "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/ryanclinton~cfpb-consumer-complaints/runs": { "post": { "operationId": "runs-sync-ryanclinton-cfpb-consumer-complaints", "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/ryanclinton~cfpb-consumer-complaints/run-sync": { "post": { "operationId": "run-sync-ryanclinton-cfpb-consumer-complaints", "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": { "outputMode": { "title": "Output Mode", "enum": [ "records", "aggregation" ], "type": "string", "description": "How results are returned. 'records' returns one row per complaint (filterable by all parameters). 'aggregation' returns count buckets — e.g. top companies by complaint volume — using the field selected in 'Aggregate By'.", "default": "records" }, "aggregateBy": { "title": "Aggregate By (aggregation mode only)", "enum": [ "company", "product", "sub_product", "issue", "sub_issue", "state", "company_response", "submitted_via", "tags", "timely" ], "type": "string", "description": "Field to group complaints by when Output Mode is 'aggregation'. Returns one row per bucket with {term, count, share}. Ignored when Output Mode is 'records'.", "default": "company" }, "searchTerm": { "title": "Search Term", "type": "string", "description": "Keyword search across complaint narratives and fields (e.g., 'credit report', 'late fee', 'identity theft')." }, "company": { "title": "Company", "type": "string", "description": "Filter by company name (e.g., 'Bank of America', 'Wells Fargo', 'Equifax')." }, "product": { "title": "Product", "enum": [ "", "Credit reporting, credit repair services, or other personal consumer reports", "Debt collection", "Mortgage", "Credit card or prepaid card", "Checking or savings account", "Student loan", "Vehicle loan or lease", "Money transfer, virtual currency, or money service", "Payday loan, title loan, or personal loan", "Personal loan" ], "type": "string", "description": "Filter by financial product type." }, "state": { "title": "State", "type": "string", "description": "Filter by US state code (e.g., 'CA', 'NY', 'TX')." }, "dateFrom": { "title": "Date From", "type": "string", "description": "Start date for complaint received date range (YYYY-MM-DD format)." }, "dateTo": { "title": "Date To", "type": "string", "description": "End date for complaint received date range (YYYY-MM-DD format)." }, "sortBy": { "title": "Sort By (records mode only)", "enum": [ "created_date_desc", "created_date_asc", "relevance_desc", "relevance_asc" ], "type": "string", "description": "Sort order for results. Ignored in aggregation mode (buckets are always sorted by count, descending).", "default": "created_date_desc" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of complaint records to return (1–10000). In aggregation mode, this caps how many buckets are emitted.", "default": 50 }, "autoPaginate": { "title": "Auto-paginate to fetch all matching", "type": "boolean", "description": "When enabled and total matching complaints exceed Max Results (but stay under the 10,000 single-query cap), the actor fetches every matching record up to 10,000. Beyond 10,000 records, switch to aggregation mode or split your query by date range. Records mode only.", "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 } } }, "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 } } } } } } } } } }