Skip to content

Documentation

Getting started

From key to first response in a few minutes. These pages explain how the APIs work. The endpoint-by-endpoint reference, generated from the OpenAPI specification, is at https://api.stackbyte.app/docs.

Open in API reference

1. Get a key

Every request needs an API key in the X-API-Key header. The Free plan includes 100 credits a month across every API. Request a free key and we will email it to you.

Live keys start sb_live_ and test keys start sb_test_. A key is shown once, when it is issued. We store only a hash of it, so a lost key cannot be recovered, only replaced. Keep it in an environment variable or a secrets manager, not in code.

2. Make your first request

Look up Log4Shell with CVE Triage. The base URL for every API is https://api.stackbyte.app.

curl https://api.stackbyte.app/v1/cve/CVE-2021-44228 \
  -H "X-API-Key: $STACKBYTE_KEY"

3. Read the response

Every response has the same envelope: the record in data, and everything about the call in meta.

meta fieldWhat it tells you
credits_chargedCredits this call used.
credits_remainingCredits left in this billing month.
cachedtrue when the response came from the 24-hour cache (1 credit).
suppressedtrue when a record was removed on request; data is then null.
attributionThe attribution sentences for every source used, joined.
sources[]One entry per source: id, name, url, licence, attribution, data_as_of and coverage.

data_as_of is the date of the data that source contributed, and coverage says whether its last nightly import passed. See coverage and data dates.

4. Credits and caching

All Stackbyte APIs draw on one monthly credit balance. Most lookups cost 1 credit; batch endpoints are priced per 10 ids. Any repeat of the same request within 24 hours is served from the cache and costs 1 credit. The Free plan stops at 100 credits; paid plans keep working and bill the extra credits. Plans and prices are on the pricing page.

Check your balance at any time:

Account usage
curl https://api.stackbyte.app/v1/account/usage \
  -H "X-API-Key: $STACKBYTE_KEY"

It returns your plan, credits_remaining, credits_reset_at and calls_last_30_days.

5. Errors

StatusMeaning
401The X-API-Key header is missing, or the key is invalid or revoked.
402The Free plan has run out of credits: {"error": "insufficient_credits"}. Paid plans keep working and bill the extra credits.
422A parameter is malformed, for example a CVE id that does not match CVE-YYYY-NNNN.

Failed requests are not charged.

Next steps

  • Concepts: the response envelope, data dates, suppression, rate limits and versioning.
  • CVE Triage: every field, the triage rules and SIEM examples for Splunk and Microsoft Sentinel.
There are no bulk export endpoints, by design. The APIs answer questions about specific records; the source datasets are free to download from their publishers, listed on our data sources page.

Data attribution

  • Includes data from the CISA Known Exploited Vulnerabilities Catalog (CC0). Not endorsed by CISA.
  • EPSS scores by FIRST.org (https://www.first.org/epss/), used with attribution as requested by FIRST.
  • This product uses the NVD API but is not endorsed or certified by the NVD. CVE is a registered trademark of The MITRE Corporation.
  • Stackbyte Limited is not affiliated with any government entity or data publisher. Sources and licences are listed on our data sources page.