Welcome to nostrdocs

A simple and easy to read documentation page for nostr devs.

kinddescriptionNIP
0Metadata01
1Short Text Note01
2Recommend Relay01
3Contacts02
4Encrypted Direct Messages04
5Event Deletion09
6Reposts18
7Reaction25
8Badge Award58
40Channel Creation28
41Channel Metadata28
42Channel Message28
43Channel Hide Message28
44Channel Mute User28
1063File Metadata94
1984Reporting56
9734Zap Request57
9735Zap57
10000Mute List51
10001Pin List51
10002Relay List Metadata65
13194Wallet Info47
22242Client Authentication42
23194Wallet Request47
23195Wallet Response47
24133Nostr Connect46
30000Categorized People List51
30001Categorized Bookmark List51
30008Profile Badges58
30009Badge Definition58
30017Create or update a stall15
30018Create or update a product15
30023Long-form Content23
30078Application-specific Data78
31989Handler recommendation89
31990Handler information89

Event Kind Ranges

rangedescriptionNIP
1000-9999Regular Events16
10000-19999Replaceable Events16
20000-29999Ephemeral Events16
30000-39999Parameterized Replaceable Events33
namevalueother parametersNIP
`a`coordinates to an eventrelay URL23, 33
`alt`Alt tag--31
`d`identifier--33
`e`event id (hex)relay URL, marker01, 10
`g`geohash--12
`i`identityproof39
`p`pubkey (hex)relay URL01
`r`a reference (URL, etc)--12
`t`hashtag--12
`amount`millisats--57
`bolt11``bolt11` invoice--57
`challenge`challenge string--42
`content-warning`reason--36
`delegation`pubkey, conditions, delegation token--26
`description`badge description--58
`description`invoice description--57
`emoji`shortcodeimage URL30
`expiration`unix timestamp (string)--40
`image`image URLdimensions in pixels23, 58
`lnurl``bech32` encoded `lnurl`--57
`name`badge name--58
`nonce`random--13
`preimage`hash of `bolt11` invoice--57
`published_at`unix timestamp (string)--23
`relay`relay url--42
`relays`relay list--57
`subject`subject--14
`summary`article summary--23
`thumb`badge thumbnaildimensions in pixels58
`title`article title--23
`zap`profile nametype of value57

Client to Relay

typedescriptionNIP
`AUTH`used to send authentication events40
`CLOSE`used to stop previous subscriptions01
`COUNT`used to request event counts45
`EVENT`used to publish events01
`REQ`used to request events and subscribe to new updates01

Relay to Client

typedescriptionNIP
`AUTH`used to send authentication challenges40
`COUNT`used to send requested event counts to clients45
`EOSE`used to notify clients all stored events have been sent01
`EVENT`used to send events requested to clients01
`NOTICE`used to send human-readable messages to clients01
`OK`used to notify clients if an EVENT was successful20