登录  |  注册

虚拟币

帮助中心

首页 > 帮助中心 > UltraEx REST API

UltraEx REST API

开始使用

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

· RESTful架构中,每一个URL代表一种资源;

· 客户端和服务器之间,传递这种资源的某种表现层;

· 客户端通过四个HTTP指令,对服务器端资源进行操作,实现表现层状态转化

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

请求交互

REST访问的根URLhttps://ultraex.io/Home/Api/ 访问时需要科学上网 所有请求基于Https协议,请求头信息中contentType需要统一设置为:application/x-www-form-urlencoded

请求交互说明

1. 请求参数:根据接口请求参数规定进行参数封装。

2. 提交请求参数:将封装好的请求参数通过POST GET 方式提交至服务器。

3. 服务器响应:服务器首先对用户请求数据进行参数安全校验,通过校验后根据业务逻辑将响应数据以JSON格式返回给用户。

4. 数据处理:对服务器响应数据进行处理。

API参考

币币行情 API

获取UEX币币行情数据

1. get_ticker 获取UEX币币行情

URL https://ultraex.io/Home/Api/get_ticker

示例

# Request
GET https://ultraex.io/Home/Api/get_ticker
# Response
{
"date":"1410431279",
"ultraticker":{
"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

币对如uex_eth

2. get_depth获取UEX币币市场深度

URL https://ultraex.io/Home/Api/get_depth

示例

# Request
GET https://ultraex.io/Home/Api/get_depth
# Response
{
"ultraasks": [
[792, 5],
[789.68, 0.018],
[788.99, 0.042],
[788.43, 0.036],
[787.27, 0.02]
],
"ultrabids": [
[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

币对如uex_eth

size

Integer

(默认200)

value: 1-200


币币交易 API

用于UEX币币交易

1. get_userinfo获取用户信息

URL https://ultraex.io/Home/Api/get_userinfo 访问频率 1/2

示例

# Request
POST https://ultraex.io/Home/Api/get_userinfo
# Response
{
    "ultrainfo": {
        "funds": {
            "free": {
                "btc": "0",
                "ltc": "0",
                "eth": "0"
            },
            "freezed": {
                "btc": "0",
                "ltc": "0",
                "eth": "0"
            }
        }
    },
    "ultraresult": true
}

返回值说明

free:账户余额
freezed:账户冻结余额


请求参数

参数名

参数类型

必填

描述

uid

String

用户ID

token

String

请求参数的签名token

2. trade下单交易

URL https://ultraex.io/Home/Api/trade 访问频率 20/2

示例

# Request
POST https://ultraex.io/Home/Api/trade
# Response
{"status":1, "info":操作成功,"order_id":123456}

返回值说明

status:1代表成功返回
info:提示信息
order_id:订单ID

请求参数

参数名

参数类型

必填

描述

uid

String

用户ID

symbol

String

币对如uex_eth

type

String

买卖类型:限价单(buy/sell) 市价单(buy_market/sell_market)

price

Double

下单价格 市价卖单不传price

amount

Double

交易数量 市价买单不传amount,市价买单需传price作为买入总金额

token

String

请求参数的签名

4. cancel_order 撤销订单

URL https://ultraex.io/Home/Api/cancel_order 访问频率 20/2

示例

# Request
POST https://ultraex.io/Home/Api/cancel_order
# Response
#多笔订单返回结果(成功订单ID,失败订单ID)
{"success":"123456,123457","error":"123458,123459"}

返回值说明

result:true撤单请求成功,等待系统执行撤单;false撤单失败(用于单笔订单)
order_id:订单ID(用于单笔订单)
success:撤单请求成功的订单ID,等待系统执行撤单(用于多笔订单)
error:撤单请求失败的订单ID(用户多笔订单)

请求参数

参数名

参数类型

必填

描述

uid

String

用户ID

symbol

String

币对如uex_eth

order_id

String

订单ID(多个订单ID中间以","分隔,一次最多允许撤消3个订单)

token

String

请求参数的签名

5. get_orderinfo 获取用户的订单信息

URL https://ultraex.io/Home/Api/get_orderinfo 访问频率 20/2(未成交)

示例

# Request
POST https://ultraex.io/Home/Api/get_orderinfo
# Response
{
    "result": true,
    "orders": [
        {
            "amount": 0.1,
            "create_date": 1418008467000,
            "deal_amount": 0,
            "order_id": 10000591,
            "price": 500,
            "status": 0,
            "symbol": "btc_usd",
            "type": "sell"
        },
        {
            "amount": 0.2,
            "create_date": 1417417957000,
            "deal_amount": 0,
            "order_id": 10000724,
            "price": 0.1,
            "status": 0,
            "symbol": "btc_usd",
            "type": "buy"
        }
    ]
}

返回值说明

amount:委托数量
create_date: 委托时间
deal_amount:成交数量
order_id:订单ID
price:委托价格
status:-1:已撤销  0:未成交  1:部分成交  2:完全成交
type:buy:市价买入 / sell:市价卖出

请求参数

参数名

参数类型

必填

描述

uid

String

用户ID

symbol

String

币对如uex_eth

order_id

Long

订单ID -1:未完成订单,否则查询相应订单号的订单

token

String

请求参数的签名

7. get_order_history获取历史订单信息,只返回最近两天的信息

URL https://ultraex.io/Home/Api/get_order_history

示例

# Request
POST https://ultraex.io/Home/Api/get_order_history
# Response
{
"current_page": 1,
"orders": [
{
"amount": 0,
"create_date": 1405562100000,
"deal_amount": 0,
"order_id": 0,
"price": 0,
"status": 2,
"symbol": "btc_usd",
"type": "sell”
}
],
"page_length": 1,
"result": true,
"total": 3
}

返回值说明

current_page:当前页码
orders:委托详细信息
amount:委托数量
create_date:委托时间
deal_amount:成交数量
order_id:订单ID
price:委托价格
status:-1:已撤销   0:未成交 1:部分成交 2:完全成交
type:buy:市价买入 / sell:市价卖出
page_length:每页数据条数
result:true代表成功返回

请求参数

参数名

参数类型

必填

描述

uid

String

用户ID

symbol

String

币对如uex_eth

status

Integer

查询状态 0:未完成的订单 1:已经完成的订单(最近两天的数据)

current_page

Integer

当前页数

page_length

Integer

每页数据条数,最多不超过200

token

String

请求参数的签名

备注:签名需求

请posturl:https://ultraex.io/Home/Api/get_Sign

成功返回tokentoken有效期为一天,过期请重新请求

请求参数

参数名

参数类型

必填

描述

uid

String

用户ID

password

String

用户登录密码

mobilephone

String

用户绑定的手机号