A simple and easy to read documentation page for nostr devs.
| kind | description | NIP |
|---|---|---|
| 0 | Metadata | 01 |
| 1 | Short Text Note | 01 |
| 2 | Recommend Relay | 01 |
| 3 | Contacts | 02 |
| 4 | Encrypted Direct Messages | 04 |
| 5 | Event Deletion | 09 |
| 6 | Reposts | 18 |
| 7 | Reaction | 25 |
| 8 | Badge Award | 58 |
| 40 | Channel Creation | 28 |
| 41 | Channel Metadata | 28 |
| 42 | Channel Message | 28 |
| 43 | Channel Hide Message | 28 |
| 44 | Channel Mute User | 28 |
| 1063 | File Metadata | 94 |
| 1984 | Reporting | 56 |
| 9734 | Zap Request | 57 |
| 9735 | Zap | 57 |
| 10000 | Mute List | 51 |
| 10001 | Pin List | 51 |
| 10002 | Relay List Metadata | 65 |
| 13194 | Wallet Info | 47 |
| 22242 | Client Authentication | 42 |
| 23194 | Wallet Request | 47 |
| 23195 | Wallet Response | 47 |
| 24133 | Nostr Connect | 46 |
| 30000 | Categorized People List | 51 |
| 30001 | Categorized Bookmark List | 51 |
| 30008 | Profile Badges | 58 |
| 30009 | Badge Definition | 58 |
| 30017 | Create or update a stall | 15 |
| 30018 | Create or update a product | 15 |
| 30023 | Long-form Content | 23 |
| 30078 | Application-specific Data | 78 |
| 31989 | Handler recommendation | 89 |
| 31990 | Handler information | 89 |
| range | description | NIP |
|---|---|---|
| 1000-9999 | Regular Events | 16 |
| 10000-19999 | Replaceable Events | 16 |
| 20000-29999 | Ephemeral Events | 16 |
| 30000-39999 | Parameterized Replaceable Events | 33 |
| name | value | other parameters | NIP |
|---|---|---|---|
| `a` | coordinates to an event | relay URL | 23, 33 |
| `alt` | Alt tag | -- | 31 |
| `d` | identifier | -- | 33 |
| `e` | event id (hex) | relay URL, marker | 01, 10 |
| `g` | geohash | -- | 12 |
| `i` | identity | proof | 39 |
| `p` | pubkey (hex) | relay URL | 01 |
| `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` | shortcode | image URL | 30 |
| `expiration` | unix timestamp (string) | -- | 40 |
| `image` | image URL | dimensions in pixels | 23, 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 thumbnail | dimensions in pixels | 58 |
| `title` | article title | -- | 23 |
| `zap` | profile name | type of value | 57 |
| type | description | NIP |
|---|---|---|
| `AUTH` | used to send authentication events | 40 |
| `CLOSE` | used to stop previous subscriptions | 01 |
| `COUNT` | used to request event counts | 45 |
| `EVENT` | used to publish events | 01 |
| `REQ` | used to request events and subscribe to new updates | 01 |
| type | description | NIP |
|---|---|---|
| `AUTH` | used to send authentication challenges | 40 |
| `COUNT` | used to send requested event counts to clients | 45 |
| `EOSE` | used to notify clients all stored events have been sent | 01 |
| `EVENT` | used to send events requested to clients | 01 |
| `NOTICE` | used to send human-readable messages to clients | 01 |
| `OK` | used to notify clients if an EVENT was successful | 20 |