API ReferenceAlt-Data
Hiring screen
/api/v3/workforce/momentum_screen- Plan
- Pro and up
- Price
- 3 credits per call
- MCP tool
workforce_momentum_ screen
CROSS-SECTIONAL HIRING SCREEN — rank listed employers by headcount growth between the panel's latest month and N months earlier: ticker, company, headcount then and now, percent and absolute change, latest hiring and attrition rates and average salary, sorted fastest-growing or fastest-shrinking. This is the workforce factor as a screen — who is actually staffing up (or quietly shrinking) months before it reaches a filing. Only employers whose headcount change is explained by their own hires minus departures are ranked; the rest (employer re-mappings, revised months) are listed apart as excluded_entity_artefacts with the gap. The monthly panel is MID-BACKFILL, so a months_back longer than the loaded window returns an explicit warning listing the lookbacks that ARE available — never a silently shortened comparison.
Parameters
Query
months_backintegerOptionalCompare the latest month against this many months earlier.
11 to 36min_headcountnumberOptionalDrop micro-employers below this estimated headcount.
10000 to …orderstringOptionalfastest_growingfastest_shrinkingfastest_growinglimitintegerOptional1001 to 500Response
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_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The 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 unauthorized | Missing or invalid API key. |
402 plan_required | Your 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_denied | This 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_found | No such resource. Not billed. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The 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.