Core Engine Publisher 1.0.0

Operations

• SEND accounts

  Operation IDpublishAccounts

  Accepts one of the following messages:

  • #0CreateAccount

    Message IDCreateAccount

    Payload

    Expand all

    object

    id

    string

    logicalChainId

    string

    format: int32

    address

    string

    vesselKey

    string

    feeLevel

    string

    status

    string

    Allowed values:
    • "ACTIVE"
    • "SUSPENDED"

    registeredOnChain

    boolean

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateAccount"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "id": "1727077698601001",
      "logicalChainId": "31337",
      "address": "0xC38C2c17fC38fb8fF575BDd3b7fcF04b8274a7B5",
      "vesselKey": "0xa33c4f4d9c546b0dd1bb88e5746b3f569b8a9750bac6813875cf5edc22cf599ef8a8110ac7fec9bdea811369cb4588e14e5eec87cbd41c4c39e91b680a9fce7a",
      "feeLevel": "0",
      "status": "ACTIVE",
      "registeredOnChain": true
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateAccount",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #1UpdateAccount

    Message IDUpdateAccount

    Payload

    Expand all

    object

    id

    string

    feeLevel

    string

    status

    string

    Allowed values:
    • "ACTIVE"
    • "SUSPENDED"

    registeredOnChain

    boolean

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"UpdateAccount"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "id": "1727077698601001",
      "feeLevel": "0",
      "status": "ACTIVE",
      "registeredOnChain": true
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "UpdateAccount",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #2Deposit

    Message IDDeposit

    Payload

    Expand all

    object

    logicalChainId

    string

    format: int32

    amount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    transactionFee

    string

    format: decimal

    交易费用

    assetName

    string

    资产名称

    transactionHash

    string

    区块链交易哈希值

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"Deposit"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "logicalChainId": "31337",
      "amount": "4224",
      "transactionFee": "0",
      "assetName": "WBTC",
      "transactionHash": "0xxxxxx",
      "nonce": "string"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "Deposit",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #3Withdraw

    Message IDWithdraw

    Payload

    Expand all

    object

    logicalChainId

    string

    format: int32

    amount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    transactionFee

    string

    format: decimal

    交易费用

    assetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"Withdraw"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "logicalChainId": "31337",
      "amount": "4224",
      "transactionFee": "0",
      "assetName": "WBTC",
      "nonce": "string"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "Withdraw",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #4Transfer

    Message IDTransfer

    Payload

    Expand all

    object

    amount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    transactionFee

    string

    format: decimal

    交易费用

    assetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    toAddress

    string

    toUid

    string

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"Transfer"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "amount": "4224",
      "transactionFee": "0",
      "assetName": "WBTC",
      "nonce": "string",
      "toAddress": "0xC38C2c17fC38fb8fF575BDd3b7fcF04b8274a7B5",
      "toUid": "1727077698601001"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "Transfer",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #5FastWithdraw

    Message IDFastWithdraw

    Payload

    Expand all

    object

    logicalChainId

    string

    format: int32

    amount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    assetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    reserveId

    string

    reserve id

    transferAmount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"FastWithdraw"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "logicalChainId": "31337",
      "amount": "4224",
      "assetName": "WBTC",
      "reserveId": "123456789",
      "transferAmount": "4224"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "FastWithdraw",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #6CreateOrder

    Message IDCreateOrder

    Payload

    Expand all

    object

    Spot order basic info

    uid

    string

    orderId

    string

    Order ID

    symbolName

    string

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    transactTime

    string

    transact time in milliseconds

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    originSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    type

    string

    Allowed values:
    • "LIMIT"
    • "MARKET"

    side

    string

    Allowed values:
    • "BUY"
    • "SELL"

    timeInForce

    string

    Allowed values:
    • "GTC"
    • "FOK"
    • "IOC"

    takerFeeRate

    string

    [ 0 .. 1 ]

    makerFeeRate

    string

    [ 0 .. 1 ]

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateOrder"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "uid": "1727077698601001",
      "orderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "nonce": "string",
      "transactTime": "1507725176595",
      "price": "123",
      "originSize": "4224",
      "type": "LIMIT",
      "side": "BUY",
      "timeInForce": "GTC",
      "takerFeeRate": "0.0001",
      "makerFeeRate": "0.0001"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateOrder",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #7CloseOrder

    Message IDCloseOrder

    Payload

    Expand all

    allOf

    Consists of:

    Expand all

    object

    Spot order basic info

    uid

    string

    orderId

    string

    Order ID

    symbolName

    string

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    transactTime

    string

    transact time in milliseconds

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    originSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    type

    string

    Allowed values:
    • "LIMIT"
    • "MARKET"

    side

    string

    Allowed values:
    • "BUY"
    • "SELL"

    timeInForce

    string

    Allowed values:
    • "GTC"
    • "FOK"
    • "IOC"

    takerFeeRate

    string

    [ 0 .. 1 ]

    makerFeeRate

    string

    [ 0 .. 1 ]

    Additional properties are allowed.

    And of:

    Expand all

    object

    spot order update info

    uid

    string

    orderId

    string

    Order ID

    executedSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    cumulativeQuoteSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    status

    string

    order close reason

    Allowed values:
    • "FILLED"
    • "CANCELED"
    • "IOC_EXPIRED"

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CloseOrder"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "uid": "1727077698601001",
      "orderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "nonce": "string",
      "transactTime": "1507725176595",
      "price": "123",
      "originSize": "4224",
      "type": "LIMIT",
      "side": "BUY",
      "timeInForce": "GTC",
      "takerFeeRate": "0.0001",
      "makerFeeRate": "0.0001",
      "executedSize": "4224",
      "cumulativeQuoteSize": "4224",
      "status": "FILLED"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CloseOrder",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #8Trade

    Message IDTrade

    Payload

    Expand all

    object

    tradeDedupId

    string

    format: int64

    同一个seq id中值要求唯一

    makerUid

    string

    takerUid

    string

    makerOrderId

    string

    Order ID

    takerOrderId

    string

    Order ID

    symbolName

    string

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    size

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    takerSide

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    makerFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    takerFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"Trade"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "tradeDedupId": "string",
      "makerUid": "1727077698601001",
      "takerUid": "1727077698601001",
      "makerOrderId": "1721801324586001",
      "takerOrderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "price": "123",
      "size": "4224",
      "takerSide": "4224",
      "makerFee": "4224",
      "takerFee": "4224"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "Trade",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #9AmmTrade

    Message IDAmmTrade

    Payload

    Expand all

    object

    tradeDedupId

    string

    format: int64

    同一个seq id中值要求唯一

    poolId

    string

    format: int32

    takerUid

    string

    makerOrderId

    string

    Order ID

    takerOrderId

    string

    Order ID

    symbolName

    string

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    size

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    takerSide

    string

    Allowed values:
    • "BUY"
    • "SELL"

    arbitrageFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    takerFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"AmmTrade"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "tradeDedupId": "string",
      "poolId": "12",
      "takerUid": "1727077698601001",
      "makerOrderId": "1721801324586001",
      "takerOrderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "price": "123",
      "size": "4224",
      "takerSide": "BUY",
      "arbitrageFee": "4224",
      "takerFee": "4224"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "AmmTrade",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #10AmmAddLiquidity

    Message IDAmmAddLiquidity

    Payload

    Expand all

    object

    symbolName

    string

    poolId

    string

    池子 ID

    tickL

    string

    左侧 tick 值

    tickR

    string

    右侧 tick 值

    baseAssetAmount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    quoteAssetAmount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    baseAssetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    quoteAssetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    liquidityDelta

    string

    liquidity delta per tick

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"AmmAddLiquidity"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "symbolName": "ETHUSDT",
      "poolId": "string",
      "tickL": "string",
      "tickR": "string",
      "baseAssetAmount": "4224",
      "quoteAssetAmount": "4224",
      "baseAssetName": "WBTC",
      "quoteAssetName": "WBTC",
      "nonce": "string",
      "liquidityDelta": "12345678"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "AmmAddLiquidity",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #11AmmRemoveLiquidity

    Message IDAmmRemoveLiquidity

    Payload

    Expand all

    object

    symbolName

    string

    poolId

    string

    池子 ID

    tickL

    string

    左侧 tick 值

    tickR

    string

    右侧 tick 值

    baseAssetFeeAmount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    quoteAssetFeeAmount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    baseAssetAmount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    quoteAssetAmount

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    baseAssetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    quoteAssetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    liquidityDelta

    string

    liquidity delta per tick

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"AmmRemoveLiquidity"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "symbolName": "ETHUSDT",
      "poolId": "string",
      "tickL": "string",
      "tickR": "string",
      "baseAssetFeeAmount": "4224",
      "quoteAssetFeeAmount": "4224",
      "baseAssetAmount": "4224",
      "quoteAssetAmount": "4224",
      "baseAssetName": "WBTC",
      "quoteAssetName": "WBTC",
      "nonce": "string",
      "liquidityDelta": "12345678"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "AmmRemoveLiquidity",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #12AssetUpdate

    Message IDAssetUpdate

    Payload

    Expand all

    array<object>

    object

    user asset balance detail

    assetId

    string

    字段值要求唯一, int32

    available

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    inUse

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"UserAssetUpdate"

    Allowed values:
    • "CreateAccount"
    • "UpdateAccount"
    • "Deposit"
    • "Withdraw"
    • "Transfer"
    • "FastWithdraw"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"
    • "AmmAddLiquidity"
    • "AmmRemoveLiquidity"
    • "AmmCollectFee"
    • "UserAssetUpdate"

    seqId

    required

    integer

    format: int64

    userId

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    [
      {
        "assetId": "3",
        "available": "4224",
        "inUse": "4224"
      }
    ]
    

    This example has been generated automatically.

    Headers

    {
      "type": "UserAssetUpdate",
      "seqId": 0,
      "userId": "1727077698601001",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

• SEND spots

  Operation IDpublishSpots

  Accepts one of the following messages:

  • #0CreateSymbol

    Message IDCreateSymbol

    Payload

    Expand all

    object

    symbolId

    required

    string

    值要求唯一, int32

    symbolName

    required

    string

    baseAssetId

    required

    string

    字段值要求唯一, int32

    quoteAssetId

    required

    string

    字段值要求唯一, int32

    baseDecimal

    required

    string

    format: int32

    priceDecimal

    required

    string

    format: int32

    makerFeeDiscount

    required

    string

    format: int32[ 0 .. 100 ]

    in range [0, 100]

    takerFeeDiscount

    required

    string

    format: int32[ 0 .. 100 ]

    in range [0, 100]

    minTradingSize

    required

    string

    maxTradingSize

    required

    string

    maxPrice

    required

    string

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateSymbol"

    Allowed values:
    • "CreateSymbol"
    • "UpdateSymbol"
    • "CreateAmmPool"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"

    seqId

    required

    integer

    format: int64

    symbolName

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "symbolId": "string",
      "symbolName": "ETHUSDT",
      "baseAssetId": "3",
      "quoteAssetId": "3",
      "baseDecimal": "string",
      "priceDecimal": "string",
      "makerFeeDiscount": "string",
      "takerFeeDiscount": "string",
      "minTradingSize": "42.24",
      "maxTradingSize": "42.24",
      "maxPrice": "1.23",
      "status": "ACTIVE"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateSymbol",
      "seqId": 0,
      "symbolName": "ETHUSDT",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #1CreateAmmPool

    Message IDCreateAmmPool

    Payload

    Expand all

    object

    poolId

    string

    format: int32

    symbolName

    string

    minTick

    string

    maxTick

    string

    tickSpacing

    string

    userMaxPositionCount

    string

    format: int32

    operatorFeeRate

    string

    [ 0 .. 1 ]

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateAmmPool"

    Allowed values:
    • "CreateSymbol"
    • "UpdateSymbol"
    • "CreateAmmPool"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"

    seqId

    required

    integer

    format: int64

    symbolName

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "poolId": "12",
      "symbolName": "ETHUSDT",
      "minTick": "1.23",
      "maxTick": "1.23",
      "tickSpacing": "1.23",
      "userMaxPositionCount": "string",
      "operatorFeeRate": "0.0001"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateAmmPool",
      "seqId": 0,
      "symbolName": "ETHUSDT",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #2CreateOrder

    Message IDCreateOrder

    Payload

    Expand all

    object

    Spot order basic info

    uid

    string

    orderId

    string

    Order ID

    symbolName

    string

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    transactTime

    string

    transact time in milliseconds

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    originSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    type

    string

    Allowed values:
    • "LIMIT"
    • "MARKET"

    side

    string

    Allowed values:
    • "BUY"
    • "SELL"

    timeInForce

    string

    Allowed values:
    • "GTC"
    • "FOK"
    • "IOC"

    takerFeeRate

    string

    [ 0 .. 1 ]

    makerFeeRate

    string

    [ 0 .. 1 ]

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateOrder"

    Allowed values:
    • "CreateSymbol"
    • "UpdateSymbol"
    • "CreateAmmPool"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"

    seqId

    required

    integer

    format: int64

    symbolName

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "uid": "1727077698601001",
      "orderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "nonce": "string",
      "transactTime": "1507725176595",
      "price": "123",
      "originSize": "4224",
      "type": "LIMIT",
      "side": "BUY",
      "timeInForce": "GTC",
      "takerFeeRate": "0.0001",
      "makerFeeRate": "0.0001"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateOrder",
      "seqId": 0,
      "symbolName": "ETHUSDT",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #3CloseOrder

    Message IDCloseOrder

    Payload

    Expand all

    allOf

    Consists of:

    Expand all

    object

    Spot order basic info

    uid

    string

    orderId

    string

    Order ID

    symbolName

    string

    nonce

    string

    A unique id among user actions. Automatically generated if not sent. Actions with the same nonce can be accepted only when the previous one is finished, otherwise the action will be rejected.

    transactTime

    string

    transact time in milliseconds

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    originSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    type

    string

    Allowed values:
    • "LIMIT"
    • "MARKET"

    side

    string

    Allowed values:
    • "BUY"
    • "SELL"

    timeInForce

    string

    Allowed values:
    • "GTC"
    • "FOK"
    • "IOC"

    takerFeeRate

    string

    [ 0 .. 1 ]

    makerFeeRate

    string

    [ 0 .. 1 ]

    Additional properties are allowed.

    And of:

    Expand all

    object

    spot order update info

    uid

    string

    orderId

    string

    Order ID

    executedSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    cumulativeQuoteSize

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    status

    string

    order close reason

    Allowed values:
    • "FILLED"
    • "CANCELED"
    • "IOC_EXPIRED"

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CloseOrder"

    Allowed values:
    • "CreateSymbol"
    • "UpdateSymbol"
    • "CreateAmmPool"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"

    seqId

    required

    integer

    format: int64

    symbolName

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "uid": "1727077698601001",
      "orderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "nonce": "string",
      "transactTime": "1507725176595",
      "price": "123",
      "originSize": "4224",
      "type": "LIMIT",
      "side": "BUY",
      "timeInForce": "GTC",
      "takerFeeRate": "0.0001",
      "makerFeeRate": "0.0001",
      "executedSize": "4224",
      "cumulativeQuoteSize": "4224",
      "status": "FILLED"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CloseOrder",
      "seqId": 0,
      "symbolName": "ETHUSDT",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #4Trade

    Message IDTrade

    Payload

    Expand all

    object

    tradeDedupId

    string

    format: int64

    同一个seq id中值要求唯一

    makerUid

    string

    takerUid

    string

    makerOrderId

    string

    Order ID

    takerOrderId

    string

    Order ID

    symbolName

    string

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    size

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    takerSide

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    makerFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    takerFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"Trade"

    Allowed values:
    • "CreateSymbol"
    • "UpdateSymbol"
    • "CreateAmmPool"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"

    seqId

    required

    integer

    format: int64

    symbolName

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "tradeDedupId": "string",
      "makerUid": "1727077698601001",
      "takerUid": "1727077698601001",
      "makerOrderId": "1721801324586001",
      "takerOrderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "price": "123",
      "size": "4224",
      "takerSide": "4224",
      "makerFee": "4224",
      "takerFee": "4224"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "Trade",
      "seqId": 0,
      "symbolName": "ETHUSDT",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #5AmmTrade

    Message IDAmmTrade

    Payload

    Expand all

    object

    tradeDedupId

    string

    format: int64

    同一个seq id中值要求唯一

    poolId

    string

    format: int32

    takerUid

    string

    makerOrderId

    string

    Order ID

    takerOrderId

    string

    Order ID

    symbolName

    string

    price

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    size

    integer

    format: int64

    symbol精度，需要用symbol scale 做转换

    takerSide

    string

    Allowed values:
    • "BUY"
    • "SELL"

    arbitrageFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    takerFee

    integer

    format: int64

    asset精度，需要用asset scale 做转换

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"AmmTrade"

    Allowed values:
    • "CreateSymbol"
    • "UpdateSymbol"
    • "CreateAmmPool"
    • "CreateOrder"
    • "CloseOrder"
    • "Trade"
    • "AmmTrade"

    seqId

    required

    integer

    format: int64

    symbolName

    required

    string

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "tradeDedupId": "string",
      "poolId": "12",
      "takerUid": "1727077698601001",
      "makerOrderId": "1721801324586001",
      "takerOrderId": "1721801324586001",
      "symbolName": "ETHUSDT",
      "price": "123",
      "size": "4224",
      "takerSide": "BUY",
      "arbitrageFee": "4224",
      "takerFee": "4224"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "AmmTrade",
      "seqId": 0,
      "symbolName": "ETHUSDT",
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

• SEND spots-memory

  Operation IDpublishSpotsMemory

  Accepts the following message:

  UpdateDepth

  Message IDUpdateDepth

  Payload

  Expand all

  object

  bids

  Expand all

  array<object>

  object

  price

  string

  size

  string

  Additional properties are allowed.

  asks

  Expand all

  array<object>

  object

  price

  string

  size

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  type

  required

  string

  Const:"UpdateDepth"

  Allowed values:
  • "UpdateDepth"

  seqId

  required

  integer

  format: int64

  symbolName

  required

  string

  timestamp

  string

  transact time in milliseconds

  Additional properties are allowed.

  Examples

  Payload

  {
    "bids": [
      {
        "price": "0.0024",
        "size": "10"
      }
    ],
    "asks": [
      {
        "price": "0.0024",
        "size": "10"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "type": "UpdateDepth",
    "seqId": 0,
    "symbolName": "ETHUSDT",
    "timestamp": "1507725176595"
  }
  

  This example has been generated automatically.

• SEND metadata

  Operation IDpublishMetadata

  Accepts one of the following messages:

  • #0CreateAsset

    Message IDCreateAsset

    Payload

    Expand all

    object

    assetId

    string

    字段值要求唯一, int32

    assetName

    string

    asset name, 大小写英文字母, 字段值要求唯一, 比如 "stETH", "WBTC"

    onChainDecimal

    string

    必须 >= 0, 对应链上的 decimal() 方法返回, int32

    decimal

    string

    0 <= decimal <= onChainDecimal, int32

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateAsset"

    Allowed values:
    • "CreateAsset"
    • "CreatePool"
    • "CreateSymbol"
    • "CreateOrUpdateChainInfo"
    • "UpdateChainAsset"

    seqId

    required

    integer

    format: int64

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "assetId": "3",
      "assetName": "WBTC",
      "onChainDecimal": "string",
      "decimal": "3"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateAsset",
      "seqId": 0,
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #1CreatePool

    Message IDCreatePool

    Payload

    Expand all

    object

    poolId

    string

    format: int32

    symbolName

    string

    minPrice

    string

    maxPrice

    string

    tickSpacing

    string

    userMaxPositionCount

    string

    format: int32

    operatorFeeRate

    string

    [ 0 .. 1 ]

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreatePool"

    Allowed values:
    • "CreateAsset"
    • "CreatePool"
    • "CreateSymbol"
    • "CreateOrUpdateChainInfo"
    • "UpdateChainAsset"

    seqId

    required

    integer

    format: int64

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "poolId": "12",
      "symbolName": "ETHUSDT",
      "minPrice": "1.23",
      "maxPrice": "1.23",
      "tickSpacing": "1.23",
      "userMaxPositionCount": "string",
      "operatorFeeRate": "0.0001"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreatePool",
      "seqId": 0,
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #2CreateSymbol

    Message IDCreateSymbol

    Payload

    Expand all

    object

    symbolId

    required

    string

    值要求唯一, int32

    symbolName

    required

    string

    baseAssetId

    required

    string

    字段值要求唯一, int32

    quoteAssetId

    required

    string

    字段值要求唯一, int32

    baseDecimal

    required

    string

    format: int32

    priceDecimal

    required

    string

    format: int32

    makerFeeDiscount

    required

    string

    format: int32[ 0 .. 100 ]

    in range [0, 100]

    takerFeeDiscount

    required

    string

    format: int32[ 0 .. 100 ]

    in range [0, 100]

    minTradingSize

    required

    string

    maxTradingSize

    required

    string

    maxPrice

    required

    string

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateSymbol"

    Allowed values:
    • "CreateAsset"
    • "CreatePool"
    • "CreateSymbol"
    • "CreateOrUpdateChainInfo"
    • "UpdateChainAsset"

    seqId

    required

    integer

    format: int64

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "symbolId": "string",
      "symbolName": "ETHUSDT",
      "baseAssetId": "3",
      "quoteAssetId": "3",
      "baseDecimal": "string",
      "priceDecimal": "string",
      "makerFeeDiscount": "string",
      "takerFeeDiscount": "string",
      "minTradingSize": "42.24",
      "maxTradingSize": "42.24",
      "maxPrice": "1.23",
      "status": "ACTIVE"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateSymbol",
      "seqId": 0,
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #3UpdateChainAsset

    Message IDUpdateChainAsset

    Payload

    Expand all

    object

    logicalChainId

    string

    format: int32

    isEnabled

    boolean

    assetId

    string

    字段值要求唯一, int32

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"UpdateChainAsset"

    Allowed values:
    • "CreateAsset"
    • "CreatePool"
    • "CreateSymbol"
    • "CreateOrUpdateChainInfo"
    • "UpdateChainAsset"

    seqId

    required

    integer

    format: int64

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "logicalChainId": "31337",
      "isEnabled": true,
      "assetId": "3"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "UpdateChainAsset",
      "seqId": 0,
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

  • #4CreateOrUpdateChainInfo

    Message IDCreateOrUpdateChainInfo

    Payload

    Expand all

    object

    logicalChainId

    string

    format: int32

    isEnabled

    boolean

    vaultAddress

    string

    chainId

    string

    format: int32

    Additional properties are allowed.

    Headers

    Expand all

    object

    type

    required

    string

    Const:"CreateOrUpdateChainInfo"

    Allowed values:
    • "CreateAsset"
    • "CreatePool"
    • "CreateSymbol"
    • "CreateOrUpdateChainInfo"
    • "UpdateChainAsset"

    seqId

    required

    integer

    format: int64

    timestamp

    required

    string

    transact time in milliseconds

    Additional properties are allowed.

    Examples

    Payload

    {
      "logicalChainId": "31337",
      "isEnabled": true,
      "vaultAddress": "0xC38C2c17fC38fb8fF575BDd3b7fcF04b8274a7B5",
      "chainId": "31337"
    }
    

    This example has been generated automatically.

    Headers

    {
      "type": "CreateOrUpdateChainInfo",
      "seqId": 0,
      "timestamp": "1507725176595"
    }
    

    This example has been generated automatically.

• SEND userBalance

  Operation IDpublishUserBalance

  Accepts the following message:

  UpdateUserBalance

  Message IDUpdateUserBalance

  Payload

  Expand all

  array<object>

  object

  user balance change

  uid

  string

  assetId

  string

  字段值要求唯一, int32

  address

  string

  before

  integer

  format: int64

  asset精度，需要用asset scale 做转换

  after

  integer

  format: int64

  asset精度，需要用asset scale 做转换

  Additional properties are allowed.

  Headers

  Expand all

  object

  type

  required

  string

  Const:"UpdateUserBalance"

  Allowed values:
  • "UpdateUserBalance"

  seqId

  required

  integer

  format: int64

  timestamp

  required

  string

  transact time in milliseconds

  Additional properties are allowed.

  Examples

  Payload

  [
    {
      "uid": "1727077698601001",
      "assetId": "3",
      "address": "0xC38C2c17fC38fb8fF575BDd3b7fcF04b8274a7B5",
      "before": "4224",
      "after": "4224"
    }
  ]
  

  This example has been generated automatically.

  Headers

  {
    "type": "UpdateUserBalance",
    "seqId": 0,
    "timestamp": "1507725176595"
  }
  

  This example has been generated automatically.