此篇内容尚无原站英文对应版本;切换语言后可浏览英文资料库。
该book_offers方法检索两种货币之间的报价列表,也称为订单簿。如果结果非常大,则使用标记返回部分结果,以便稍后的请求可以从前一个请求的剩余位置恢复。
请求格式的示例:
一个成功回应的例子:
除标准商品字段外,以下字段可能包含在
可能的错误:
{
"id": 4,
"command": "book_offers",
"taker": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
"taker_gets": {
"currency": "STM"
},
"taker_pays": {
"currency": "USD",
"issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
},
"limit": 10
}
{
"method": "book_offers",
"params": [
{
"taker": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
"taker_gets": {
"currency": "STM"
},
"taker_pays": {
"currency": "USD",
"issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
},
"limit": 10
}
]
}
#Syntax: book_offers taker_pays taker_gets [taker [ledger [limit] ] ] streamd book_offers 'USD/vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV' 'EUR/vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV'该请求包含以下参数:
Field |
Type | Description |
|---|---|---|
ledger_hash |
String | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
String or Unsigned Integer | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
limit |
Unsigned Integer | (可选)如果提供,服务器在结果中提供的优惠数量不会超过此数。返回的结果总数可能会少于限制,因为服务器忽略了未提供资金的优惠。 |
marker |
(Not Specified) | (可选)来自之前分页响应的值。在该响应停止的情况下继续恢复数据。 |
taker |
String | (可选)作为透视图使用的帐户的地址。响应中始终包含此帐户放置的未获资助的优惠。(你可以用它来查找你自己的命令来取消它们。) |
taker_gets |
Object | 指定接受报价的账户将以哪种货币收到的货币作为具有currency和issuer字段的对象(省略STM的发行者),如货币金额。 |
taker_pays |
Object | 指定接受报价的账户将支付哪种货币作为具有currency和issuer字段的对象(省略STM的发行者),如货币金额。 |
{
"id": 4,
"result": {
"ledger_current_index": 168798,
"offers": [],
"validated": false
},
"status": "success",
"type": "response"
}
200 OK
{
"result": {
"ledger_current_index": 168798,
"offers": [],
"validated": false
},
"status": "success",
"type": "response"
}
响应遵循标准格式,成功结果包含以下字段:
Field |
Type | Description |
|---|---|---|
ledger_current_index |
Integer | (如果提供分类帐版本,则省略)检索此数据时使用的分类账版本的序号。 |
ledger_index |
Integer | (如果改为提供ledger_current_index,则省略)请求中提供的序列号,用于检索此数据时使用的分类帐版本。 |
ledger_hash |
String | (可以省略)请求中提供的Hex哈希检索此数据时使用的分类帐版本。 |
marker |
(Not Specified) | (可以省略)服务器定义的值,表示响应是分页的。将此传递给下一个电话以恢复此通话停止的位置。在此之后没有信息页面时省略。 |
offers |
Array | 要约对象数组,其中每个对象都有一个OfferCreate事务的字段 |
offers数组成员中:
Field |
Type | Description |
|---|---|---|
owner_funds |
String | 可以交易报价方的TakerGets货币金额。(STM表示为下跌;任何其他货币都表示为十进制值。)如果交易者在同一本书中有多个商品,则只有排名最高的商品包含该字段。 |
taker_gets_funded |
String (STM) or Object (non-STM) | (仅包含在部分资助的优惠中)考虑到优惠的资金状况,接受方可获得的最大金额。 |
taker_pays_funded |
String (STM) or Object (non-STM) | (仅包含在部分资助的优惠中)考虑到优惠的资金状态,接受方将支付的最大货币金额。 |
quality |
Number | 汇率,比率taker_pays除以taker_gets。为了公平起见,具有相同质量的报价将自动采用先入先出。(换句话说,如果多人提出以相同的汇率兑换货币,则最先采用最早的报价。) |
- 任何通用错误类型。
invalidParams- 一个或多个字段指定不正确,或缺少一个或多个必填字段。lgrNotFound- 由ledger_hash或者ledger_index不存在的分类账,或者确实存在,但服务器没有。srcCurMalformed-taker_pays请求中的字段格式不正确。dstAmtMalformed-taker_gets请求中的字段格式不正确。srcIsrMalformed- 请求中issuer字段的taker_pays字段无效。dstIsrMalformed- 请求中issuer字段的taker_gets字段无效。badMarket- 所需订单不存在; 例如,为自己交换货币。
