Docs/Models

NostrProfile

object

A Nostr profile indexed in the Fountain graph.

A listener or creator profile, keyed by its Nostr pubkey. Returned by Search Profiles. Most display fields are self-reported and any of them may be absent.

Fields

pubkeystringrequired

The hex-encoded Nostr public key.

npubstringrequired

The same key, bech32-encoded as an npub.

handlestringoptional

The Fountain handle, when the profile has claimed one.

displayobjectrequired

Self-reported profile details. Every field is optional.

namestringoptional

Display name.

usernamestringoptional

Short username.

aboutstringoptional

Profile bio.

picturestringoptional

Avatar image URL.

bannerstringoptional

Banner image URL.

websitestringoptional

Personal website URL.

nip05stringoptional

NIP-05 verified identifier.

lud16stringoptional

Lightning address for payments.

statsobjectoptional

Follower counts, when indexed.

followingnumberrequired

How many profiles this profile follows.

followersnumberrequired

How many profiles follow this profile.

relaysobjectoptional

The relays the profile publishes to, when known.

allstring[]required

Relay URLs.

Example
{
  "pubkey": "a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f90",
  "npub": "npub1c2d3e4f5g6h7i8j9k0l1m2n3o4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f",
  "handle": "alice",
  "display": {
    "name": "Alice",
    "username": "alice",
    "about": "Podcaster and bitcoiner.",
    "picture": "https://media.fountain.fm/profiles/alice/avatar.jpg",
    "nip05": "alice@fountain.fm",
    "lud16": "alice@fountain.fm"
  },
  "stats": {
    "following": 128,
    "followers": 4210
  }
}