NFT Chats

NFT related API endpoints:

CreateCommunityChatitem creates GroupChatitem just with community tag (likely could be consolidated)

post

Community Chat Data

Authorizations

AuthorizationstringRequired

Body

context_typestringOptional

fromaddrstringOptional

idintegerOptional

messagestringOptional

nftaddrstringOptional

sender_namestringOptional

timestampstringOptional

timestamp_dtmstringOptional

typestringOptional

Responses

200

application/json

context_typestringOptional

fromaddrstringOptional

idintegerOptional

messagestringOptional

nftaddrstringOptional

sender_namestringOptional

timestampstringOptional

timestamp_dtmstringOptional

typestringOptional

post/v1/community

POST /v1/community HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "context_type": "text",
  "fromaddr": "text",
  "id": 1,
  "message": "text",
  "nftaddr": "text",
  "sender_name": "text",
  "timestamp": "text",
  "timestamp_dtm": "text",
  "type": "text"
}

200

[
  {
    "context_type": "text",
    "fromaddr": "text",
    "id": 1,
    "message": "text",
    "nftaddr": "text",
    "sender_name": "text",
    "timestamp": "text",
    "timestamp_dtm": "text",
    "type": "text"
  }
]

Get Community Chat Landing Page Info

get

TODO: need a creation API for communities, which includes specificied welcome message text, Twitter handle, page title

Authorizations

AuthorizationstringRequired

Path parameters

addressstringRequired

Wallet Address

Responses

200

application/json

has_messagedbooleanOptional

has user messaged in this group chat before? if not show "Say hi" button

is_verifiedbooleanOptional

is this group verified? WalletChat's group is verified by default

joinedbooleanOptional

number of members of the group

logostringOptional

logo url, stored in backend

membersintegerOptional

namestringOptional

get/v1/community/{community}/{address}

GET /v1/community/{community}/{address} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "has_messaged": true,
    "is_verified": true,
    "joined": true,
    "logo": "text",
    "members": 1,
    "messages": [
      {
        "context_type": "text",
        "fromaddr": "text",
        "id": 1,
        "message": "text",
        "nftaddr": "text",
        "sender_name": "text",
        "timestamp": "text",
        "timestamp_dtm": "text",
        "type": "text"
      }
    ],
    "name": "text",
    "social": [
      {
        "type": "text",
        "username": "text"
      }
    ],
    "tweets": [
      {
        "attachments": {
          "media_keys": [
            "text"
          ]
        },
        "author_id": "text",
        "created_at": "text",
        "id": "text",
        "media": {
          "media_keys": [
            "text"
          ]
        },
        "text": "text",
        "user": {
          "id": "text",
          "name": "text",
          "profile_image_url": "text",
          "username": "text"
        }
      }
    ]
  }
]

Get Public Comments for given NFT Contract and ID

get

NFTs have a public comment section

Authorizations

AuthorizationstringRequired

Path parameters

addressstringRequired

Wallet Address

Responses

200

application/json

fromaddrstringOptional

idintegerOptional

messagestringOptional

namestringOptional

nftaddrstringOptional

nftidintegerOptional

timestampstringOptional

get/v1/get_comments/{nftaddr}/{nftid}

GET /v1/get_comments/{nftaddr}/{nftid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "fromaddr": "text",
    "id": 1,
    "message": "text",
    "name": "text",
    "nftaddr": "text",
    "nftid": 1,
    "timestamp": "text"
  }
]

Get Public Comments Count for given NFT Contract and ID

get

NFTs have a public comment section

Authorizations

AuthorizationstringRequired

Path parameters

nftaddrstringRequired

NFT Contract Address

nftidstringRequired

NFT ID

Responses

200

application/json

integerOptional

get/v1/get_comments_cnt/{nftaddr}/{nftid}

GET /v1/get_comments_cnt/{nftaddr}/{nftid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Get all unread messages for a specific NFT context

get

Get Unread count for specifc NFT context given a wallet address and specific NFT

Authorizations

AuthorizationstringRequired

Path parameters

addressstringRequired

Wallet Address

nftaddrstringRequired

NFT Contract Address

nftidstringRequired

NFT ID

Responses

200

application/json

integerOptional

get/v1/get_unread_cnt/{address}/{nftaddr}/{nftid}

GET /v1/get_unread_cnt/{address}/{nftaddr}/{nftid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Get NFT Related Chat Items For Given Wallet Address

get

Get ALL NFT context items for a given wallet address

Authorizations

AuthorizationstringRequired

Path parameters

toaddrstringRequired

Wallet Address

Responses

200

application/json

encrypted_sym_lit_keystringOptional

USE IF USING LIT ENCRYPTION

fromaddrstringRequired

*** REQUIRED INPUT ***

idintegerOptional

AUTO-GENERATED (PRIMARY KEY)

lit_access_conditionsstringOptional

messagestringRequired

*** REQUIRED INPUT ***

nftaddrstringOptional

ONLY USED FOR NFT DM CONTEXT

nftidstringOptional

ONLY USED FOR NFT DM CONTEXT

readbooleanOptional

DEFAULT FALSE

sender_namestringOptional

AUTO-SET BY BACKED FOR RETURN VALUE

timestampstringOptional

AUTO-SET BY REST API

timestamp_dtmstringOptional

USED FOR SORTING WHEN TIME FORMAT NEEDED

toaddrstringRequired

*** REQUIRED INPUT ***

get/v1/getnft_chatitems/{address}

GET /v1/getnft_chatitems/{address} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "encrypted_sym_lit_key": "text",
    "fromaddr": "text",
    "id": 1,
    "lit_access_conditions": "text",
    "message": "text",
    "nftaddr": "text",
    "nftid": "text",
    "read": true,
    "sender_name": "text",
    "timestamp": "text",
    "timestamp_dtm": "text",
    "toaddr": "text"
  }
]

Get NFT Related Chat Items For Given NFT Contract and ID, relating to one wallet

get

Get all specified NFT contract and ID items for a given wallet address

Authorizations

AuthorizationstringRequired

Path parameters

addressstringRequired

Wallet Address

nftaddrstringRequired

NFT Contract Address

nftidstringRequired

NFT ID

Responses

200

application/json

encrypted_sym_lit_keystringOptional

USE IF USING LIT ENCRYPTION

fromaddrstringRequired

*** REQUIRED INPUT ***

idintegerOptional

AUTO-GENERATED (PRIMARY KEY)

lit_access_conditionsstringOptional

messagestringRequired

*** REQUIRED INPUT ***

nftaddrstringOptional

ONLY USED FOR NFT DM CONTEXT

nftidstringOptional

ONLY USED FOR NFT DM CONTEXT

readbooleanOptional

DEFAULT FALSE

sender_namestringOptional

AUTO-SET BY BACKED FOR RETURN VALUE

timestampstringOptional

AUTO-SET BY REST API

timestamp_dtmstringOptional

USED FOR SORTING WHEN TIME FORMAT NEEDED

toaddrstringRequired

*** REQUIRED INPUT ***

get/v1/getnft_chatitems/{address}/{nftaddr}/{nftid}

GET /v1/getnft_chatitems/{address}/{nftaddr}/{nftid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "encrypted_sym_lit_key": "text",
    "fromaddr": "text",
    "id": 1,
    "lit_access_conditions": "text",
    "message": "text",
    "nftaddr": "text",
    "nftid": "text",
    "read": true,
    "sender_name": "text",
    "timestamp": "text",
    "timestamp_dtm": "text",
    "toaddr": "text"
  }
]

Get NFT Related Chat Items For Given NFT Contract and ID, between two wallet addresses (TO and FROM are interchangable)

get

Get ALL NFT context items for a specifc NFT context convo between two wallets

Authorizations

AuthorizationstringRequired

Path parameters

nftaddrstringRequired

NFT Contract Address

nftidstringRequired

NFT ID

toaddrstringRequired

TO: Wallet Address

fromstringRequired

FROM: Wallet Address

Responses

200

application/json

encrypted_sym_lit_keystringOptional

USE IF USING LIT ENCRYPTION

fromaddrstringRequired

*** REQUIRED INPUT ***

idintegerOptional

AUTO-GENERATED (PRIMARY KEY)

lit_access_conditionsstringOptional

messagestringRequired

*** REQUIRED INPUT ***

nftaddrstringOptional

ONLY USED FOR NFT DM CONTEXT

nftidstringOptional

ONLY USED FOR NFT DM CONTEXT

readbooleanOptional

DEFAULT FALSE

sender_namestringOptional

AUTO-SET BY BACKED FOR RETURN VALUE

timestampstringOptional

AUTO-SET BY REST API

timestamp_dtmstringOptional

USED FOR SORTING WHEN TIME FORMAT NEEDED

toaddrstringRequired

*** REQUIRED INPUT ***

get/v1/getnft_chatitems/{fromaddr}/{toaddr}/{nftaddr}/{nftid}

GET /v1/getnft_chatitems/{fromaddr}/{toaddr}/{nftaddr}/{nftid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "encrypted_sym_lit_key": "text",
    "fromaddr": "text",
    "id": 1,
    "lit_access_conditions": "text",
    "message": "text",
    "nftaddr": "text",
    "nftid": "text",
    "read": true,
    "sender_name": "text",
    "timestamp": "text",
    "timestamp_dtm": "text",
    "toaddr": "text"
  }
]

Get NFT Related Chat Items For Given NFT Contract and ID

get

Get ALL NFT context items for a given wallet address

Authorizations

AuthorizationstringRequired

Path parameters

nftaddrstringRequired

NFT Contract Address

nftidstringRequired

NFT ID

Responses

200

application/json

encrypted_sym_lit_keystringOptional

USE IF USING LIT ENCRYPTION

fromaddrstringRequired

*** REQUIRED INPUT ***

idintegerOptional

AUTO-GENERATED (PRIMARY KEY)

lit_access_conditionsstringOptional

messagestringRequired

*** REQUIRED INPUT ***

nftaddrstringOptional

ONLY USED FOR NFT DM CONTEXT

nftidstringOptional

ONLY USED FOR NFT DM CONTEXT

readbooleanOptional

DEFAULT FALSE

sender_namestringOptional

AUTO-SET BY BACKED FOR RETURN VALUE

timestampstringOptional

AUTO-SET BY REST API

timestamp_dtmstringOptional

USED FOR SORTING WHEN TIME FORMAT NEEDED

toaddrstringRequired

*** REQUIRED INPUT ***

get/v1/getnft_chatitems/{nftaddr}/{nftid}

GET /v1/getnft_chatitems/{nftaddr}/{nftid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "encrypted_sym_lit_key": "text",
    "fromaddr": "text",
    "id": 1,
    "lit_access_conditions": "text",
    "message": "text",
    "nftaddr": "text",
    "nftid": "text",
    "read": true,
    "sender_name": "text",
    "timestamp": "text",
    "timestamp_dtm": "text",
    "toaddr": "text"
  }
]

PreviousDirect Messages (DMs)NextGroup Chats (Non-NFT Related)

Last updated 3 years ago