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

OK

4XX

Client error

5XX

Server error

post/rpc/API/AddCurrencyGroup
Request samples
application/json
{
  • "currencyGroup": {
    }
}
Response samples
application/json
{
  • "groupId": 0
}

AddFriend

SecurityApiKeyAuth
Request
Request Body schema: application/json
friendAddress
string
optionalNickname
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/AddFriend
Request samples
application/json
{
  • "friendAddress": "string",
  • "optionalNickname": "string"
}
Response samples
application/json
{
  • "friend": {
    },
  • "status": true
}

AddInventoryPaymentConfig

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (InventoryPaymentConfig)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/AddInventoryPaymentConfig
Request samples
application/json
{
  • "config": {
    }
}
Response samples
application/json
{
  • "configId": 0
}

BlockNumberAtTime

Utils

SecurityApiKeyAuth
Request
Request Body schema: application/json
chainId
number
timestamps
Array of numbers

[]uint64

Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/BlockNumberAtTime
Request samples
application/json
{
  • "chainId": 0,
  • "timestamps": [
    ]
}
Response samples
application/json
{
  • "blocks": [
    ]
}

Clock

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (API_Clock_Request)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/Clock
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/ContractCall
Request samples
application/json
{
  • "args": [
    ],
  • "chainID": "string",
  • "contract": "string",
  • "inputExpr": "string",
  • "outputExpr": "string"
}
Response samples
application/json
{
  • "returns": [
    ]
}

DecodeContractCall

SecurityApiKeyAuth
Request
Request Body schema: application/json
callData
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/DecodeContractCall
Request samples
application/json
{
  • "callData": "string"
}
Response samples
application/json
{
  • "call": {
    }
}

DeleteCurrencyGroup

SecurityApiKeyAuth
Request
Request Body schema: application/json
groupId
number
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/DeleteCurrencyGroup
Request samples
application/json
{
  • "groupId": 0
}
Response samples
application/json
{
  • "ok": true
}

DeleteInventoryPaymentConfig

SecurityApiKeyAuth
Request
Request Body schema: application/json
configId
number
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/DeleteInventoryPaymentConfig
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/FriendList
Request samples
application/json
{
  • "nickname": "string",
  • "page": {
    }
}
Response samples
application/json
{
  • "friends": [
    ],
  • "page": {
    }
}

GenerateWaaSVerificationURL

SecurityApiKeyAuth
Request
Request Body schema: application/json
walletAddress
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GenerateWaaSVerificationURL
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetAuthToken
Request samples
application/json
{
  • "ewtString": "string",
  • "testnetMode": true
}
Response samples
application/json
{
  • "address": "string",
  • "jwtToken": "string",
  • "status": true,
  • "user": {
    }
}

GetAuthToken2

SecurityApiKeyAuth
Request
Request Body schema: application/json
chainID
string
ewtString
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetAuthToken2
Request samples
application/json
{
  • "chainID": "string",
  • "ewtString": "string"
}
Response samples
application/json
{
  • "address": "string",
  • "jwtToken": "string",
  • "status": true,
  • "user": {
    }
}

GetCoinPrices

Price Feed

SecurityApiKeyAuth
Request
Request Body schema: application/json
Array of objects (Token)

[]Token

Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetCoinPrices
Request samples
application/json
{
  • "tokens": [
    ]
}
Response samples
application/json
{
  • "tokenPrices": [
    ]
}

GetCollectiblePrices

SecurityApiKeyAuth
Request
Request Body schema: application/json
Array of objects (Token)

[]Token

Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetCollectiblePrices
Request samples
application/json
{
  • "tokens": [
    ]
}
Response samples
application/json
{
  • "tokenPrices": [
    ]
}

GetExchangeRate

Price Feed utils

SecurityApiKeyAuth
Request
Request Body schema: application/json
toCurrency
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetExchangeRate
Request samples
application/json
{
  • "toCurrency": "string"
}
Response samples
application/json
{
  • "exchangeRate": {
    }
}

GetFriendByAddress

SecurityApiKeyAuth
Request
Request Body schema: application/json
friendAddress
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetFriendByAddress
Request samples
application/json
{
  • "friendAddress": "string"
}
Response samples
application/json
{
  • "friend": {
    },
  • "status": true
}

GetInventoryPaymentConfig

SecurityApiKeyAuth
Request
Request Body schema: application/json
configId
number
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetInventoryPaymentConfig
Request samples
application/json
{
  • "configId": 0
}
Response samples
application/json
{
  • "config": {
    }
}

GetInviteInfo

Legacy

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (API_GetInviteInfo_Request)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetInviteInfo
Request samples
application/json
{ }
Response samples
application/json
{
  • "inviteInfo": {
    }
}

GetLinkedWallets

SecurityApiKeyAuth
Request
Request Body schema: application/json
walletAddress
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetLinkedWallets
Request samples
application/json
{
  • "walletAddress": "string"
}
Response samples
application/json
{
  • "linkedWallets": [
    ]
}

GetSardineClientToken

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (API_GetSardineClientToken_Request)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetSardineClientToken
Request samples
application/json
{ }
Response samples
application/json
{
  • "token": "string"
}

GetSardineNFTCheckoutOrderStatus

SecurityApiKeyAuth
Request
Request Body schema: application/json
orderId
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetSardineNFTCheckoutOrderStatus
Request samples
application/json
{
  • "orderId": "string"
}
Response samples
application/json
{
  • "resp": {
    }
}

GetSardineNFTCheckoutToken

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (NftCheckoutParams)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetSardineNFTCheckoutToken
Request samples
application/json
{
  • "params": {
    }
}
Response samples
application/json
{
  • "resp": {
    }
}

GetSequenceContext

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (API_GetSequenceContext_Request)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetSequenceContext
Request samples
application/json
{ }
Response samples
application/json
{
  • "data": {
    }
}

GetSwapQuotes

Currency abstraction

SecurityApiKeyAuth
Request
Request Body schema: application/json
chainId
number
currencyAddress
string
currencyAmount
string
includeApprove
boolean
userAddress
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/GetSwapQuotes
Request samples
application/json
{
  • "chainId": 0,
  • "currencyAddress": "string",
  • "currencyAmount": "string",
  • "includeApprove": true,
  • "userAddress": "string"
}
Response samples
application/json
{
  • "swapQuotes": [
    ]
}

InternalClaimAccessCode

SecurityApiKeyAuth
Request
Request Body schema: application/json
accessCode
string
address
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/InternalClaimAccessCode
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/IsValidAccessCode
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/IsValidETHAuthProof
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/IsValidMessageSignature
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/IsValidSignature
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/IsValidTypedDataSignature
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/LinkWallet
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/ListCurrencyGroups
Request samples
application/json
{ }
Response samples
application/json
{
  • "currencyGroups": [
    ]
}

ListInventoryPaymentConfigs

SecurityApiKeyAuth
Request
Request Body schema: application/json
projectId
number
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/ListInventoryPaymentConfigs
Request samples
application/json
{
  • "projectId": 0
}
Response samples
application/json
{
  • "configs": [
    ]
}

LookupContractCallSelectors

SecurityApiKeyAuth
Request
Request Body schema: application/json
selectors
Array of strings

[]string

Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/LookupContractCallSelectors
Request samples
application/json
{
  • "selectors": [
    ]
}
Response samples
application/json
{
  • "signatures": [
    ]
}

MemoryLoad

SecurityApiKeyAuth
Request
Request Body schema: application/json
key
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/MemoryLoad
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/MemoryStore
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/PaperSessionSecret
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/PaperSessionSecret2
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/Ping
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": true
}

RemoveFriend

SecurityApiKeyAuth
Request
Request Body schema: application/json
friendAddress
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/RemoveFriend
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/RemoveLinkedWallet
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/RequestInventoryPayment
Request samples
application/json
{
  • "chainId": 0,
  • "configId": 0,
  • "recipient": "string",
  • "tokenAddress": "string"
}
Response samples
application/json
{
  • "payment": {
    }
}

ResolveENSAddress

  • IsUsingGoogleMail(domain: string) => (yes: bool)
SecurityApiKeyAuth
Request
Request Body schema: application/json
ens
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/ResolveENSAddress
Request samples
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

OK

4XX

Client error

5XX

Server error

post/rpc/API/RuntimeStatus
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": {
    }
}

SearchFriends

SecurityApiKeyAuth
Request
Request Body schema: application/json
filterUsername
string
object (Page)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/SearchFriends
Request samples
application/json
{
  • "filterUsername": "string",
  • "page": {
    }
}
Response samples
application/json
{
  • "friends": [
    ]
}

UpdateCurrencyGroup

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (CurrencyGroup)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/UpdateCurrencyGroup
Request samples
application/json
{
  • "currencyGroup": {
    }
}
Response samples
application/json
{ }

UpdateFriendNickname

SecurityApiKeyAuth
Request
Request Body schema: application/json
friendAddress
string
nickname
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/UpdateFriendNickname
Request samples
application/json
{
  • "friendAddress": "string",
  • "nickname": "string"
}
Response samples
application/json
{
  • "friend": {
    },
  • "status": true
}

UpdateInventoryPaymentConfig

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (InventoryPaymentConfig)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/API/UpdateInventoryPaymentConfig
Request samples
application/json
{
  • "config": {