Group Chats (Non-NFT Related)

Group chat related API endpoints:

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

post

Community Chat Data

Authorizations

BearerAuth

AuthorizationstringRequired

Body

application/json

context_typestringOptional

fromaddrstringOptional

idintegerOptional

messagestringOptional

nftaddrstringOptional

sender_namestringOptional

timestampstringOptional

timestamp_dtmstringOptional

typestringOptional

Responses

200

OK

application/json

context_typestringOptional

fromaddrstringOptional

idintegerOptional

messagestringOptional

nftaddrstringOptional

sender_namestringOptional

timestampstringOptional

timestamp_dtmstringOptional

typestringOptional

post/v1/community

HTTPcURLJavaScriptPython

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

OK

[
  {
    "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

BearerAuth

AuthorizationstringRequired

Path parameters

addressstringRequired

Wallet Address

Responses

200

OK

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}

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "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"
        }
      }
    ]
  }
]

Join an NFT or Community group chat

post

Bookmarks keep an NFT/Community group chat in the sidebar

Authorizations

BearerAuth

AuthorizationstringRequired

Body

application/json

chainstringOptional

idintegerOptional

nftaddrstringOptional

walletaddrstringOptional

Responses

200

OK

application/json

chainstringOptional

idintegerOptional

nftaddrstringOptional

walletaddrstringOptional

post/v1/create_bookmark

HTTPcURLJavaScriptPython

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

{
  "chain": "text",
  "id": 1,
  "nftaddr": "text",
  "walletaddr": "text"
}

200

OK

[
  {
    "chain": "text",
    "id": 1,
    "nftaddr": "text",
    "walletaddr": "text"
  }
]

CreateCommunity creates new custom community chat

post

Community Chat Creation

Authorizations

BearerAuth

AuthorizationstringRequired

Body

application/json

communitystringOptional

Responses

200

OK

application/json

communitystringOptional

post/v1/create_community

HTTPcURLJavaScriptPython

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

{
  "community": "text",
  "social": [
    {
      "name": "text",
      "type": "text"
    }
  ]
}

200

OK

[
  {
    "community": "text",
    "social": [
      {
        "name": "text",
        "type": "text"
      }
    ]
  }
]

Create/Insert chat message for Community/NFT/Group Messaging

post

Currently used for all messages outside of DMs

Authorizations

BearerAuth

AuthorizationstringRequired

Body

application/json

context_typestringOptional

fromaddrstringOptional

idintegerOptional

messagestringOptional

nftaddrstringOptional

sender_namestringOptional

timestampstringOptional

timestamp_dtmstringOptional

typestringOptional

Responses

200

OK

application/json

context_typestringOptional

fromaddrstringOptional

idintegerOptional

messagestringOptional

nftaddrstringOptional

sender_namestringOptional

timestampstringOptional

timestamp_dtmstringOptional

typestringOptional

post/v1/create_groupchatitem

HTTPcURLJavaScriptPython

POST /v1/create_groupchatitem 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

OK

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

Leave an NFT or Community group chat

post

Bookmarks keep an NFT/Community group chat in the sidebar

Authorizations

BearerAuth

AuthorizationstringRequired

Body

application/json

chainstringOptional

idintegerOptional

nftaddrstringOptional

walletaddrstringOptional

Responses

200

OK

application/json

chainstringOptional

idintegerOptional

nftaddrstringOptional

walletaddrstringOptional

post/v1/delete_bookmark

HTTPcURLJavaScriptPython

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

{
  "chain": "text",
  "id": 1,
  "nftaddr": "text",
  "walletaddr": "text"
}

200

OK

[
  {
    "chain": "text",
    "id": 1,
    "nftaddr": "text",
    "walletaddr": "text"
  }
]

Check if a wallet address has bookmarked/joined given NFT contract

get

This used for UI purposes, checking if a user/wallet has bookmarked a community.

Authorizations

BearerAuth

AuthorizationstringRequired

Path parameters

addressstringRequired

Wallet Address

Responses

200

OK

application/json

chainstringOptional

idintegerOptional

nftaddrstringOptional

walletaddrstringOptional

get/v1/get_bookmarks/{address}/

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "chain": "text",
    "id": 1,
    "nftaddr": "text",
    "walletaddr": "text"
  }
]

Check if a wallet address has bookmarked/joined given NFT contract

get

This used for UI purposes, checking if a user/wallet has bookmarked a community.

Authorizations

BearerAuth

AuthorizationstringRequired

Path parameters

walletaddrstringRequired

Wallet Address

nftaddrstringRequired

NFT Contract Address

Responses

200

OK

application/json

boolOptional

get/v1/get_bookmarks/{walletaddr}/{nftaddr}

HTTPcURLJavaScriptPython

GET /v1/get_bookmarks/{walletaddr}/{nftaddr} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get group chat items, given a wallt FROM address and NFT Contract Address

get

Get all group chat items for a given wallet (useraddress) for a given NFT Contract Address (TODO: fix up var names)

Authorizations

BearerAuth

AuthorizationstringRequired

Path parameters

addressstringRequired

NFT Address

useraddressstringRequired

FROM: wallet address

Responses

200

OK

application/json

context_typestringOptional

fromaddrstringOptional

idintegerOptional

messagestringOptional

nftaddrstringOptional

sender_namestringOptional

timestampstringOptional

timestamp_dtmstringOptional

typestringOptional

get/v1/get_groupchatitems/{address}/{useraddress}

HTTPcURLJavaScriptPython

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

200

OK

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

Get Unread Groupchat Items (TODO: cleanup naming convention here)

get

For group chat unread counts, currently the database stores a timestamp for each time a user enters a group chat. We though in the design it would be impractical to keep a read/unread count copy per user per message, but if this method doesn't proof to be fine grained enough, we could add a boolean relational table of read messgages per user.

Path parameters

namestringRequired

Common Name Mapped to User/Community

Responses

200

OK

text/plain

integerOptional

get/v1/get_groupchatitems_unreadcnt/{address}/{useraddress}

HTTPcURLJavaScriptPython

GET /v1/get_groupchatitems_unreadcnt/{address}/{useraddress} HTTP/1.1
Accept: */*

200

OK

1