Skip to content

kkttyy01/api-demo

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
java
java
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 

Repository files navigation

枚举值表

OrderStatus:
[PENDING:1,EXCUTING:3,EXECUTED:4,EXPIRED:5,REJECTED:7,CANCELLED:9,UKNOWN:99]
Side:
[BUY:1,SELL:-1]
TimeInForce:
[IOC:1,GTC:3]
OrderType:
[LIMIT:3,MARKET:5]
OrderResult
[NONE:1,FILLED:3,PARTIAL::5]
OrderType
[LIMIT:3,MARKET:5]

Restful API

登陆接口

POST /api/v1/operator/login

请求参数

NAME REQUIRED TYPE DESCRIBE DEFAULT VALUES RANGE
loginId Y String 用户名
password Y String 密码

返回参数

NAME TYPE DESCRIBE
token String token

返回参数示例

{
  "data": {
    "token": "ZElHYkFsRktuZDduUG1udzI2V1lldyIsImFsZyI6IkEyNTZHQ01LVyIsIml2IjoicjZzLU83TGlYTUFYVEVxeSJ9.92p5f4TRYGPa16VZQgE1_FlhYwx6YCLeUlh-rlE3o_8.-wL8D1uL3GEEE3kj.qmBbSsSy92nYBt4WOLbU5MCH1NPbXO6k6_b5uGEG63xcQJ-Ny9K1VCMRtChQRol6l6fb5rNobNnOFAgeYzy2cqkje4HgUlL3BSRNlDj7G6W-60MwM2af7U2xshESv8LqLux2GZxPzCBmJz__HgluDxJwX2qNsMvOjM5k7Ckce8E1vHRJA18pkMzAL41HMFyzaf67Mp2SgXIaFHXVKVxdsOI.Gi2YOwudddsfdsafdsafa"
  },
  "result": "SUCCESS",
  "type": "API"
}

获取CP列表

GET /api/v1/market/cps

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

返回参数

NAME TYPE DESCRIBE
id short ID
name String 名称缩写
tradingEnabled boolean 交易限制

返回参数示例

{
  "data": [
    {
      "id": 257,
      "name": "NT_XX1",
      "tradingEnabled": true
    },
    {
      "id": 258,
      "name": "NT_XX2",
      "tradingEnabled": true
    }
  ],
  "result": "SUCCESS",
  "type": "API"
}

获取symbol列表

GET /api/v1/market/symbols

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

返回参数

NAME TYPE DESCRIBE
id int ID
name String 名称
tradingMaxVolume BigDecimal 交易最大数量
tradingMinVolume BigDecimal 交易最小数量
tradingPriceScale byte 价格精度
tradingVolumeScale byte 交易量精度

返回参数示例

{
  "data": [
    {
      "id": 65537,
      "name": "BTCUSDT",
      "tradingMaxVolume": "100",
      "tradingMinVolume": "0.000001",
      "tradingPriceScale": 2,
      "tradingVolumeScale": 5
    },
    {
      "id": 65539,
      "name": "BCHUSDT",
      "tradingMaxVolume": "100",
      "tradingMinVolume": "0.00001",
      "tradingPriceScale": 2,
      "tradingVolumeScale": 8
    }
  ],
  "result": "SUCCESS",
  "type": "API"
}

交易

POST /api/v1/trades/place

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

请求参数

NAME REQUIRED TYPE DESCRIBE DEFAULT VALUES RANGE
cpId Y Short CP ID
symbolId Y Integer 货币对ID
orderPrice Y BigDecimal 挂单价格
orderVolume Y BigDecimal 挂单数量
side Y String 买卖方向(Side)
orderType Y String 挂单类型(OrderType)
timeInForce Y String 过期类型(TimeInForce)

返回参数示例

{
  "data": {
    "data": {
      "orderPrice": "INVALID",
      "orderVolume": "UNDERFLOW"
    },
    "type": "VALIDATION"
  },
  "result": "INVALID_DATA",
  "type": "API"
}

获取CP成交详细

GET /api/v1/trades/cpExecutionDetail

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

请求参数

NAME REQUIRED TYPE DESCRIBE DEFAULT VALUES RANGE
orderId Y Long 订单ID -

返回参数

NAME TYPE DESCRIBE
id long ID
cpId short CP ID
symbolId int 货币对ID
accountId long 账户ID
orderId long 订单ID
side String 买卖方向(Side)
executeAmount BigDecimal 成交金额
executePrice BigDecimal 成交价格
executeVolume BigDecimal 成交数量
executeTime long 成交时间
commission double 手续费
executeComment String 成交备注

返回参数示例

{
  "data": {
    "executions": [
      {
        "accountId": "0",
        "commission": "0.628542600000",
        "cpId": 257,
        "executeAmount": "628.542600000000",
        "executeComment": "CommissionAsset: USDT",
        "executePrice": "6413.700000000000",
        "executeTime": "1537450673000",
        "executeVolume": "0.098000000000",
        "id": "720385747089113129",
        "orderId": "720385741233864233",
        "side": -1,
        "symbolId": 65537
      }
    ]
  },
  "result": "SUCCESS",
  "type": "API"
}

获取订单详细

GET /api/v1/trades/orderDetail

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

请求参数

NAME REQUIRED TYPE DESCRIBE DEFAULT VALUES RANGE
sourceId Y Long 父订单ID -

返回参数

NAME TYPE DESCRIBE
pageCount int 总页数
pageNo int 页码
pageSize int 每页数量
total int 总条数
id long ID
cpId short CP ID
symbolId int 货币对ID
accountId short 账户ID
sourceId long 父订单ID
orderId String 订单ID
side String 买卖方向(Side)
status String 状态(OrderStatus)
orderResult String 结果(OrderResult)
orderType String 挂单类型(OrderType)
orderPrice BigDecimal 挂单价格
executePrice String 成交价格
executeAmount BigDecimal 成交金额
executeVolume BigDecimal 成交数量
orderVolume BigDecimal 挂单数量
pendingVolume BigDecimal 执行数量
accountId String 账户ID
executeComment String 成交备注
executeTime long 成交时间
orderTime long 挂单时间
timeInForce String 过期类型(TimeInForce)
commission BigDecimal 手续费
orderComment String 备注

返回参数示例

{
  "data": {
    "orders": [
      {
        "accountId": 0,
        "commission": "0.999900000000",
        "cpId": 257,
        "executions": [
          {
            "accountId": "0",
            "symbolId": 65537,
            "commission": "0.127800000000",
            "cpId": 257,
            "executeAmount": "127.800000000000",
            "executeComment": "CommissionAsset: USDT",
            "executePrice": "6390.000000000000",
            "executeTime": "1537409484740",
            "executeVolume": "0.020000000000",
            "id": "720040235022424617",
            "orderId": "720040228848408617",
            "side": -1
          }
        ],
        "executeAmount": "127.800000000000",
        "executeTime": "1537409484740",
        "executeVolume": "0.020000000000",
        "id": "720040228848408617",
        "orderComment": "720040227201319445.0",
        "orderResult": 3,
        "orderTime": "1537409484129",
        "orderType": 5,
        "orderVolume": "0.020000000000",
        "pendingVolume": "0.000000000000",
        "side": -1,
        "sourceId": "720040228798076457",
        "status": 4,
        "symbolId": 1,
        "timeInForce": 1
      }
    ]
  },
  "result": "SUCCESS",
  "type": "API"
}

获取订单历史 列表

GET /api/v1/trades/orderHistory

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

请求参数

NAME REQUIRED TYPE DESCRIBE DEFAULT VALUES RANGE
cpId Short CP ID -
symbolId Integer 货币对ID -
status String 状态(OrderStatus) -
from Y Long 开始时间 -
to Y Long 结束时间 -
pageNo Integer 页码 -

返回参数

NAME TYPE DESCRIBE
pageCount int 总页数
pageNo int 页码
pageSize int 每页数量
total int 总条数
id long ID
cpId short CP ID
symbolId int 货币对ID
accountId short 账户ID
sourceId long 父订单ID
side String 买卖方向(Side)
status String 状态(OrderStatus)
orderResult String 结果(OrderResult)
orderType String 挂单类型(OrderType)
orderPrice BigDecimal 挂单价格
executeAmount double 成交金额
orderVolume BigDecimal 挂单数量
pendingVolume BigDecimal 执行数量
executeVolume double 成交数量
executeTime long 成交时间
orderTime long 挂单时间
timeInForce String 过期类型(TimeInForce)
commission BigDecimal 手续费
rejectReason String 拒绝原因
orderComment String 备注

返回参数示例

{
  "data": {
    "pageCount": 1,
    "pageNo": 1,
    "pageSize": 100,
    "records": [
      {
        "accountId": 0,
        "commission": "1.000100000000",
        "cpId": 257,
        "executeAmount": "0",
        "executeTime": "0",
        "executeVolume": "0",
        "id": "723982654013188137",
        "orderComment": "723982649334445077.0",
        "orderPrice": "6432.63",
        "orderTime": "1537879457832",
        "orderType": 3,
        "orderVolume": "0.01",
        "pendingVolume": "0",
        "side": 1,
        "sourceId": "0",
        "status": 1,
        "symbolId": 65537,
        "timeInForce": 1
      }
    ],
    "total": 6
  },
  "result": "SUCCESS",
  "type": "API"
}

获取CP订单历史 列表

GET /api/v1/trades/cpOrderHistory

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

请求参数

NAME REQUIRED TYPE DESCRIBE DEFAULT VALUES RANGE
cpId Short CP ID -
symbolId Integer 货币对ID -
status String 状态(OrderStatus) -
from Y Long 开始时间 -
to Y Long 结束时间 -
pageNo Integer 页码 -

返回参数

NAME TYPE DESCRIBE
pageCount int 总页数
pageNo int 页码
pageSize int 每页数量
total int 总条数
id long ID
cpId short CP ID
symbolId int 货币对ID
accountId short 账户ID
sourceId long 父订单ID
side String 买卖方向(Side)
status String 状态(OrderStatus)
orderType String 挂单类型(OrderType)
orderResult String 结果(OrderResult)
executeAmount double 成交金额
orderPrice BigDecimal 挂单价格
executeVolume double 成交数量
orderVolume BigDecimal 挂单数量
pendingVolume BigDecimal 执行数量
rejectReason String 拒绝原因
sourceId long 父订单
orderTime long 挂单时间
executeTime long 成交时间
timeInForce String 过期类型(TimeInForce)
commission BigDecimal 手续费
rejectReason String 拒绝原因
orderComment String 备注

返回参数示例

{
	"data": {
		"pageCount": 3,
		"pageNo": 1,
		"pageSize": 100,
		"records": [{
		        "id": "724051456730076713",
				"accountId": 0,
				"commission": "0.999900000000",
				"cpId": 257,
				"executeAmount": "64.2598",
				"executeTime": "1537887660365",
				"executeVolume": "0.01",
				"orderComment": "724051448010349077.0",
				"orderResult": 3,
				"orderTime": "1537887659755",
				"orderType": 5,
				"orderVolume": "0.01",
				"pendingVolume": "0",
				"side": -1,
				"sourceId": "0",
				"status": 4,
				"symbolId": 65537,
				"timeInForce": 1
			}
		],
		"total": 273
	},
	"result": "SUCCESS",
	"type": "API"
}

获取CP成交历史 列表

GET /v1/trades/cpExecutionHistory

Headers: X-IDCM-APIKEY:（token，通过登录接口获得.）

请求参数

NAME REQUIRED TYPE DESCRIBE DEFAULT VALUES RANGE
cpId Short CP ID -
symbolId Integer 货币对ID -
from Y Long 开始时间 -
to Y Long 结束时间 -
pageNo Integer 页码 -

返回参数

NAME TYPE DESCRIBE
pageCount int 总页数
pageNo int 页码
pageSize int 每页数量
total int 总条数
id long ID
cpId short CP ID
symbolId int 货币对ID
accountId long 账户ID
orderId long 订单ID
side String 买卖方向(Side)
executePrice BigDecimal 价格
executeVolume BigDecimal 成交数量
executeAmount BigDecimal 成交金额
executeTime long 时间
commission double 手续费
executeComment String 备注

返回参数示例

{
	"data": {
		"pageCount": 2,
		"pageNo": 1,
		"pageSize": 100,
		"records": [{
				"accountId": "0",
				"commission": "0.0642598",
				"cpId": 257,
				"executeAmount": "64.2598",
				"executePrice": "6425.98",
				"executeTime": "1537887660365",
				"executeVolume": "0.01",
				"id": "724051462744709161",
				"orderId": "724051456730076713",
				"side": -1,
				"symbolId": 65537
				"executeComment": "CommissionAsset: USDT",
			}
		],
		"total": 1
	},
	"result": "SUCCESS",
	"type": "API"
}

WEBSOCKET API

ws://127.0.0.1:8082/api/realtime?X-API-TOKEN=WHZWUFAxWlV0bzdMMzl5N1dmYy1z

X-IDCM-APIKEY:（token，通过登录接口获得.）

请求指令

CMD DESCRIBE
subscribe:apiOrder 订阅订单成交结果
unsubscribe:apiOrder 取消订阅订单成交结果
subscribe:apiQuote:symbolId 订阅行情深度
unsubscribe:apiOrder:symbolId 取消订阅行情深度

汇率推送返回参数

NAME TYPE DESCRIBE
event String 事件(API_QUOTE)
commission double 手续费
cpId short CP ID
symbolId int 货币对ID

汇率推送返回参数示例

{
	"event": "API_QUOTE",
	"data": {
		"asks": [{
			"price": "6401.9065",
			"volume": "0.01966"
		}, {
			"price": "6401.9075",
			"volume": "0.022"
		}],
		"bids": [{
			"price": "6399.302",
			"volume": "0.8"
		}, {
			"price": "6399.2931",
			"volume": "0.048"
		}],
		"commission": "0.0001",
		"cpId": 259,
		"symbolId": 65537
	}
}

订单成交推送返回参数

NAME TYPE DESCRIBE
event String 事件(API_ORDER)
id long ID
symbolId int 货币对ID
accountId long 账户ID
sourceId long 父订单
side String 买卖方向(Side)
status String 状态(OrderStatus)
orderType String 挂单类型(OrderType)
executeAmount BigDecimal 成交金额
executeVolume BigDecimal 成交数量
orderVolume BigDecimal 挂单数量
pendingVolume BigDecimal 执行数量
executeTime long 时间
orderTime long 挂单时间
commission double 手续费
timeInForce String 过期类型(TimeInForce)
orderComment String 备注

订单成交结果推送返回参数示例

{
	"event": "API_ORDER",
	"data": [{
		"accountId": 0,
		"commission": "0.9999",
		"cpId": 258,
		"executeAmount": "0",
		"executeTime": "0",
		"executeVolume": "0",
		"executions": [],
		"id": "723970960352354857",
		"orderComment": "723970958215745045.0",
		"orderTime": "1537878063839",
		"orderType": 5,
		"orderVolume": "0.0100",
		"pendingVolume": "0.0000",
		"side": -1,
		"sourceId": "723970960352354345",
		"status": 1,
		"symbolId": 1,
		"timeInForce": 1
	}, {
		"accountId": 0,
		"cpId": 0,
		"executeAmount": "0",
		"executeTime": "0",
		"executeVolume": "0",
		"executions": [],
		"id": "723970960352354345",
		"orderTime": "1537878063839",
		"orderType": 5,
		"orderVolume": "0.01",
		"pendingVolume": "0.0000",
		"side": -1,
		"sourceId": "0",
		"status": 1,
		"symbolId": 1,
		"timeInForce": 1
	}]
}

About

Api Demo Project

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%