Introduction
API Documentation of tokenlist.club
Base url : https://api-multichain.tokenlist.club/graphql
Users
All the APIs related to users goes here
Login
This API is for login to user account
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json |
Request
{
login_with_otp(email: "johndoe@gmail.com", otp: "12345") {
token
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| string | email of the user | ✔ | |
| otp | string | OTP received on the registered email | ✔ |
Success
{
"data": {
"login_with_otp": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiYWRtaW4iLCJhY2NvdW50VHlwZSI6ImFkbWluIiwiaWF0IjoxNjUyMzI4MjAyLCJleHAiOjE2NTIzNDk4MDJ9.qPBFexWB-bYK3P5o9SvoJIiUABnJJ80baKqfw8Uj6Hw"
}
}
}
Error
{
"errors": [
{
"message": "Email not registered",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["login_with_otp"]
}
],
"data": {
"login_with_otp": null
}
}
{
"errors": [
{
"message": "Incorrect OTP",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["login_with_otp"]
}
],
"data": {
"login_with_otp": null
}
}
Send OTP
This API is to send OTP to registered email address of the user for login
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | MUTATION | ||
| content-type | string | JSON | application/json |
Request
mutation {
send_otp(email: "johndoe@gmail.com") {
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| string | registered email of the user | ✔ |
Success
{
"data": {
"send_otp": {
"message": "OTP sent successfully"
}
}
}
Error
{
"errors": [
{
"message": "email not registered",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["send_otp"]
}
],
"data": {
"send_otp": null
}
}
Fetch All Transactions
This API is to fetch all transactions of a user
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json | |
| x-access-token | string | session token with validity | token | user token |
Request
{
list_all_transactions(page_size: 3, page_number: 1, status: "") {
message
data {
_id
txn_id
txn_signature
type
amount
status
chain_network
currency
created_at
from_user_wid
to_user_wid
from_uid {
_id
name
email
}
to_uid {
_id
name
email
}
}
hasMore
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| page_size | integer | total number of data to be displayed | ✘ |
| page_number | integer | page number to filter data | ✘ |
| status | string | to filter data based on Transaction status | ✘ |
Success
{
"data": {
"list_all_transactions": {
"message": "data listed",
"data": [
{
"_id": "63a5a59713f58d8ea3a9583d",
"txn_id": "txn_EwuZBkEwPhQsQsFtEwMl",
"txn_signature": "0x0750d981164ede92dd1854c03ff841e92254d6556dab9d68d04517bbb5e716ed",
"type": "transferred",
"amount": 0.001,
"status": "success",
"chain_network": "polygon_matic",
"currency": "matic",
"created_at": 1671800215,
"from_user_wid": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"to_user_wid": "0x8021C646fC19Af88a8C6b8304FE33af29f521CCd",
"from_uid": {
"_id": "6361f2c3896b1861246f81cc",
"name": "Sachin T S",
"email": "sachinsuresh704@gmail.com"
},
"to_uid": {
"_id": "638de5cb92d3e06365e3e97a",
"name": "sachin",
"email": "sachin@paysack.com"
}
},
{
"_id": "63a5987a6892e35e5471750e",
"txn_id": "txn_EwuZBkEwBkCxuZPhMlPh",
"txn_signature": "0x43d379dd1aaa97deeca306ca75e4a6a1de0f95de76176cdac4e145df258949e6",
"type": "transferred",
"amount": 0.001,
"status": "success",
"chain_network": "polygon_matic",
"currency": "matic",
"created_at": 1671796858,
"from_user_wid": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"to_user_wid": "0xA3131A125F6f2a3914560C93328AA7878C990A17",
"from_uid": {
"_id": "6361f2c3896b1861246f81cc",
"name": "Sachin T S",
"email": "sachinsuresh704@gmail.com"
},
"to_uid": null
},
{
"_id": "63a598636892e37591717505",
"txn_id": "txn_EwuZBkEwBkCxuZPhvgMl",
"txn_signature": null,
"type": "transferred",
"amount": 0.001,
"status": "failed",
"chain_network": "polygon_matic",
"currency": "matic",
"created_at": 1671796835,
"from_user_wid": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"to_user_wid": "0xA3131A125F6f2a3914560C93328AA7878C990A17",
"from_uid": {
"_id": "6361f2c3896b1861246f81cc",
"name": "Sachin T S",
"email": "sachinsuresh704@gmail.com"
},
"to_uid": null
}
],
"hasMore": true
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["list_all_transactions"]
}
],
"data": {
"list_all_transactions": null
}
}
Fetch User Profile
This API is to fetch profile details of a user
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json | |
| x-access-token | string | session token with validity | token | user token |
Request
{
user_profile {
data {
_id
name
user_name
email
img
wallets {
_id
wallet_address
balance
network
}
}
}
}
Request Parameters
Success
{
"data": {
"user_profile": {
"data": {
"_id": "6361f2c3896b1861246f81cc",
"name": "Sachin T S",
"user_name": "sachints1524",
"email": "sachinsuresh704@gmail.com",
"img": null,
"wallets": [
{
"_id": "6361f2d5896b181aa46f81d3",
"wallet_address": "8jULEWgWBsFoxGGBGgrD3tBGFsXNcKrDzbHRNgkrnTZf",
"balance": null,
"network": "solana"
},
{
"_id": "6361f2d5896b18be1a6f81d6",
"wallet_address": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"balance": null,
"network": "ethereum"
},
{
"_id": "6361f2d5896b1837676f81da",
"wallet_address": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"balance": null,
"network": "avalanche"
},
{
"_id": "6361f2d5896b186b066f81de",
"wallet_address": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"balance": null,
"network": "polygon"
},
{
"_id": "637377717678c447cd084937",
"wallet_address": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"balance": null,
"network": "eth_usdc"
},
{
"_id": "637377717678c4248108493b",
"wallet_address": "8jULEWgWBsFoxGGBGgrD3tBGFsXNcKrDzbHRNgkrnTZf",
"balance": null,
"network": "sol_usdc"
},
{
"_id": "637377717678c47ff108493f",
"wallet_address": "8jULEWgWBsFoxGGBGgrD3tBGFsXNcKrDzbHRNgkrnTZf",
"balance": null,
"network": "sol_usdt"
},
{
"_id": "63a421fa5cf19581bb24e187",
"wallet_address": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"balance": null,
"network": "polygon_matic"
},
{
"_id": "63a421fa5cf195f2c024e18b",
"wallet_address": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"balance": null,
"network": "polygon_usdc"
},
{
"_id": "63a421fa5cf19588f724e18f",
"wallet_address": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"balance": null,
"network": "polygon_usdt"
}
]
}
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["user_profile"]
}
],
"data": {
"user_profile": null
}
}
Fetch Wallet Balance
This API is to fetch wallet balance of a user based on network
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json | |
| x-access-token | string | session token with validity | token | user token |
Request
{
list_wallet_balance(network: "solana") {
message
data {
wallet_address
balance
network
}
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| network | string | the network identifier from wallets' list of profile API | ✔ |
Success
{
"data": {
"list_wallet_balance": {
"message": "data listed",
"data": {
"wallet_address": "8jULEWgWBsFoxGGBGgrD3tBGFsXNcKrDzbHRNgkrnTZf",
"balance": 0.00398,
"network": "solana"
}
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["list_wallet_balance"]
}
],
"data": {
"list_wallet_balance": null
}
}
Share Profile LInk
This API is to share users profile link to anyone using email
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json | |
| x-access-token | string | session token with validity | token | user token |
Request
{
share_qr_link(email: "johndoe@gmail.com") {
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| string | email address to share the profile link | ✔ |
Success
{
"data": {
"share_qr_link": {
"message": "QR link Shared"
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["share_qr_link"]
}
],
"data": {
"share_qr_link": null
}
}
Fetch All Blockchain Transactions
This API is to fetch all blockchain transactions of a user
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json | |
| x-access-token | string | session token with validity | token | user token |
Request
{
list_blockchain_txn_history(network:"solana",page_size:3,page_number:1){
message
data {
blockNumber
timeStamp
hash
nonce
blockHash
transactionIndex
from
to
value
gas
gasPrice
isError
txreceipt_status
input
contractAddress
cumulativeGasUsed
gasUsed
confirmations
methodId
functionName
status
token_address
token_symbol
}
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| page_size | integer | total number of data to be displayed | ✘ |
| page_number | integer | page number to filter data | ✘ |
| network | string | the network identifier from wallets' list of profile API | ✘ |
Success
{
"data": {
"list_blockchain_txn_history": {
"message": "data listed",
"data": [
{
"blockNumber": null,
"timeStamp": "08-12-2022 14:20",
"hash": "5473rbujEFRCJBJUdh2v7b2UYniUhFLcbGSuFBNeQnqiT39eX98aAFU3mJ2NJSM2TeZUgvr9BQKBnArNnueLYURa",
"nonce": null,
"blockHash": null,
"transactionIndex": null,
"from": "AiEPUsSCS7MSAopZS81mvgKANquy1Tdw3d2TTtAVPLBX",
"to": "8jULEWgWBsFoxGGBGgrD3tBGFsXNcKrDzbHRNgkrnTZf",
"value": 0.001,
"gas": null,
"gasPrice": null,
"isError": null,
"txreceipt_status": null,
"input": null,
"contractAddress": null,
"cumulativeGasUsed": null,
"gasUsed": null,
"confirmations": null,
"methodId": null,
"functionName": null,
"status": "Success",
"token_address": null,
"token_symbol": null
},
{
"blockNumber": null,
"timeStamp": "08-12-2022 14:00",
"hash": "2R6YytAsgBvk6crLWGaQXbCgjPanKfsn58eo2bddtJdSsMPPBM6VCowdxBzsdWv97PMd3prVrEPHnHmUD19pyLp7",
"nonce": null,
"blockHash": null,
"transactionIndex": null,
"from": "AiEPUsSCS7MSAopZS81mvgKANquy1Tdw3d2TTtAVPLBX",
"to": "8jULEWgWBsFoxGGBGgrD3tBGFsXNcKrDzbHRNgkrnTZf",
"value": 0.001,
"gas": null,
"gasPrice": null,
"isError": null,
"txreceipt_status": null,
"input": null,
"contractAddress": null,
"cumulativeGasUsed": null,
"gasUsed": null,
"confirmations": null,
"methodId": null,
"functionName": null,
"status": "Success",
"token_address": null,
"token_symbol": null
},
{
"blockNumber": null,
"timeStamp": "07-12-2022 13:37",
"hash": "4XDxcxoyWe7MD8ohUxqAyERnSVcCoS5vRNnFJhFBH19zxAPodrvhu788hNzWJiBcXvnFxBwcyjpet2x9RpP1h7ic",
"nonce": null,
"blockHash": null,
"transactionIndex": null,
"from": "AiEPUsSCS7MSAopZS81mvgKANquy1Tdw3d2TTtAVPLBX",
"to": "8jULEWgWBsFoxGGBGgrD3tBGFsXNcKrDzbHRNgkrnTZf",
"value": 0.001,
"gas": null,
"gasPrice": null,
"isError": null,
"txreceipt_status": null,
"input": null,
"contractAddress": null,
"cumulativeGasUsed": null,
"gasUsed": null,
"confirmations": null,
"methodId": null,
"functionName": null,
"status": "Success",
"token_address": null,
"token_symbol": null
}
]
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["list_blockchain_txn_history"]
}
],
"data": {
"list_blockchain_txn_history": null
}
}
Fetch All Transactions
This API is to fetch all transactions of a user
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json | |
| x-access-token | string | session token with validity | token | user token |
Request
{
list_all_transactions(page_size: 3, page_number: 1, status: "") {
message
data {
_id
txn_id
txn_signature
type
amount
status
chain_network
currency
created_at
from_user_wid
to_user_wid
from_uid {
_id
name
email
}
to_uid {
_id
name
email
}
}
hasMore
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| page_size | integer | total number of data to be displayed | ✘ |
| page_number | integer | page number to filter data | ✘ |
| status | string | to filter data based on Transaction status | ✘ |
Success
{
"data": {
"list_all_transactions": {
"message": "data listed",
"data": [
{
"_id": "63a5a59713f58d8ea3a9583d",
"txn_id": "txn_EwuZBkEwPhQsQsFtEwMl",
"txn_signature": "0x0750d981164ede92dd1854c03ff841e92254d6556dab9d68d04517bbb5e716ed",
"type": "transferred",
"amount": 0.001,
"status": "success",
"chain_network": "polygon_matic",
"currency": "matic",
"created_at": 1671800215,
"from_user_wid": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"to_user_wid": "0x8021C646fC19Af88a8C6b8304FE33af29f521CCd",
"from_uid": {
"_id": "6361f2c3896b1861246f81cc",
"name": "Sachin T S",
"email": "sachinsuresh704@gmail.com"
},
"to_uid": {
"_id": "638de5cb92d3e06365e3e97a",
"name": "sachin",
"email": "sachin@paysack.com"
}
},
{
"_id": "63a5987a6892e35e5471750e",
"txn_id": "txn_EwuZBkEwBkCxuZPhMlPh",
"txn_signature": "0x43d379dd1aaa97deeca306ca75e4a6a1de0f95de76176cdac4e145df258949e6",
"type": "transferred",
"amount": 0.001,
"status": "success",
"chain_network": "polygon_matic",
"currency": "matic",
"created_at": 1671796858,
"from_user_wid": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"to_user_wid": "0xA3131A125F6f2a3914560C93328AA7878C990A17",
"from_uid": {
"_id": "6361f2c3896b1861246f81cc",
"name": "Sachin T S",
"email": "sachinsuresh704@gmail.com"
},
"to_uid": null
},
{
"_id": "63a598636892e37591717505",
"txn_id": "txn_EwuZBkEwBkCxuZPhvgMl",
"txn_signature": null,
"type": "transferred",
"amount": 0.001,
"status": "failed",
"chain_network": "polygon_matic",
"currency": "matic",
"created_at": 1671796835,
"from_user_wid": "0xb26ADf2C03dA6Ab59029ab8F2eC365479d48a15d",
"to_user_wid": "0xA3131A125F6f2a3914560C93328AA7878C990A17",
"from_uid": {
"_id": "6361f2c3896b1861246f81cc",
"name": "Sachin T S",
"email": "sachinsuresh704@gmail.com"
},
"to_uid": null
}
],
"hasMore": true
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["list_all_transactions"]
}
],
"data": {
"list_all_transactions": null
}
}
Register new user
This API is to register a new user
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | MUTATION | ||
| content-type | string | JSON | application/json |
Request
mutation {
register_new_user(email: "sachinsuresh704@gmail.com", name: "sachin", referral_code: "") {
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| string | email of the user | ✔ | |
| name | string | name of the user | ✔ |
| referral_code | string | referral code | ✘ |
Success
{
"data": {
"register_new_user": {
"message": "OTP sent successfully"
}
}
}
Error
{
"errors": [
{
"message": "email already registered",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["register_new_user"]
}
],
"data": {
"register_new_user": null
}
}
Verify New User
This API is for verifying newly registered user
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | QUERY | ||
| content-type | string | JSON | application/json |
Request
query{
verify_new_account(email:"sachinsuresh704@gmail.com",otp:"12345"){
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| string | email of the user | ✔ | |
| otp | string | OTP received on the registered email | ✔ |
Success
{
"data": {
"verify_new_account": {
"message": "User account Verified"
}
}
}
Error
{
"errors": [
{
"message": "Incorrect OTP",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["verify_new_account"]
}
],
"data": {
"verify_new_account": null
}
}
Send Cryptocurrency To Email
This API is to send cryptocurrency to email
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | MUTATION | ||
| content-type | string | JSON | application/json |
Request
mutation {
send_crypto_to_email(email: "sachin@paysack.com", network: "solana", amount: 0.001) {
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| string | email of the user | ✔ | |
| network | string | the network identifier from wallets' list of profile API | ✔ |
| amount | float | amount wants to send | ✔ |
Success
{
"data": {
"send_crypto_to_email": {
"message": "Transaction was successfull"
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["send_crypto_to_email"]
}
],
"data": {
"send_crypto_to_email": null
}
}
Send Cryptocurrency To Wallet
This API is to send cryptocurrency to wallet
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | MUTATION | ||
| content-type | string | JSON | application/json |
Request
mutation {
send_crypto_to_wallet(wallet_address: "9b3RBztwiSM4DFvoHtr6nENRZxfQkmJcfxY4VSWVSBrH", amount: 0.001, network: "solana") {
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| wallet_address | string | recipient's wallet address | ✔ |
| network | string | the network identifier from wallets' list of profile API | ✔ |
| amount | float | amount wants to send | ✔ |
Success
{
"data": {
"send_crypto_to_wallet": {
"message": "Transaction was successfull"
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["send_crypto_to_wallet"]
}
],
"data": {
"send_crypto_to_wallet": null
}
}
Update Profile
This API is to update user's profile
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | MUTATION | ||
| content-type | string | JSON | application/json |
Request
mutation {
update_user_profile(name:"sachin"){
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| name | string | name of the user | ✔ |
Success
{
"data": {
"update_user_profile": {
"message": "Profile details updated"
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["update_user_profile"]
}
],
"data": {
"update_user_profile": null
}
}
Send Payment Request
The purpose of this API is to send a payment request to another user.
GRAPHQL
Headers
| Fields | Type | Description | Example | Data Management |
|---|---|---|---|---|
| URL | string | {base_url}/users | ||
| GRAPHQL | string | MUTATION | ||
| content-type | string | JSON | application/json |
Request
mutation {
send_payment_request(email: "sachin@paysack.com", network: "solana", amount: 0.01) {
message
}
}
Request Parameters
| Fields | Type | Description | Required |
|---|---|---|---|
| string | email of the user | ✔ | |
| network | string | the network identifier from wallets' list of profile API | ✔ |
| amount | float | requesting amount | ✔ |
Success
{
"data": {
"send_payment_request": {
"message": "Request sent successfully"
}
}
}
Error
{
"errors": [
{
"message": "Unauthorized",
"locations": [
{
"line": 2,
"column": 3
}
],
"path": ["send_payment_request"]
}
],
"data": {
"send_payment_request": null
}
}