Wealthnow
Sign up

API ReferenceAlt-Data

Status

Layoff screen

GET/api/v3/workforce/layoff_screen
Plan
Pro and up
Price
3 credits per call
MCP tool
workforce_layoff_screen

CROSS-SECTIONAL LAYOFF SCREEN — which listed companies filed WARN-Act layoff notices in the last N days, ranked by employees noticed. One row per employer (ticker + employer_id: company, filing count, employees noticed, first/latest event date, states touched, largest single filing) across the whole listed universe. Call it for 'who is cutting right now' — notices are filed weeks before the cut, so this surfaces restructurings before the press release. A single notice far above the employer's modelled headcount (more than 5x, or more than 2x beside a smaller row for the same site and day) is quarantined and counts toward no figure or rank; an employer whose every notice was quarantined is listed apart. The answer states where the filing archive ends (data_through, is_stale), with a warning when the window starts after it or mostly lies after it. Only employers matched to a listed symbol appear; most WARN filers are private and are excluded by design. For one company's filings use /workforce/layoffs/{ticker}.

Parameters

Query

daysintegerOptional

Lookback window in days.

Default90
Range1 to 1825
min_employeesintegerOptional

Only employers at or above this total employees noticed.

Default0
Range0 to 1000000
statestringOptional

US state, full name exactly as filed, e.g. 'California' (a two-letter code matches nothing)

limitintegerOptional
Default100
Range1 to 1000

Response

A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Alt-Data). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.

A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.

Errors

No error is billed. The body is { "ok": false, "error", "detail", "request_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed.
401 unauthorizedMissing or invalid API key.
402 plan_requiredYour plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed.
403 scope_deniedThis API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed.
404 not_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe request ran past the server's time budget; retry. Not billed.

This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.

Guides

Read the Alt-Data guide for this endpoint's fields and examples.