Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: KeyVex Alerts API
version: 0.102.0
termsOfService: https://keyvex.com/terms
description: 'US public financial-disclosure data — congressional trades, insider filings (Form 4), lobbying, Treasury auctions, member profiles. Requires an API key — create a free one at https://keyvex.com and send it as the header `x-api-key: `. A free key returns most public-record datasets (one year of history; no market-price data and a few heavy datasets are on paid plans only), capped at 60 requests/day; paid plans raise the caps. The daily allowance resets at midnight Eastern.'
servers:
- url: https://api.keyvex.com
security:
- ApiKeyAuth: []
tags:
- name: Alerts
paths:
/v1/alerts:
get:
operationId: get_alerts
summary: 'Your watchlist alerts, newest first: events matched to the tickers, members of…'
description: 'Your watchlist alerts, newest first: events matched to the tickers, members of Congress and federal-contract
recipients (UEIs) on YOUR watchlist, for the API key making the call. Kinds:
congress_trade: a congressional trade disclosed this week in a ticker or by a member on your watchlist.
initial_13d: an initial Schedule 13D (a new 5%+ activist stake) filed this week in a ticker on your watchlist.
federal_contract: federal awards at or above your threshold that KeyVex first reported this week, new or newly modified (a later modification of an award you were already alerted to does not alert again).
An event alerts only when its own date (disclosure, filing, the award''s latest modification) is within 7 days of
detection and not before you added the entry, so a watchlist never replays history. Each alert''s `data` is the
source record as KeyVex stored it when the alert fired, with KeyVex''s internal `_` fields removed; the matching
tool may present the same record differently. Paginate with next_cursor. The watchlist itself is managed on
keyvex.com.
Webhooks (paid plans, Basic and up): each POST carries X-KeyVex-Timestamp and X-KeyVex-Signature = sha256 HMAC of
''.'' with your secret. Receivers MUST verify the signature and REJECT a timestamp older than
5 minutes (replay protection); redirects are never followed; answer 2xx within 5 s.'
parameters:
- name: since
in: query
required: false
description: Only alerts detected at or after this ISO date or date-time.
schema:
type: string
- name: kind
in: query
required: false
description: Only this kind.
schema:
type: string
enum:
- congress_trade
- initial_13d
- federal_contract
- name: limit
in: query
required: false
description: Page size (default 50).
schema:
type: integer
- name: cursor
in: query
required: false
description: next_cursor from the previous page.
schema:
type: string
responses:
'200':
description: 'JSON envelope: { results: [...], count, has_more }.'
'400':
description: Invalid parameter.
'401':
description: Missing or invalid API key.
'402':
description: This tool requires a higher plan (upgrade_required). Retrying will not help.
'429':
description: Tier rate/quota limit reached (rate_limited). Retry-After points at the reset.
tags:
- Alerts
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key