{ "openapi": "3.0.1", "info": { "title": "FINRA Arbitration Awards Scraper", "description": "Search FINRA's Arbitration Awards Online archive of 66,000+ securities arbitration awards from 1988 on, with parties, arbitrators, damages, fees and expungement findings parsed from the award PDFs.", "version": "0.0", "x-build-id": "zXz4WmuQATkuXOqvO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~finra-arbitration-awards-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-finra-arbitration-awards-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/parseforge~finra-arbitration-awards-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-finra-arbitration-awards-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/parseforge~finra-arbitration-awards-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-finra-arbitration-awards-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Words or phrases that must appear in the award, for example \"churning\", \"Rule 12206\" or a firm name. Every hit is checked against the award document before it is returned or charged, so a row always contains the term. Set Awards from and Awards to and the Actor downloads every award in that range and keeps the matches (best recall; about 1,400 awards fit in the default 20-minute timeout, up to 4,000 per run with a longer timeout). Without a date range FINRA's own index supplies the candidates, and for awards issued by FINRA (July 2007 onwards) that index only knows the parties, arbitrators and case number. Each term is searched separately; quotes are ignored. Leave empty to browse awards by date.", "items": { "type": "string" } }, "caseIds": { "title": "Case numbers", "type": "array", "description": "Exact FINRA case numbers, for example 24-00627, 09-06787 or 1994-004242. Every document filed under the case (award, orders, motions) is returned.", "items": { "type": "string" } }, "startUrls": { "title": "Award or search URLs", "type": "array", "description": "Paste an Arbitration Awards Online search URL (the filters in the URL are read and applied) or a direct award PDF link from data-portal.finra.org.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: limited to 10 items (preview). Paid users: up to 1,000,000." }, "dateFrom": { "title": "Awards from", "type": "string", "description": "Earliest date of award to include, as YYYY-MM-DD. The archive starts in 1988." }, "dateTo": { "title": "Awards to", "type": "string", "description": "Latest date of award to include, as YYYY-MM-DD. Leave empty for today." }, "forums": { "title": "Forum", "type": "array", "description": "Keep only awards issued by these forums. FINRA (2007 onwards) and NASD (until 2007) hold almost all of the archive; the exchange forums are historical.", "items": { "type": "string", "enum": [ "FINRA", "NASD", "NYSE", "CBOE", "AMEX", "MSRB", "Pacific Exchange/ARCA", "PHLX" ], "enumTitles": [ "FINRA", "NASD", "NYSE", "CBOE", "AMEX", "MSRB", "Pacific Exchange/ARCA", "PHLX" ] } }, "documentTypes": { "title": "Document type", "type": "array", "description": "Keep only these document types. Awards are 98% of the archive; the rest are motions and court orders to confirm or vacate an award.", "items": { "type": "string", "enum": [ "Award", "Order to Confirm", "Motion to Vacate", "Order to Vacate", "Motion to Confirm", "Other" ], "enumTitles": [ "Award", "Order to Confirm", "Motion to Vacate", "Order to Vacate", "Motion to Confirm", "Other" ] } }, "panelCompositions": { "title": "Panel composition", "type": "array", "description": "Keep only awards decided under one of FINRA's special panel programs. Most awards carry no panel composition tag at all.", "items": { "type": "string", "enum": [ "All Public Panel", "Majority Public Panel", "Special Proceeding", "Special Expungement Panel", "Public Arbitrator Pilot Program", "Large Case Project" ], "enumTitles": [ "All Public Panel", "Majority Public Panel", "Special Proceeding", "Special Expungement Panel", "Public Arbitrator Pilot Program", "Large Case Project" ] } }, "sortBy": { "title": "Sort by", "enum": [ "newest", "oldest", "relevance" ], "type": "string", "description": "Newest first (the index's own order), oldest first, or the search engine's relevance ranking. Relevance only differs from date order when you pass search terms without a date range; a full scan over a date range is always returned in date order.", "default": "newest" }, "hearingSites": { "title": "Hearing site contains", "type": "array", "description": "Keep only awards whose hearing site matches one of these, for example \"New York\", \"FL\" or \"Boca Raton, FL\". Awards before 2000 rarely publish a hearing site.", "items": { "type": "string" } }, "partyNameContains": { "title": "Party or counsel name contains", "type": "string", "description": "Keep only awards where this text appears in the claimants, respondents or their representatives, for example \"Merrill Lynch\" or a broker's surname." }, "arbitratorNameContains": { "title": "Arbitrator name contains", "type": "string", "description": "Keep only awards decided by an arbitrator whose name contains this text. Useful for researching an arbitrator's record before a hearing." }, "onlyExpunged": { "title": "Only awards expunged in CRD", "type": "boolean", "description": "Keep only awards FINRA has flagged as expunged from the CRD registration records (about 2% of the archive).", "default": false }, "onlyWithRelatedCases": { "title": "Only awards with related documents", "type": "boolean", "description": "Keep only cases that have more than one document on file, such as an award plus a motion or a court order.", "default": false }, "includeAwardDocument": { "title": "Download the award PDF", "type": "boolean", "description": "Download each award PDF and extract its text, adding the page count, character count and the list of sections found. Required for every extraction below, and charged once per award however many of them you turn on.", "default": false }, "includeFullText": { "title": "Full award text", "type": "boolean", "description": "Add the complete text of the award document to the row, up to 200,000 characters.", "default": false }, "includeMonetaryTerms": { "title": "Damages and monetary terms", "type": "boolean", "description": "Parse the AWARD section: compensatory, punitive, attorney fees, expert fees and costs awarded, the total, the interest rate and start date, the amount originally requested, and whether the claims were denied.", "default": false }, "includeFeeBreakdown": { "title": "FINRA fee breakdown", "type": "boolean", "description": "Parse the FEES section: filing fees, member surcharge and process fee, total hearing session fees, the number of hearing sessions and who each assessment was charged to.", "default": false }, "includeExpungementDetail": { "title": "Expungement findings", "type": "boolean", "description": "Parse the expungement ruling: requested, granted or denied, the CRD occurrence numbers, the registered persons with their CRD numbers, the Rule 2080 affirmative findings and whether court confirmation is required.", "default": false }, "includeArbitratorPanel": { "title": "Arbitrator panel and roles", "type": "boolean", "description": "Parse the arbitration panel block: each arbitrator with their role (public, non-public, presiding chairperson), the panel size and the chairperson.", "default": false }, "includeRepresentation": { "title": "Counsel and law firms", "type": "boolean", "description": "Parse the representation of parties: counsel for each side, their law firms, and whether a party appeared pro se.", "default": false }, "includeCausesOfAction": { "title": "Causes of action", "type": "boolean", "description": "Parse the causes of action asserted in the statement of claim into a list, for example breach of fiduciary duty, unsuitability, misrepresentation.", "default": false }, "includeCaseTimeline": { "title": "Case timeline", "type": "boolean", "description": "Parse the case dates: nature of the dispute, statement of claim filed, statement of answer filed, submission agreement dates and every hearing date.", "default": false }, "includeCaseNarrative": { "title": "Case narrative sections", "type": "boolean", "description": "Add the text of the CASE SUMMARY, RELIEF REQUESTED, OTHER ISSUES CONSIDERED AND DECIDED and AWARD sections as separate fields.", "default": false }, "includeRelatedCases": { "title": "Related documents for the case", "type": "boolean", "description": "For cases flagged as having related documents, look up every other document filed under the same case number and attach them with their type, date and PDF link.", "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 } } } } } } } } } }