Get Started
Experimental APIs
Healthcheck APIs
Copy
curl --location --request POST 'https://nostrapi.com/api/v1/account/info' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>' \
--data-raw '{
"relays": ["wss://nostr.zbd.gg", "wss://relay.damus.io"],
"pubkey": "[email protected]"
}'
Copy
{
"success": true,
"message": "Successfully fetched 1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d pubkey profile",
"data": {
"content": {
"name": "andre",
"about": "CTO & Co-Founder at ZEBEDEE | Download ZBD app to get started with Nostr + Bitcoin | Overlord at NBD | Partnerships at Vinteum",
"nip05": "[email protected]",
"lud16": "[email protected]",
"banner": "https://nostr.build/i/nostr.build_f2123a91e3c030224cf1cf5c0a70c0ed98e28ce1058350c2e3ca139c46436b6c.jpg",
"picture": "https://cdn.zebedee.io/uploads/f7b9201a-3dfe-44e6-af8d-d4e9d3d7a096_andre.png",
"website": "zbd.gg",
"display_name": "andre"
},
"created_at": 1687103365,
"id": "aef1ddc9b49b6ab5add091053f10b255e45f457870588af539a1d79e0c9bbebe",
"kind": 0,
"pubkey": "1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d",
"sig": "74ffbe63e81d13bf613d2a005a2cca23a68b20d8506b8390d35cc3d559ef0e3af147f2eaf13623ef8311f97d12bb94e9a558d6b7821916a34113846a171fea31",
"tags": []
}
}
Account APIs
Fetch Metadata
This endpoint creates a new Nostr account
POST
https://nostrapi.com
/
api
/
v1
/
account
/
info
Copy
curl --location --request POST 'https://nostrapi.com/api/v1/account/info' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>' \
--data-raw '{
"relays": ["wss://nostr.zbd.gg", "wss://relay.damus.io"],
"pubkey": "[email protected]"
}'
Copy
{
"success": true,
"message": "Successfully fetched 1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d pubkey profile",
"data": {
"content": {
"name": "andre",
"about": "CTO & Co-Founder at ZEBEDEE | Download ZBD app to get started with Nostr + Bitcoin | Overlord at NBD | Partnerships at Vinteum",
"nip05": "[email protected]",
"lud16": "[email protected]",
"banner": "https://nostr.build/i/nostr.build_f2123a91e3c030224cf1cf5c0a70c0ed98e28ce1058350c2e3ca139c46436b6c.jpg",
"picture": "https://cdn.zebedee.io/uploads/f7b9201a-3dfe-44e6-af8d-d4e9d3d7a096_andre.png",
"website": "zbd.gg",
"display_name": "andre"
},
"created_at": 1687103365,
"id": "aef1ddc9b49b6ab5add091053f10b255e45f457870588af539a1d79e0c9bbebe",
"kind": 0,
"pubkey": "1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d",
"sig": "74ffbe63e81d13bf613d2a005a2cca23a68b20d8506b8390d35cc3d559ef0e3af147f2eaf13623ef8311f97d12bb94e9a558d6b7821916a34113846a171fea31",
"tags": []
}
}
Body
The array of relay URLs you wish to publish your account update event to.
The address of the Nostr account — can be a Nostr NIP05 address (e.g. [email protected]), or a Nostr public key in NPUB or HEX format.
Response
Indicates whether the call was successful.
true if successful, false if not.Message detailing the results of the operation.
The contents of the data response object.
Show Toggle
Show Toggle
Metadata content for this Nostr account.
Show Toggle
Show Toggle
Public-facing name for this Nostr account.
Public-facing description / bio for this Nostr account.
Public-facing URL for an account profile image (avatar).
Public-facing URL for an account banner image.
Website URL for this account.
A verified NIP05 domain name that correctly points to this Nostr account’s public key.
Lightning Address for this Nostr account such that it can receive Bitcoin payments.
The
kind of this Nostr event. Kind 0 is metadata updates.Timestamp of when this account metadata was last updated.
Nostr-specific tags.
The Nostr public key of the Nostr account.
The unique ID of this Nostr event updating account metadata.
The cryptographic signature of this Nostr update event.
Copy
curl --location --request POST 'https://nostrapi.com/api/v1/account/info' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>' \
--data-raw '{
"relays": ["wss://nostr.zbd.gg", "wss://relay.damus.io"],
"pubkey": "[email protected]"
}'
Copy
{
"success": true,
"message": "Successfully fetched 1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d pubkey profile",
"data": {
"content": {
"name": "andre",
"about": "CTO & Co-Founder at ZEBEDEE | Download ZBD app to get started with Nostr + Bitcoin | Overlord at NBD | Partnerships at Vinteum",
"nip05": "[email protected]",
"lud16": "[email protected]",
"banner": "https://nostr.build/i/nostr.build_f2123a91e3c030224cf1cf5c0a70c0ed98e28ce1058350c2e3ca139c46436b6c.jpg",
"picture": "https://cdn.zebedee.io/uploads/f7b9201a-3dfe-44e6-af8d-d4e9d3d7a096_andre.png",
"website": "zbd.gg",
"display_name": "andre"
},
"created_at": 1687103365,
"id": "aef1ddc9b49b6ab5add091053f10b255e45f457870588af539a1d79e0c9bbebe",
"kind": 0,
"pubkey": "1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d",
"sig": "74ffbe63e81d13bf613d2a005a2cca23a68b20d8506b8390d35cc3d559ef0e3af147f2eaf13623ef8311f97d12bb94e9a558d6b7821916a34113846a171fea31",
"tags": []
}
}
⌘I