SPB Git

Repository Public

manifest.ts 3.5 KB 48 lines typescript

1import { defineManifest } from '../../sdk/manifest.js';23/**4 * Docs verified 2026-09-08 (quotes and URLs in docs/connectors/seer.md):5 *  - https://api.seer.cancer.gov/ — "The SEER API is a RESTful Web service that supports various SEER Program6 *    data sets and mapping … designed for integration into registry computer systems"; July 11, 2025:7 *    "Transitioned to Login.gov for authentication" (for obtaining a key).8 *  - OpenAPI https://api.seer.cancer.gov/v3/api-docs — security scheme apiKey header "X-SEERAPI-Key";9 *    modules: rx, glossary, ndc, mph, recode, surgery, disease, staging, hcpcs, naaccr. There is NO endpoint10 *    for population statistics (incidence, mortality, survival); those live in SEER*Explorer (bulk connector11 *    `seer-explorer`).12 *  - Usage https://api.seer.cancer.gov/usage — header `X-SEERAPI-Key: YOURAPIKEY` (query `api_key` "should only13 *    be used for testing purposes"); "The current rate limit is 5000 API calls per hour per account"; 429 on excess.14 *  - Terms https://api.seer.cancer.gov/terms — applications "will include appropriate acknowledgement of SEER's15 *    contribution"; datasets are "a United States Government dataset"; no proprietary rights may be asserted.16 *  - Unauthenticated probe of /rest/recode/sitegroup/algorithms → HTTP 401 {"message":"You must supply an API key"}.17 */18export const manifest = defineManifest({19  id: 'seer',20  name: 'SEER API (Surveillance, Epidemiology, and End Results Program)',21  organization: 'National Cancer Institute, Surveillance Research Program',22  category: 'epidemiology',23  tier: 0,24  description:25    'NCI SEER Program web service (REST, free API key). Exposes registry tooling — SEER site recode / ICCC / AYA algorithms, hematopoietic & lymphoid disease database, SEER*Rx drugs, staging, NAACCR documentation — but no population statistics; US incidence, mortality and survival statistics are published through SEER*Explorer (connector seer-explorer). With a key this connector validates access and records the available recode algorithm versions used to interpret SEER site groupings.',26  homepage: 'https://seer.cancer.gov/',27  docsUrl: 'https://api.seer.cancer.gov/docs',28  termsUrl: 'https://api.seer.cancer.gov/terms',29  access: { type: 'rest', auth: 'api_key', baseUrl: 'https://api.seer.cancer.gov/rest' },30  license: 'US Government dataset (SEER API Terms of Service: acknowledgement of SEER required; free for commercial and non-commercial use; 5000 calls/hour)',31  licenseStatus: 'approved',32  commercialUse: 'allowed',33  redistribution: 'attribution',34  attribution: 'Surveillance, Epidemiology, and End Results (SEER) Program (www.seer.cancer.gov), National Cancer Institute, DCCPS, Surveillance Research Program.',35  termsReviewedAt: '2026-09-08',36  termsNotes: 'Requires SEER_API_KEY (obtain via https://api.seer.cancer.gov/ → Login.gov). Until a key is configured the connector stays awaiting_credentials. The API carries no incidence/mortality/survival statistics — never present tooling responses as epidemiology. Never present SEER (US) figures as global.',37  updateFrequency: 'Continuous (tooling); statistics via SEER*Explorer annually (April release)',38  supportsIncrementalSync: false,39  entities: [],40  metrics: [],41  rateLimits: { requestsPerSecond: 2, maxConcurrency: 1, notes: 'Terms of Service: 5000 API calls per 60 minutes per account; X-RateLimit-* headers; HTTP 429 when exceeded.' },42  rawRetention: 'summary',43  documentationVerifiedAt: '2026-09-08',44  status: 'awaiting_credentials',45});4647export const SEER_API_KEY_ENV = 'SEER_API_KEY';48
Files main
Menu

Theme