Skip to content

Latest commit

 

History

History
113 lines (87 loc) · 2.61 KB

spot_rest_api.md

File metadata and controls

113 lines (87 loc) · 2.61 KB

SPOT REST API    

开始使用    

REST，即Representational State Transfer的缩写，是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，正得到越来越多网站的采用。其优点如下：

  • 在RESTful架构中，每一个URL代表一种资源；
  • 客户端和服务器之间，传递这种资源的某种表现层；
  • 客户端通过四个HTTP指令，对服务器端资源进行操作，实现“表现层状态转化”。

建议开发者使用REST API进行币币交易或者资产提现等操作。

请求交互    

REST访问的根URL：https://www.okex.com/api/v1

所有请求基于Https协议，请求头信息中contentType需要统一设置为：application/x-www-form-urlencoded

请求交互说明

  1. 请求参数：根据接口请求参数规定进行参数封装。
  2. 提交请求参数：将封装好的请求参数通过POST 或GET 方式提交至服务器。
  3. 服务器响应：服务器首先对用户请求数据进行参数安全校验，通过校验后根据业务逻辑将响应数据以JSON格式返回给用户。
  4. 数据处理：对服务器响应数据进行处理。

API参考

币币行情 API

获取OKEx币币行情数据

  1. Get /api/v1/ticker   获取OKEx币币行情

URL https://www.okex.com/api/v1/ticker.do

示例

# Request
GET https://www.okex.com/api/v1/ticker.do?symbol=ltc_btc
# Response
{
	"date":"1410431279",
	"ticker":{
		"buy":"33.15",
		"high":"34.15",
		"last":"33.15",
		"low":"32.05",
		"sell":"33.16",
		"vol":"10532696.39199642"
	}
}

返回值说明

date: 返回数据时服务器时间
buy: 买一价
high: 最高价
last: 最新成交价
low: 最低价
sell: 卖一价
vol: 成交量(最近的24小时)

请求参数

参数名 参数类型 必填 描述
symbol String 是 币对如ltc_btc
  1. Get /api/v1/depth 获取OKEx币币市场深度

URL https://www.okex.com/api/v1/depth.do

示例

# Request
GET https://www.okex.com/api/v1/depth.do?symbol=ltc_btc
# Response
{
	"asks": [
		[792, 5],
		[789.68, 0.018],
		[788.99, 0.042],
		[788.43, 0.036],
		[787.27, 0.02]
	],
	"bids": [
		[787.1, 0.35],
		[787, 12.071],
		[786.5, 0.014],
		[786.2, 0.38],
		[786, 3.217],
		[785.3, 5.322],
		[785.04, 5.04]
	]
}

返回值说明

asks :卖方深度
bids :买方深度

请求参数

参数名 参数类型 必填 描述
symbol String 是 币对如ltc_btc
size Integer 否(默认200) value: 1-200