Sequence API (1.0.0)

Download OpenAPI specification:Download

Sequence API

api

AddCurrencyGroup

Inventory, payments and management

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (CurrencyGroup)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/AddCurrencyGroup

Request samples

Payload
curl

application/json

{"currencyGroup": {"id": 0,
"name": "string",
"tokens": [{"chainId": 0,
"currencyGroupId": 0,
"id": 0,
"tokenAddress": "string"
}
]
}
}

Response samples

application/json

{"groupId": 0
}

AddFriend

SecurityApiKeyAuth

Request

Request Body schema: application/json

friendAddress	string
optionalNickname	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/AddFriend

Request samples

Payload
curl

application/json

{"friendAddress": "string",
"optionalNickname": "string"
}

Response samples

application/json

{"friend": {"createdAt": "string",
"friendAddress": "string",
"id": 0,
"nickname": "string",
"user": {"address": "string",
"avatar": "string",
"backup": true,
"backupConfirmed": true,
"bio": "string",
"createdAt": "string",
"locale": "string",
"location": "string",
"maxInvites": 0,
"normalizedUsername": "string",
"sysAdmin": true,
"updatedAt": "string",
"username": "string"
},
"userAddress": "string"
},
"status": true
}

AddInventoryPaymentConfig

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (InventoryPaymentConfig)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/AddInventoryPaymentConfig

Request samples

Payload
curl

application/json

{"config": {"allowCrossChainPayments": true,
"callbackURL": "string",
"chainId": 0,
"chainedCallAddress": "string",
"chainedCallData": "string",
"createdAt": "string",
"deletedAt": "string",
"externalProductId": "string",
"id": 0,
"paymentAmount": 0,
"paymentRecipient": "string",
"paymentTokenAddress": "string",
"paymentTokenId": 0,
"paymentTokenType": "ERC20",
"projectId": 0
}
}

Response samples

application/json

{"configId": 0
}

BlockNumberAtTime

Utils

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	number
timestamps	Array of numbers []uint64

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/BlockNumberAtTime

Request samples

Payload
curl

application/json

{"chainId": 0,
"timestamps": [0
]
}

Response samples

application/json

{"blocks": [0
]
}

Clock

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_Clock_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/Clock

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"serverTime": "string"
}

ContractCall

Chain-Utils

SecurityApiKeyAuth

Request

Request Body schema: application/json

args	Array of strings []string
chainID	string
contract	string
inputExpr	string
outputExpr	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/ContractCall

Request samples

Payload
curl

application/json

{"args": ["string"
],
"chainID": "string",
"contract": "string",
"inputExpr": "string",
"outputExpr": "string"
}

Response samples

application/json

{"returns": ["string"
]
}

DecodeContractCall

SecurityApiKeyAuth

Request

Request Body schema: application/json

callData

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/DecodeContractCall

Request samples

Payload
curl

application/json

{"callData": "string"
}

Response samples

application/json

{"call": {"args": [{"name": "string",
"type": "string",
"value": { }
}
],
"function": "string",
"signature": "string"
}
}

DeleteCurrencyGroup

SecurityApiKeyAuth

Request

Request Body schema: application/json

groupId

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/DeleteCurrencyGroup

Request samples

Payload
curl

application/json

{"groupId": 0
}

Response samples

application/json

{"ok": true
}

DeleteInventoryPaymentConfig

SecurityApiKeyAuth

Request

Request Body schema: application/json

configId

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/DeleteInventoryPaymentConfig

Request samples

Payload
curl

application/json

{"configId": 0
}

Response samples

application/json

{"ok": true
}

FriendList

Contacts / Friends

SecurityApiKeyAuth

Request

Request Body schema: application/json

nickname	string
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/FriendList

Request samples

Payload
curl

application/json

{"nickname": "string",
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"friends": [{"createdAt": "string",
"friendAddress": "string",
"id": 0,
"nickname": "string",
"user": {"address": "string",
"avatar": "string",
"backup": true,
"backupConfirmed": true,
"bio": "string",
"createdAt": "string",
"locale": "string",
"location": "string",
"maxInvites": 0,
"normalizedUsername": "string",
"sysAdmin": true,
"updatedAt": "string",
"username": "string"
},
"userAddress": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

GenerateWaaSVerificationURL

SecurityApiKeyAuth

Request

Request Body schema: application/json

walletAddress

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GenerateWaaSVerificationURL

Request samples

Payload
curl

application/json

{"walletAddress": "string"
}

Response samples

application/json

{"nonce": "string",
"verificationURL": "string"
}

GetAuthToken

Auth TODO: rename 'ewtString' arg to 'ethauthProof'

SecurityApiKeyAuth

Request

Request Body schema: application/json

ewtString	string
testnetMode	boolean

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetAuthToken

Request samples

Payload
curl

application/json

{"ewtString": "string",
"testnetMode": true
}

Response samples

application/json

{"address": "string",
"jwtToken": "string",
"status": true,
"user": {"address": "string",
"avatar": "string",
"backup": true,
"backupConfirmed": true,
"bio": "string",
"createdAt": "string",
"locale": "string",
"location": "string",
"maxInvites": 0,
"normalizedUsername": "string",
"sysAdmin": true,
"updatedAt": "string",
"username": "string"
}
}

GetAuthToken2

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
ewtString	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetAuthToken2

Request samples

Payload
curl

application/json

{"chainID": "string",
"ewtString": "string"
}

Response samples

application/json

{"address": "string",
"jwtToken": "string",
"status": true,
"user": {"address": "string",
"avatar": "string",
"backup": true,
"backupConfirmed": true,
"bio": "string",
"createdAt": "string",
"locale": "string",
"location": "string",
"maxInvites": 0,
"normalizedUsername": "string",
"sysAdmin": true,
"updatedAt": "string",
"username": "string"
}
}

GetCoinPrices

Price Feed

SecurityApiKeyAuth

Request

Request Body schema: application/json

Array of objects (Token)

[]Token

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetCoinPrices

Request samples

Payload
curl

application/json

{"tokens": [{"collectionId": 0,
"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"private": true,
"searchColumn": "string",
"tokenId": "string",
"updatedAt": "string"
}
]
}

Response samples

application/json

{"tokenPrices": [{"buyPrice": {"currency": "string",
"value": 0
},
"floorPrice": {"currency": "string",
"value": 0
},
"price": {"currency": "string",
"value": 0
},
"price24hChange": {"currency": "string",
"value": 0
},
"sellPrice": {"currency": "string",
"value": 0
},
"token": {"collectionId": 0,
"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"private": true,
"searchColumn": "string",
"tokenId": "string",
"updatedAt": "string"
},
"updatedAt": "string"
}
]
}

GetCollectiblePrices

SecurityApiKeyAuth

Request

Request Body schema: application/json

Array of objects (Token)

[]Token

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetCollectiblePrices

Request samples

Payload
curl

application/json

{"tokens": [{"collectionId": 0,
"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"private": true,
"searchColumn": "string",
"tokenId": "string",
"updatedAt": "string"
}
]
}

Response samples

application/json

{"tokenPrices": [{"buyPrice": {"currency": "string",
"value": 0
},
"floorPrice": {"currency": "string",
"value": 0
},
"price": {"currency": "string",
"value": 0
},
"price24hChange": {"currency": "string",
"value": 0
},
"sellPrice": {"currency": "string",
"value": 0
},
"token": {"collectionId": 0,
"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"private": true,
"searchColumn": "string",
"tokenId": "string",
"updatedAt": "string"
},
"updatedAt": "string"
}
]
}

GetExchangeRate

Price Feed utils

SecurityApiKeyAuth

Request

Request Body schema: application/json

toCurrency

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetExchangeRate

Request samples

Payload
curl

application/json

{"toCurrency": "string"
}

Response samples

application/json

{"exchangeRate": {"currencyType": "string",
"name": "string",
"symbol": "string",
"value": 0,
"vsCurrency": "string"
}
}

GetFriendByAddress

SecurityApiKeyAuth

Request

Request Body schema: application/json

friendAddress

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetFriendByAddress

Request samples

Payload
curl

application/json

{"friendAddress": "string"
}

Response samples

application/json

{"friend": {"createdAt": "string",
"friendAddress": "string",
"id": 0,
"nickname": "string",
"user": {"address": "string",
"avatar": "string",
"backup": true,
"backupConfirmed": true,
"bio": "string",
"createdAt": "string",
"locale": "string",
"location": "string",
"maxInvites": 0,
"normalizedUsername": "string",
"sysAdmin": true,
"updatedAt": "string",
"username": "string"
},
"userAddress": "string"
},
"status": true
}

GetInventoryPaymentConfig

SecurityApiKeyAuth

Request

Request Body schema: application/json

configId

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetInventoryPaymentConfig

Request samples

Payload
curl

application/json

{"configId": 0
}

Response samples

application/json

{"config": {"allowCrossChainPayments": true,
"callbackURL": "string",
"chainId": 0,
"chainedCallAddress": "string",
"chainedCallData": "string",
"createdAt": "string",
"deletedAt": "string",
"externalProductId": "string",
"id": 0,
"paymentAmount": 0,
"paymentRecipient": "string",
"paymentTokenAddress": "string",
"paymentTokenId": 0,
"paymentTokenType": "ERC20",
"projectId": 0
}
}

GetInviteInfo

Legacy

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_GetInviteInfo_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetInviteInfo

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"inviteInfo": {"expiryInHours": 0,
"invites": [{"code": "string",
"createdAt": "string",
"email": "string",
"expiresAt": "string",
"ownerAccount": "string",
"source": "string",
"url": "string",
"usesLeft": 0
}
],
"max": 0
}
}

GetLinkedWallets

SecurityApiKeyAuth

Request

Request Body schema: application/json

walletAddress

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetLinkedWallets

Request samples

Payload
curl

application/json

{"walletAddress": "string"
}

Response samples

application/json

{"linkedWallets": ["string"
]
}

GetMoonpayLink

Wallet utils

SecurityApiKeyAuth

Request

Request Body schema: application/json

url

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetMoonpayLink

Request samples

Payload
curl

application/json

{"url": "string"
}

Response samples

application/json

{"signedUrl": "string"
}

GetSardineClientToken

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_GetSardineClientToken_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetSardineClientToken

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"token": "string"
}

GetSardineNFTCheckoutOrderStatus

SecurityApiKeyAuth

Request

Request Body schema: application/json

orderId

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetSardineNFTCheckoutOrderStatus

Request samples

Payload
curl

application/json

{"orderId": "string"
}

Response samples

application/json

{"resp": {"contractAddress": "string",
"createdAt": "string",
"expiresAt": "string",
"fiatCurrency": "string",
"fiatExchangeRateUSD": 0,
"id": "string",
"imageUrl": "string",
"name": "string",
"networkFee": 0,
"paymentCurrency": "string",
"paymentMethodType": "string",
"price": 0,
"recipientAddress": "string",
"referenceId": "string",
"status": "string",
"subTotal": 0,
"total": 0,
"transactionFee": 0,
"transactionHash": "string",
"transactionId": "string",
"transactionType": "string"
}
}

GetSardineNFTCheckoutToken

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (NftCheckoutParams)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetSardineNFTCheckoutToken

Request samples

Payload
curl

application/json

{"params": {"approvedSpenderAddress": "string",
"blockchainNftId": "string",
"calldata": "string",
"contractAddress": "string",
"decimals": 0,
"imageUrl": "string",
"name": "string",
"network": "string",
"platform": "string",
"quantity": 0,
"recipientAddress": "string",
"tokenAddress": "string",
"tokenAmount": "string",
"tokenDecimals": 0,
"tokenSymbol": "string"
}
}

Response samples

application/json

{"resp": {"expiresAt": "string",
"orderId": "string",
"token": "string"
}
}

GetSequenceContext

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_GetSequenceContext_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetSequenceContext

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"data": {"factory": "string",
"guestModule": "string",
"mainModule": "string",
"mainModuleUpgradable": "string",
"utils": "string"
}
}

GetSwapQuotes

Currency abstraction

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	number
currencyAddress	string
currencyAmount	string
includeApprove	boolean
userAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/GetSwapQuotes

Request samples

Payload
curl

application/json

{"chainId": 0,
"currencyAddress": "string",
"currencyAmount": "string",
"includeApprove": true,
"userAddress": "string"
}

Response samples

application/json

{"swapQuotes": [{"approveData": "string",
"currencyAddress": "string",
"currencyBalance": "string",
"maxPrice": "string",
"price": "string",
"to": "string",
"transactionData": "string"
}
]
}

InternalClaimAccessCode

SecurityApiKeyAuth

Request

Request Body schema: application/json

accessCode	string
address	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/InternalClaimAccessCode

Request samples

Payload
curl

application/json

{"accessCode": "string",
"address": "string"
}

Response samples

application/json

{"status": true
}

IsValidAccessCode

NOTE: we're still using this from SW-API to Sequence-API to claim invite code

SecurityApiKeyAuth

Request

Request Body schema: application/json

accessCode

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/IsValidAccessCode

Request samples

Payload
curl

application/json

{"accessCode": "string"
}

Response samples

application/json

{"status": true
}

IsValidETHAuthProof

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	string
ethAuthProofString	string
walletAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/IsValidETHAuthProof

Request samples

Payload
curl

application/json

{"chainId": "string",
"ethAuthProofString": "string",
"walletAddress": "string"
}

Response samples

application/json

{"isValid": true
}

IsValidMessageSignature

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	string
message	string
signature	string
walletAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/IsValidMessageSignature

Request samples

Payload
curl

application/json

{"chainId": "string",
"message": "string",
"signature": "string",
"walletAddress": "string"
}

Response samples

application/json

{"isValid": true
}

IsValidSignature

TODO: we can add walletContext optional in the future when we need it NOTE: chainId can be either a number or canonical name

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	string
digest	string
signature	string
walletAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/IsValidSignature

Request samples

Payload
curl

application/json

{"chainId": "string",
"digest": "string",
"signature": "string",
"walletAddress": "string"
}

Response samples

application/json

{"isValid": true
}

IsValidTypedDataSignature

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	string
signature	string
typedData	object
walletAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/IsValidTypedDataSignature

Request samples

Payload
curl

application/json

{"chainId": "string",
"signature": "string",
"typedData": { },
"walletAddress": "string"
}

Response samples

application/json

{"isValid": true
}

LinkWallet

Linked wallets (v0 -- simple support)

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	string
ethAuthProofString	string
linkedWalletMessage	string
linkedWalletSignature	string
walletAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/LinkWallet

Request samples

Payload
curl

application/json

{"chainId": "string",
"ethAuthProofString": "string",
"linkedWalletMessage": "string",
"linkedWalletSignature": "string",
"walletAddress": "string"
}

Response samples

application/json

{"linkedWalletAddress": "string",
"status": true
}

ListCurrencyGroups

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_ListCurrencyGroups_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/ListCurrencyGroups

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"currencyGroups": [{"id": 0,
"name": "string",
"tokens": [{"chainId": 0,
"currencyGroupId": 0,
"id": 0,
"tokenAddress": "string"
}
]
}
]
}

ListInventoryPaymentConfigs

SecurityApiKeyAuth

Request

Request Body schema: application/json

projectId

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/ListInventoryPaymentConfigs

Request samples

Payload
curl

application/json

{"projectId": 0
}

Response samples

application/json

{"configs": [{"allowCrossChainPayments": true,
"callbackURL": "string",
"chainId": 0,
"chainedCallAddress": "string",
"chainedCallData": "string",
"createdAt": "string",
"deletedAt": "string",
"externalProductId": "string",
"id": 0,
"paymentAmount": 0,
"paymentRecipient": "string",
"paymentTokenAddress": "string",
"paymentTokenId": 0,
"paymentTokenType": "ERC20",
"projectId": 0
}
]
}

LookupContractCallSelectors

SecurityApiKeyAuth

Request

Request Body schema: application/json

selectors

Array of strings

[]string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/LookupContractCallSelectors

Request samples

Payload
curl

application/json

{"selectors": ["string"
]
}

Response samples

application/json

{"signatures": [["string"
]
]
}

MemoryLoad

SecurityApiKeyAuth

Request

Request Body schema: application/json

key

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/MemoryLoad

Request samples

Payload
curl

application/json

{"key": "string"
}

Response samples

application/json

{"value": "string"
}

MemoryStore

Util / misc

SecurityApiKeyAuth

Request

Request Body schema: application/json

key	string
value	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/MemoryStore

Request samples

Payload
curl

application/json

{"key": "string",
"value": "string"
}

Response samples

application/json

{"ok": true
}

PaperSessionSecret

Paper TODO: deprecate in the future

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainName	string
contractAddress	string
contractType	string
paramsJson	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/PaperSessionSecret

Request samples

Payload
curl

application/json

{"chainName": "string",
"contractAddress": "string",
"contractType": "string",
"paramsJson": "string"
}

Response samples

application/json

{"secret": "string"
}

PaperSessionSecret2

SecurityApiKeyAuth

Request

Request Body schema: application/json

abi	string
chainName	string
contractAddress	string
paramsJson	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/PaperSessionSecret2

Request samples

Payload
curl

application/json

{"abi": "string",
"chainName": "string",
"contractAddress": "string",
"paramsJson": "string"
}

Response samples

application/json

{"secret": "string"
}

Ping

Runtime

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_Ping_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/Ping

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"status": true
}

RemoveFriend

SecurityApiKeyAuth

Request

Request Body schema: application/json

friendAddress

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/RemoveFriend

Request samples

Payload
curl

application/json

{"friendAddress": "string"
}

Response samples

application/json

{"status": true
}

RemoveLinkedWallet

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	string
ethAuthProofString	string
linkedWalletMessage	string
linkedWalletSignature	string
walletAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/RemoveLinkedWallet

Request samples

Payload
curl

application/json

{"chainId": "string",
"ethAuthProofString": "string",
"linkedWalletMessage": "string",
"linkedWalletSignature": "string",
"walletAddress": "string"
}

Response samples

application/json

{"status": true
}

RequestInventoryPayment

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	number
configId	number
recipient	string
tokenAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/RequestInventoryPayment

Request samples

Payload
curl

application/json

{"chainId": 0,
"configId": 0,
"recipient": "string",
"tokenAddress": "string"
}

Response samples

application/json

{"payment": {"chainId": 0,
"expiration": "string",
"externalProductId": "string",
"inventoryPaymentConfigId": 0,
"paymentId": 0,
"paymentTokenAddress": "string",
"paymentTokenId": 0,
"paymentTokenType": "ERC20",
"paymentTotal": 0,
"signature": "string",
"txData": "string",
"txTo": "string"
}
}

ResolveENSAddress

IsUsingGoogleMail(domain: string) => (yes: bool)

SecurityApiKeyAuth

Request

Request Body schema: application/json

ens

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/ResolveENSAddress

Request samples

Payload
curl

application/json

{"ens": "string"
}

Response samples

application/json

{"address": "string",
"ok": true
}

RuntimeStatus

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_RuntimeStatus_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/RuntimeStatus

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"status": {"branch": "string",
"checks": { },
"commitHash": "string",
"healthOK": true,
"numTxnsRelayed": {"current": 0,
"period": 0,
"prev": 0
},
"senders": [{"active": true,
"address": "string",
"etherBalance": 0,
"index": 0
}
],
"startTime": "string",
"uptime": 0,
"useEIP1559": true,
"ver": "string"
}
}

SearchFriends

SecurityApiKeyAuth

Request

Request Body schema: application/json

filterUsername	string
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/SearchFriends

Request samples

Payload
curl

application/json

{"filterUsername": "string",
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"friends": [{"createdAt": "string",
"friendAddress": "string",
"id": 0,
"nickname": "string",
"user": {"address": "string",
"avatar": "string",
"backup": true,
"backupConfirmed": true,
"bio": "string",
"createdAt": "string",
"locale": "string",
"location": "string",
"maxInvites": 0,
"normalizedUsername": "string",
"sysAdmin": true,
"updatedAt": "string",
"username": "string"
},
"userAddress": "string"
}
]
}

SendPasswordlessLink

SecurityApiKeyAuth

Request

Request Body schema: application/json

email	string
intent	string
redirectUri	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/SendPasswordlessLink

Request samples

Payload
curl

application/json

{"email": "string",
"intent": "string",
"redirectUri": "string"
}

Response samples

application/json

{"status": true
}

UpdateCurrencyGroup

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (CurrencyGroup)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/UpdateCurrencyGroup

Request samples

Payload
curl

application/json

{"currencyGroup": {"id": 0,
"name": "string",
"tokens": [{"chainId": 0,
"currencyGroupId": 0,
"id": 0,
"tokenAddress": "string"
}
]
}
}

Response samples

application/json

{ }

UpdateFriendNickname

SecurityApiKeyAuth

Request

Request Body schema: application/json

friendAddress	string
nickname	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/UpdateFriendNickname

Request samples

Payload
curl

application/json

{"friendAddress": "string",
"nickname": "string"
}

Response samples

application/json

{"friend": {"createdAt": "string",
"friendAddress": "string",
"id": 0,
"nickname": "string",
"user": {"address": "string",
"avatar": "string",
"backup": true,
"backupConfirmed": true,
"bio": "string",
"createdAt": "string",
"locale": "string",
"location": "string",
"maxInvites": 0,
"normalizedUsername": "string",
"sysAdmin": true,
"updatedAt": "string",
"username": "string"
},
"userAddress": "string"
},
"status": true
}

UpdateInventoryPaymentConfig

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (InventoryPaymentConfig)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/UpdateInventoryPaymentConfig

Request samples

Payload
curl

application/json

{"config": {"allowCrossChainPayments": true,
"callbackURL": "string",
"chainId": 0,
"chainedCallAddress": "string",
"chainedCallData": "string",
"createdAt": "string",
"deletedAt": "string",
"externalProductId": "string",
"id": 0,
"paymentAmount": 0,
"paymentRecipient": "string",
"paymentTokenAddress": "string",
"paymentTokenId": 0,
"paymentTokenType": "ERC20",
"projectId": 0
}
}

Response samples

application/json

{ }

UserStorageDelete

SecurityApiKeyAuth

Request

Request Body schema: application/json

key

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/UserStorageDelete

Request samples

Payload
curl

application/json

{"key": "string"
}

Response samples

application/json

{"ok": true
}

UserStorageFetch

User Storage

SecurityApiKeyAuth

Request

Request Body schema: application/json

key

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/UserStorageFetch

Request samples

Payload
curl

application/json

{"key": "string"
}

Response samples

application/json

{"object": { }
}

UserStorageFetchAll

SecurityApiKeyAuth

Request

Request Body schema: application/json

keys	Array of strings []string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/UserStorageFetchAll

Request samples

Payload
curl

application/json

{"keys": ["string"
]
}

Response samples

application/json

{"objects": {"property1": { },
"property2": { }
}
}

UserStorageSave

SecurityApiKeyAuth

Request

Request Body schema: application/json

key	string
object	object

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/UserStorageSave

Request samples

Payload
curl

application/json

{"key": "string",
"object": { }
}

Response samples

application/json

{"ok": true
}

ValidateWaaSVerificationNonce

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	string
nonce	string
sessionId	string
signature	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/ValidateWaaSVerificationNonce

Request samples

Payload
curl

application/json

{"chainId": "string",
"nonce": "string",
"sessionId": "string",
"signature": "string"
}

Response samples

application/json

{"walletAddress": "string"
}

Version

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (API_Version_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/API/Version

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"version": {"appVersion": "string",
"schemaHash": "string",
"schemaVersion": "string",
"webrpcVersion": "string"
}
}

➔ Next to metadata