Documentation

Everything you need to use, integrate or self-host this Nostr server.

Endpoints

Wire protocols exposed by this server. Click a row to copy the URL.

Relay wss://relay.nostrverse.net
WSS Nostr relay (NIP-01). NIP-11 info available via HTTPS with Accept: application/nostr+json.
NIP-96 https://nostrverse.net/.well-known/nostr/nip96.json
GET Service info JSON: api_url, download_url, supported MIMEs, plans, content type policy.
Blossom https://cdn.nostrverse.net
HTTPS Blob root. GET /<sha256>, HEAD /<sha256>, PUT /upload, PUT /mirror, DELETE /<sha256>. Auth via BUD-11 (Nostr-signed event header).
NIP-05 https://nostrverse.net/.well-known/nostr.json
GET ?name=<local-part> → JSON with names map and optional relays, nip96 fields.

Active modules

REST API surface. Each module links to its wiki chapter.

ModulePathMethodsDescription
nostraddress /nostraddress GET Returns the pubkey of a nostr address name
media /media GET POST PUT DELETE This module handles media uploads and downloads.
lightning /lightningaddress GET PUT DELETE Lightning redirections for nostr addresses.
verify /verify POST This module can verify a nostr note integrity.
register /register POST Register new usernames from trusted pubkeys.
domains /domains GET Get the list of registered domains.
admin /admin GET POST Admin API, reboot, status, etc.
frontend / GET POST Frontend, login, register, etc.
payments /payments POST This module handles payments, balance, invoices, etc.
relay /relay WebSocket GET This module handles the Nostr relay
security This module handles security, ip logs, automatic ban, etc.
logger / Library This module manages the server logs engine.

More on the wiki: Configuration · Multi-tenancy · Plugins

Supported NIPs (Nostr)

Each one links to the official spec.

Supported BUDs (Blossom)

Blossom Upgrade Documents implemented by this server.

Lightning

Payments and zaps via Lightning Network. Specs supported:

Self-host this server

This server runs nostrcheck-server, an open-source project (MIT). You can run your own instance — same software, your rules.

View on GitHub