Public API

Free, read-only JSON API. No key, no registration, CORS enabled. Data refreshes every 6 hours — please cache responses accordingly.

Base URL

http://www.nostrdex.com/api/v1

List parameters accept comma separated values or repeated keys: nips=1,11,42 or nips=1&nips=11.
Booleans accept true / false (also 1 / 0).
Timestamps are Unix seconds, durations are milliseconds, ratios are 0–1.
Paginate with limit (max 500) and offset. The meta object contains total and next_offset.
Add format=urls to receive a plain text list of URLs — handy for relay pools.
Errors return a JSON body { "error": { "code", "message" } } with a matching HTTP status.

GET/api/v1/relays

List and filter relays.

Parameter	Type	Description
q	string	Full text search over URL, name, description and software.
status	list	online, degraded, offline, unknown.
min_users	number	Minimum number of users listing the server (NIP-65 / BUD-03).
min_uptime	number	Minimum 7 day uptime, 0–1 or percent.
max_latency	number	Maximum latency in milliseconds.
nips	list<number>	Relay must support all listed NIPs.
software	list	Software name, e.g. strfry, khatru, nostr-rs-relay.
network	list	clearnet, tor, i2p, loki.
country	list	ISO 3166 country code from NIP-11 relay_countries.
language	list	IETF language tag from NIP-11 language_tags.
auth	boolean	Relay requires NIP-42 authentication.
payment	boolean	Relay requires payment.
writable	boolean	Relay accepted our signed test event.
sort	enum	score, popularity, uptime, latency, activity (events in the last hour), newest, name.
order	asc \| desc	asc or desc. Defaults depend on the sort.
limit	number	Page size, 1–500. Default 50.
offset	number	Number of items to skip.
format	json \| urls	json (default) or urls.

curl

curl "http://www.nostrdex.com/api/v1/relays?nips=50&status=online&sort=uptime&limit=10"

GET/api/v1/relays/{host}

A single relay including its NIP-11 document and check history.

curl

curl "http://www.nostrdex.com/api/v1/relays/relay.damus.io"

GET/api/v1/blossom

List and filter Blossom servers.

Parameter	Type	Description
q	string	Full text search over URL, name, description and software.
status	list	online, degraded, offline, unknown.
min_users	number	Minimum number of users listing the server (NIP-65 / BUD-03).
min_uptime	number	Minimum 7 day uptime, 0–1 or percent.
max_latency	number	Maximum latency in milliseconds.
open_upload	boolean	Our test upload succeeded and the blob was retrievable afterwards.
open_adult_upload	boolean	Our adult-category test upload succeeded and the blob was retrievable afterwards.
upload	list	Upload test outcome: ok, auth-required, payment-required, forbidden, too-large, unsupported-type, rate-limited, error, skipped.
cors	boolean	Server sends CORS headers (needed for web clients).
media	boolean	Supports BUD-05 /media.
mirror	boolean	Supports BUD-04 /mirror.
list	boolean	Supports BUD-12 /list.
sort	enum	score, popularity, uptime, latency, upload_success, newest, name.
order	asc \| desc	asc or desc. Defaults depend on the sort.
limit	number	Page size, 1–500. Default 50.
offset	number	Number of items to skip.
format	json \| urls	json (default) or urls.

curl

curl "http://www.nostrdex.com/api/v1/blossom?open_upload=true&cors=true&sort=upload_success"

GET/api/v1/blossom/{host}

A single Blossom server including its check history.

curl

curl "http://www.nostrdex.com/api/v1/blossom/blossom.primal.net"

GET/api/v1/stats

Aggregated network statistics and crawler status.

curl

curl "http://www.nostrdex.com/api/v1/stats"