{ "openapi": "3.0.1", "info": { "title": "CFPB Consumer Complaints — Vendor Risk & Due Diligence", "description": "US Consumer Financial Protection Bureau Consumer Complaint Database — 18M+ complaints since 2011. Search by company, product, state, date. Public domain.", "version": "0.1", "x-build-id": "8mqaujg0g8se6WZ0j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devone-studio~cfpb-consumer-complaints-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devone-studio-cfpb-consumer-complaints-api", "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/devone-studio~cfpb-consumer-complaints-api/runs": { "post": { "operationId": "runs-sync-devone-studio-cfpb-consumer-complaints-api", "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/devone-studio~cfpb-consumer-complaints-api/run-sync": { "post": { "operationId": "run-sync-devone-studio-cfpb-consumer-complaints-api", "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": { "search_term": { "title": "Free-text search (matches company/product/issue)", "type": "string", "description": "Free-text search term (matches across multiple fields). Empty = no filter.", "default": "" }, "state": { "title": "State (2-letter, e.g. 'CA')", "type": "string", "description": "Filter by US state (2-letter code).", "default": "" }, "zip_code": { "title": "ZIP code (5-digit)", "type": "string", "description": "Filter by 5-digit ZIP code.", "default": "" }, "product": { "title": "Product (e.g. 'Mortgage', 'Credit card')", "type": "string", "description": "Filter by product category.", "default": "" }, "sub_product": { "title": "Sub-product (e.g. 'Conventional fixed mortgage')", "type": "string", "description": "Filter by sub-product.", "default": "" }, "issue": { "title": "Issue (e.g. 'Application, originator, mortgage broker')", "type": "string", "description": "Filter by issue.", "default": "" }, "company": { "title": "Company (e.g. 'EQUIFAX, INC.')", "type": "string", "description": "Filter by company (exact match, uppercase).", "default": "" }, "timely": { "title": "Timely response", "enum": [ "", "Yes", "No" ], "type": "string", "description": "Filter by timely flag: 'Yes' or 'No'.", "default": "" }, "company_response": { "title": "Company response", "type": "string", "description": "Filter by company response (e.g. 'Closed with explanation').", "default": "" }, "submitted_via": { "title": "Submitted via", "type": "string", "description": "Filter by submission channel: 'Web', 'Phone', 'Referral', etc.", "default": "" }, "tag": { "title": "Tag (e.g. 'Older American', 'Servicemember')", "type": "string", "description": "Filter by demographic tag.", "default": "" }, "date_received_min": { "title": "Date received >= (YYYY-MM-DD)", "type": "string", "description": "Filter complaints received on or after this date.", "default": "" }, "date_received_max": { "title": "Date received <= (YYYY-MM-DD)", "type": "string", "description": "Filter complaints received on or before this date.", "default": "" }, "sort_by": { "title": "Sort field", "enum": [ "date_received_desc", "date_received_asc", "date_sent_to_company_desc", "date_sent_to_company_asc", "complaint_id_desc", "complaint_id_asc" ], "type": "string", "description": "date_received_desc, date_received_asc, complaint_id_desc.", "default": "date_received_desc" }, "max_results": { "title": "Maximum results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cap on returned rows (1-200).", "default": 50 }, "include_derived": { "title": "Include derived fields (response_time_hours, is_resolved)", "type": "boolean", "description": "Add per-row derived fields.", "default": true }, "include_metadata": { "title": "Include response metadata (timing, source URL, row counts)", "type": "boolean", "description": "Prepend a `_meta: true` row with run metadata.", "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 } } } } } } } } } }