{ "openapi": "3.0.0", "info": { "title": "安全井通API服务", "description": "安全井通API服务", "contact": { "email": "lospringliu@gmail.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "v3" }, "servers": [ { "url": "http://swtcproxy.swtclib.ca:5080/v3", "description": "Proxy to SWTCCA" }, { "url": "http://swtcproxy.swtclib.ca:5081/v3", "description": "Proxy to SWTCCA testchain" }, { "url": "http://swtcproxy.swtclib.ca:5082/v3", "description": "Proxy to SWTCCA multisign" }, { "url": "http://swtc-api.swtc.top:5080/v3", "description": "Proxy to SWTC基金会" }, { "url": "http://localhost:5080/v3", "description": "Test on Localhost" } ], "tags": [ { "name": "server", "description": "后端井通节点" }, { "name": "account", "description": "账户" }, { "name": "brokerage", "description": "代理" }, { "name": "ledger", "description": "帐本" }, { "name": "transaction", "description": "事务" }, { "name": "blob", "description": "提交单签事务" }, { "name": "multisign", "description": "提交多签事务" } ], "paths": { "/server/info": { "get": { "tags": ["server"], "summary": "查询节点信息", "description": "查询节点信息\n", "operationId": "getServerInfo", "responses": { "200": { "description": "节点信息", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Server" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts": { "get": { "tags": ["account"], "summary": "查询开户账户", "description": "查询开户账户\n", "operationId": "requestAccounts", "parameters": [ { "name": "ledger_index", "in": "query", "description": "帐本索引", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 12345678 } }, { "name": "ledger_hash", "in": "query", "description": "帐本哈希", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "abcdefg0987654321" } } ], "responses": { "200": { "description": "账户信息", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accounts" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/info": { "get": { "tags": ["account"], "summary": "查询账户信息", "description": "查询账户信息\n", "operationId": "requestAccountInfo", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "ledger", "in": "query", "description": "帐本", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": ["validated", "closed", "current", "14530000"] } } ], "responses": { "200": { "description": "账户信息", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountInfo" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/balances": { "get": { "tags": ["account"], "summary": "查询账户余额", "description": "查询账户余额\n", "operationId": "requestAccountBalances", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "ledger", "in": "query", "description": "帐本", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": ["validated", "closed", "current", "14530000"] } } ], "responses": { "200": { "description": "账户余额", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalances" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/tums": { "get": { "tags": ["account"], "summary": "查询账户可发送/接收的通证", "description": "查询账户信息\n", "operationId": "requestAccountTums", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "ledger", "in": "query", "description": "帐本", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": ["validated", "closed", "current", "14530000"] } } ], "responses": { "200": { "description": "账户可发送/接收的通证", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountTums" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/relations/{type}": { "get": { "tags": ["account"], "summary": "查询账户关系", "description": "查询账户关系\n", "operationId": "requestAccountRelations", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "type", "in": "path", "description": "关系类型", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": ["trust", "authorize", "freeze"] } }, { "name": "ledger", "in": "query", "description": "帐本", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": ["validated", "closed", "current", "14530000"] } }, { "name": "peer", "in": "query", "description": "对等地址", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "jabcdef0987654321ghijkomn" } } ], "responses": { "200": { "description": "账户关系", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRelation" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/payments": { "get": { "tags": ["account"], "summary": "查询账户支付记录", "description": "查询账户支付记录\n", "operationId": "requestAccountPayments", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "ledger_min", "in": "query", "description": "最小索引数", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 266955 } }, { "name": "ledger_max", "in": "query", "description": "最大索引数", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 12345678 } }, { "name": "marker", "in": "query", "description": "位置标记", "required": false, "style": "deepObject", "explode": false, "schema": { "$ref": "#/components/schemas/Marker" } }, { "name": "forward", "in": "query", "description": "向前查", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "账户支付记录", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPayments" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/payments/{hash}": { "get": { "tags": ["account"], "summary": "查询账户某个支付", "description": "查询账户某个支付\n", "operationId": "requestAccountPayment", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "hash", "in": "path", "description": "哈希字符串", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "C734E07774A0BFD30387AE83C18B63E350EAD1051871B7DF8A74D89A9822" } } ], "responses": { "200": { "description": "账户某个支付", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/transactions": { "get": { "tags": ["account"], "summary": "查询账户事务记录", "description": "查询账户事务记录\n", "operationId": "requestAccountTransactions", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "limit", "in": "query", "description": "数量限制", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "enum": [300, 500] } }, { "name": "ledger_min", "in": "query", "description": "最小索引数", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 266955 } }, { "name": "ledger_max", "in": "query", "description": "最大索引数", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 12345678 } }, { "name": "marker", "in": "query", "description": "位置标记", "required": false, "style": "deepObject", "explode": false, "schema": { "$ref": "#/components/schemas/Marker" } }, { "name": "offset", "in": "query", "description": "位移", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }, { "name": "forward", "in": "query", "description": "向前查", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "账户事务记录", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountTransactions" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/transactions/{hash}": { "get": { "tags": ["account"], "summary": "查询账户某个事务", "description": "查询账户某个事务\n", "operationId": "requestAccountTransaction", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "hash", "in": "path", "description": "哈希字符串", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "C734E07774A0BFD30387AE83C18B63E350EAD1051871B7DF8A74D89A9822" } } ], "responses": { "200": { "description": "账户某个事务", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountTransaction" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/orders": { "get": { "tags": ["account"], "summary": "查询账户挂单列表", "description": "查询账户挂单列表\n", "operationId": "requestAccountOrders", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "ledger", "in": "query", "description": "帐本", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": ["validated", "closed", "current", "14530000"] } } ], "responses": { "200": { "description": "账户挂单列表", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOrders" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/orders/{hash}": { "get": { "tags": ["account"], "summary": "查询账户某个挂单", "description": "查询账户某个挂单\n", "operationId": "requestAccountOrder", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, { "name": "hash", "in": "path", "description": "哈希字符串", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "C734E07774A0BFD30387AE83C18B63E350EAD1051871B7DF8A74D89A9822" } } ], "responses": { "200": { "description": "账户某个挂单", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/accounts/{account}/signerlist": { "get": { "tags": ["account"], "summary": "查询账户多重签名列表", "description": "查询账户多重签名列表\n", "operationId": "getAccountSignerList", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } } ], "responses": { "200": { "description": "账户多签列表", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignerList" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/brokers/{account}": { "get": { "tags": ["brokerage"], "summary": "查询代理收费", "description": "查询代理佣金\n", "operationId": "getBrokerage", "parameters": [ { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } } ], "responses": { "200": { "description": "代理佣金", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Brokerages" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/order_book/{gets}/{pays}": { "get": { "tags": ["orderbook"], "summary": "查询挂单列表", "description": "查询挂单列表\n", "operationId": "requestOrderBook", "parameters": [ { "name": "gets", "in": "path", "description": "获得的通证", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "SWT" } }, { "name": "pays", "in": "path", "description": "支付的通证", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "CNY+jGa9J9TkqtBcUoHe2zqhVFFbgUVED6o9or" } }, { "name": "limit", "in": "query", "description": "数量限制", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "enum": [300, 500] } } ], "responses": { "200": { "description": "挂单列表", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderBook" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/transactions/{hash}": { "get": { "tags": ["transaction"], "summary": "查询某个事务", "description": "查询某个事务\n", "operationId": "requestTransaction", "parameters": [ { "name": "hash", "in": "path", "description": "哈希字符串", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "C734E07774A0BFD30387AE83C18B63E350EAD1051871B7DF8A74D89A9822" } } ], "responses": { "200": { "description": "事务", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/ledgers/closed": { "get": { "tags": ["ledger"], "summary": "查询最新关闭的帐本", "description": "查询最新关闭的帐本\n", "operationId": "requestLedgerClosed", "responses": { "200": { "description": "最新关闭的帐本", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/ledgers/index/{index}": { "get": { "tags": ["ledger"], "summary": "按照高度查询帐本", "description": "查询指定高度的帐本\n", "operationId": "requestLedgerByIndex", "parameters": [ { "name": "index", "in": "path", "description": "索引数", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 12345678 } } ], "responses": { "200": { "description": "指定高度的帐本", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/ledgers/hash/{hash}": { "get": { "tags": ["ledger"], "summary": "按照哈希查询帐本", "description": "查询指定哈希的帐本\n", "operationId": "requestLedgerByHash", "parameters": [ { "name": "hash", "in": "path", "description": "哈希字符串", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "C734E07774A0BFD30387AE83C18B63E350EAD1051871B7DF8A74D89A9822" } } ], "responses": { "200": { "description": "指定哈希的帐本", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/blob": { "post": { "tags": ["blob"], "summary": "提交单签事务", "description": "提交单签事务", "operationId": "submitBlob", "requestBody": { "description": "对象格式", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blob" } } } }, "responses": { "200": { "description": "成功提交", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitBlob" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/multisign": { "post": { "tags": ["multisign"], "summary": "提交多签过的事务", "description": "提交多签事务", "operationId": "submitMultisign", "requestBody": { "description": "对象格式", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Multisign" } } } }, "responses": { "200": { "description": "成功提交", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitMultisign" } } } }, "400": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } } }, "components": { "schemas": { "ApiError": { "required": ["code", "description"], "type": "object", "properties": { "code": { "type": "string", "example": "api:backend" }, "message": { "type": "string", "example": "后端有问题" } } }, "RateLimitError": { "required": ["code", "description"], "type": "object", "properties": { "code": { "type": "string", "example": "api:ratelimit" }, "message": { "type": "string", "example": "已达到访问限制次数" } } }, "Server": { "required": [ "complete_ledgers", "ledger", "peers", "public_key", "state", "version" ], "type": "object", "properties": { "complete_ledgers": { "type": "string", "example": "266955-14533147" }, "public_key": { "type": "string", "example": "n9J1qmabAVgRfQ2DPXRzt58odeGsb5FiGCeg2iUCbZ5nRnWuMncc" }, "peers": { "type": "integer", "example": 13 }, "state": { "type": "string", "example": "full 05:87:44" }, "version": { "type": "string", "example": "skywelld-0.28.1" }, "ledger": { "type": "string", "example": "AACBAD7B6CC7FAF944D1A889CA384670CEED4048E41957E94AAB0D09B447CD4F" } } }, "Accounts": { "required": ["info", "ledger_hash", "ledger_index"], "type": "object", "properties": { "ledger_index": { "type": "number", "example": 123456789 }, "ledger_hash": { "type": "string", "example": "abcdefg1234567890" }, "marker": { "type": "string" }, "info": { "type": "array", "items": { "$ref": "#/components/schemas/Accounts_info" } } } }, "AccountBalances": { "required": ["balances", "sequence"], "type": "object", "properties": { "sequence": { "type": "integer", "example": 100 }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalances_balances" } } } }, "Brokerages": { "required": ["account", "brokerages", "ledger_hash", "ledger_index"], "type": "object", "properties": { "ledger_index": { "type": "number", "example": 123456789 }, "account": { "type": "string", "example": "jabcdefg1234567890" }, "ledger_hash": { "type": "string", "example": "POIUYTR1234567890" }, "brokerages": { "type": "array", "items": { "$ref": "#/components/schemas/Brokerage" } } } }, "Brokerage": { "required": [ "FeeCurrency", "FeeCurrencyIssuer", "OfferFeeRateDen", "OfferFeeRateNum", "Platform", "fee_account" ], "type": "object", "properties": { "FeeCurrency": { "type": "string" }, "FeeCurrencyIssuer": { "type": "string", "example": "jabcdefghi67890" }, "OfferFeeRateDen": { "type": "integer", "example": 1000 }, "OfferFeeRateNum": { "type": "integer", "example": 2 }, "Platform": { "type": "string", "example": "jqwerrtyy7654289" }, "fee_account": { "type": "string", "example": "jqwerrtyy7654289" } } }, "SignerList": { "required": ["account", "account_objects", "ledger_current_index"], "type": "object", "properties": { "ledger_current_index": { "type": "number", "example": 123456789 }, "account": { "type": "string", "example": "abcdefg1234567890" }, "account_objects": { "$ref": "#/components/schemas/AccountObjects" } } }, "AccountObjects": { "required": ["LedgerEntryType", "SignerEntries", "SignerQuorum"], "type": "object", "properties": { "LedgerEntryType": { "type": "string", "example": "SignerList" }, "SignerQuorum": { "type": "number", "example": 3 }, "SignerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/SignerEntry" } } } }, "SignerEntry": { "required": ["Account", "SignerWeight"], "type": "object", "properties": { "Account": { "type": "string", "example": "jabcdefghijklmn0987654321" }, "SignerWeight": { "type": "number", "example": 4 } } }, "AccountInfo": { "required": ["account_data", "ledger_hash", "ledger_index"], "type": "object", "properties": { "ledger_index": { "type": "number", "example": 123456789 }, "ledger_hash": { "type": "string", "example": "abcdefg1234567890" }, "validated": { "type": "boolean" }, "account_data": { "$ref": "#/components/schemas/AccountData" } } }, "AccountTums": { "required": [ "ledger_hash", "ledger_index", "receive_currencies", "send_currencies" ], "type": "object", "properties": { "ledger_index": { "type": "number", "example": 123456789 }, "ledger_hash": { "type": "string", "example": "abcdefg1234567890" }, "validated": { "type": "boolean" }, "receive_currencies": { "type": "array", "items": { "type": "string", "example": "VCC" } }, "send_currencies": { "type": "array", "items": { "type": "string", "example": "CNY" } } } }, "AccountRelation": { "required": ["account", "ledger_hash", "ledger_index", "lines"], "type": "object", "properties": { "ledger_index": { "type": "number", "example": 123456789 }, "ledger_hash": { "type": "string", "example": "abcdefg1234567890" }, "validated": { "type": "boolean" }, "account": { "type": "string", "example": "jabcdef1233" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/RelationLine" } } } }, "RelationLine": { "required": ["currency", "limit"], "type": "object", "properties": { "account": { "type": "string", "example": "jabcde12345XYZ" }, "balance": { "type": "number", "example": 100 }, "currency": { "type": "string", "example": "CNY" }, "issuer": { "type": "string", "example": "jabcdefghijklmn0987654321" }, "limit": { "type": "number", "example": 10000 }, "limit_peer": { "type": "string", "example": "jabcdefghijklmn0987654321" }, "relation_type": { "type": "integer", "example": 1 }, "quality_in": { "type": "number", "example": 100 }, "quality_out": { "type": "number", "example": 200 } } }, "AccountData": { "required": ["Account", "Balance", "Index", "Sequence"], "type": "object", "properties": { "Account": { "type": "string", "example": "jabcdef123456" }, "Balance": { "type": "number", "example": 102344 }, "Sequence": { "type": "number", "example": 123 }, "Index": { "type": "string", "example": "ABCDEFG0912343" } } }, "Amount": { "required": ["currency", "issuer", "value"], "type": "object", "properties": { "value": { "type": "number", "example": 100 }, "currency": { "type": "string", "example": "CNY" }, "issuer": { "type": "string", "example": "jabcdef0123456789XYZ" } } }, "Currency": { "required": ["currency", "issuer"], "type": "object", "properties": { "currency": { "type": "string", "example": "CNY" }, "issuer": { "type": "string", "example": "jabcdef0123456789XYZ" } } }, "Balance": { "required": ["SWT"], "type": "object", "properties": { "SWT": { "type": "number", "example": 1.23 } } }, "Memo": { "required": ["MemoData"], "type": "object", "properties": { "MemoData": { "type": "string", "example": "memo value" } } }, "Marker": { "required": ["ledger", "seq"], "type": "object", "properties": { "ledger": { "type": "number", "example": 12345678 }, "seq": { "type": "number", "example": 5 } } }, "AccountPayments": { "required": ["account", "payments"], "type": "object", "properties": { "account": { "type": "string", "example": "abcdef0123456789" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } }, "marker": { "$ref": "#/components/schemas/Marker" }, "limit": { "type": "number", "example": 20 }, "ledger_index_min": { "type": "number", "example": 266955 }, "ledger_index_max": { "type": "number", "example": 14009876 } } }, "AccountTransactions": { "required": ["account", "transactions"], "type": "object", "properties": { "account": { "type": "string", "example": "abcdef0123456789" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTransaction" } }, "marker": { "$ref": "#/components/schemas/Marker" }, "limit": { "type": "number", "example": 20 }, "ledger_index_min": { "type": "number", "example": 266955 }, "ledger_index_max": { "type": "number", "example": 14009876 } } }, "Transaction": { "required": ["TransactionType", "date", "hash", "ledger_index", "meta"], "type": "object", "properties": { "TransactionType": { "type": "string", "example": "Payment" }, "date": { "type": "number", "example": 1234567 }, "hash": { "type": "string", "example": "ABCDEF0987654321" }, "ledger_index": { "type": "integer", "example": 12345678 }, "meta": { "type": "object" } } }, "Payment": { "required": [ "amount", "balances", "counterparty", "date", "hash", "memos", "result", "type" ], "type": "object", "properties": { "counterparty": { "type": "string", "example": "jabcdef0123456789XYZ" }, "amount": { "$ref": "#/components/schemas/Amount" }, "balances": { "$ref": "#/components/schemas/Balance" }, "balancesPrev": { "type": "object" }, "date": { "type": "number", "example": 1234567 }, "hash": { "type": "string", "example": "ABCDEF0987654321" }, "type": { "type": "string", "example": "sent" }, "result": { "type": "string", "example": "testSuccess" }, "memos": { "type": "array", "items": { "$ref": "#/components/schemas/Memo" } } } }, "AccountTransaction": { "required": ["date", "hash", "memos", "result", "type"], "type": "object", "properties": { "balances": { "type": "object" }, "balancesPrev": { "type": "object" }, "date": { "type": "number", "example": 1234567 }, "hash": { "type": "string", "example": "ABCDEF0987654321" }, "type": { "type": "string", "example": "sent" }, "result": { "type": "string", "example": "testSuccess" }, "memos": { "type": "array", "items": { "$ref": "#/components/schemas/Memo" } } } }, "AccountOrders": { "required": ["account", "orders", "validated"], "type": "object", "properties": { "validated": { "type": "boolean", "example": true }, "account": { "type": "string", "example": "abcdef0123456789" }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/AccountOrder" } }, "marker": { "$ref": "#/components/schemas/Marker" }, "limit": { "type": "number", "example": 20 }, "ledger_index_min": { "type": "number", "example": 266955 }, "ledger_index_max": { "type": "number", "example": 14009876 } } }, "AccountOrder": { "required": ["flags", "seq", "taker_gets", "taker_pays"], "type": "object", "properties": { "flags": { "type": "number", "example": 1234567 }, "seq": { "type": "number", "example": 98 }, "taker_gets": { "$ref": "#/components/schemas/Amount" }, "taker_pays": { "$ref": "#/components/schemas/Amount" } } }, "Order": { "required": [ "date", "fee", "gets", "hash", "memos", "offertype", "pays", "result", "seq", "type" ], "type": "object", "properties": { "date": { "type": "number", "example": 1234567 }, "seq": { "type": "number", "example": 98 }, "balances": { "$ref": "#/components/schemas/Balance" }, "balancesPrev": { "$ref": "#/components/schemas/Balance" }, "hash": { "type": "string", "example": "ABCDEFG09876543221" }, "fee": { "type": "number", "example": 0.0001 }, "offertype": { "type": "string", "example": "buy" }, "gets": { "$ref": "#/components/schemas/Amount" }, "pays": { "$ref": "#/components/schemas/Amount" }, "memos": { "type": "array", "items": { "$ref": "#/components/schemas/Memo" } } } }, "OrderBook": { "required": ["ledger_current_index", "offers", "validated"], "type": "object", "properties": { "ledger_current_index": { "type": "number", "example": 12345678 }, "validated": { "type": "boolean", "example": false }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" } } } }, "Offer": { "required": [ "Account", "Flags", "Sequence", "TakerGets", "TakerPays", "owner_funds", "quality" ], "type": "object", "properties": { "Flags": { "type": "number", "example": 1234567 }, "Sequence": { "type": "number", "example": 98 }, "Account": { "type": "string", "example": "jabcdef0987654321" }, "TakerGets": { "$ref": "#/components/schemas/Amount" }, "TakerPays": { "$ref": "#/components/schemas/Amount" }, "owner_funds": { "type": "number", "example": 100.234 }, "quality": { "type": "number", "example": 12345.679 }, "OfferFeeRateDen": { "type": "number", "example": 10000 }, "OfferFeeRateNum": { "type": "number", "example": 2 }, "Platform": { "type": "string", "example": "jabcdef0987654321" }, "FeeCurrency": { "oneOf": [ { "$ref": "#/components/schemas/Currency" }, { "type": "string" } ] } } }, "Ledger": { "required": [ "closed", "hash", "ledger_hash", "ledger_index", "parent_hash", "total_coins", "transaction_hash" ], "type": "object", "properties": { "hash": { "type": "string", "example": "443C1220F06167A2B36F729B18C21E87EA56EC67DEC1F6536F274BA1233E935C" }, "closed": { "type": "boolean", "example": false }, "parent_hash": { "type": "string", "example": "BBC4F12052E2BBF2EA2EBF635471F52F71B0709704BE531813E3B408388CFA6B" }, "ledger_hash": { "type": "string", "example": "443C1220F06167A2B36F729B18C21E87EA56EC67DEC1F6536F274BA1233E935C" }, "ledger_index": { "type": "integer", "example": 12345678 }, "accepted": { "type": "boolean", "example": false }, "close_time": { "type": "integer", "example": 627873190 }, "close_time_human": { "type": "string", "example": "2019-Nov-24 01:13:10" }, "total_coins": { "type": "number", "example": 599999999999460700 }, "transaction_hash": { "type": "string", "example": "8B32BA623D2B231308DA60E0CF08060612F9FBEC663983BA9FB76F75A2D02655" } } }, "Blob": { "required": ["blob"], "type": "object", "properties": { "blob": { "type": "string", "example": "120000220000000024000000646140000000000F4240684000000000002710732102197F1426BCA2F59B6B910F0391E55888B4FE80AF962478493104A33274B1B03A744730450221008642638363C4967233FAAB98E1A05BE49D175E3531480CE9E3EF0935B78825BA02200253B26EA4B85610F06982F39F816662B8AAE45C846675246AE106B6C62BF55E8114AF09183A11AA70DA06E115E03B0E5478232740B58314DA976A4DE4827163F062B09050832D8D78025D5A" } } }, "Multisign": { "required": ["tx_json"], "type": "object", "properties": { "tx_json": { "type": "object" } } }, "SubmitBlob": { "required": [ "engine_result", "engine_result_code", "engine_result_message", "tx_blob", "tx_json" ], "type": "object", "properties": { "engine_result": { "type": "string", "example": "telBLKLIST" }, "engine_result_code": { "type": "number", "example": -392 }, "engine_result_message": { "type": "string", "example": "tx disable for blacklist" }, "tx_blob": { "type": "string", "example": "120000220000000024000000646140000000000F4240684000000000002710732102197F1426BCA2F59B6B910F0391E55888B4FE80AF962478493104A33274B1B03A744730450221008642638363C4967233FAAB98E1A05BE49D175E3531480CE9E3EF0935B78825BA02200253B26EA4B85610F06982F39F816662B8AAE45C846675246AE106B6C62BF55E8114AF09183A11AA70DA06E115E03B0E5478232740B58314DA976A4DE4827163F062B09050832D8D78025D5A" }, "tx_json": { "type": "object" } } }, "SubmitMultisign": { "required": [ "engine_result", "engine_result_code", "engine_result_message", "tx_blob", "tx_json" ], "type": "object", "properties": { "engine_result": { "type": "string", "example": "tefPAST_SEQ" }, "engine_result_code": { "type": "number", "example": -190 }, "engine_result_message": { "type": "string", "example": "This sequence number has already past." }, "tx_blob": { "type": "string", "example": "120000220000000024000000646140000000000F4240684000000000002710732102197F1426BCA2F59B6B910F0391E55888B4FE80AF962478493104A33274B1B03A744730450221008642638363C4967233FAAB98E1A05BE49D175E3531480CE9E3EF0935B78825BA02200253B26EA4B85610F06982F39F816662B8AAE45C846675246AE106B6C62BF55E8114AF09183A11AA70DA06E115E03B0E5478232740B58314DA976A4DE4827163F062B09050832D8D78025D5A" }, "tx_json": { "type": "object" } } }, "inline_response_200": { "required": ["ledger_hash", "ledger_index"], "type": "object", "properties": { "ledger_hash": { "type": "string", "example": "ABCDEF0987654321" }, "ledger_index": { "type": "integer", "example": 12345678 } } }, "Accounts_info": { "type": "object", "properties": { "Amount": { "type": "string", "example": "35000000" }, "account": { "type": "string", "example": "j1234567890poiuytr" } } }, "AccountBalances_balances": { "required": ["currency", "issuer", "value"], "type": "object", "properties": { "value": { "type": "number" }, "currency": { "type": "string" }, "issuer": { "type": "string" }, "freezed": { "type": "number" } } } }, "responses": { "ApiError": { "description": "API出问题了", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "RateLimitError": { "description": "访问限制错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "parameters": { "account": { "name": "account", "in": "path", "description": "钱包地址", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "jpmKEm2sUevfpFjS7QHdT8Sx7ZGoEXTJAz" } }, "type": { "name": "type", "in": "path", "description": "关系类型", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": ["trust", "authorize", "freeze"] } }, "hash": { "name": "hash", "in": "path", "description": "哈希字符串", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "C734E07774A0BFD30387AE83C18B63E350EAD1051871B7DF8A74D89A9822" } }, "index": { "name": "index", "in": "path", "description": "索引数", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 12345678 } }, "ledgerhash": { "name": "ledger_hash", "in": "path", "description": "哈希字符串", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "C734E07774A0BFD30387AE83C18B63E350EAD1051871B7DF8A74D89A9822" } }, "ledgerindex": { "name": "ledger_index", "in": "path", "description": "索引数", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 12345678 } }, "gets": { "name": "gets", "in": "path", "description": "获得的通证", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "SWT" } }, "pays": { "name": "pays", "in": "path", "description": "支付的通证", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "CNY+jGa9J9TkqtBcUoHe2zqhVFFbgUVED6o9or" } }, "ledger": { "name": "ledger", "in": "query", "description": "帐本", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": ["validated", "closed", "current", "14530000"] } }, "ledger_min": { "name": "ledger_min", "in": "query", "description": "最小索引数", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 266955 } }, "ledger_max": { "name": "ledger_max", "in": "query", "description": "最大索引数", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 12345678 } }, "ledger_index": { "name": "ledger_index", "in": "query", "description": "帐本索引", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 12345678 } }, "ledger_hash": { "name": "ledger_hash", "in": "query", "description": "帐本哈希", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "abcdefg0987654321" } }, "limit": { "name": "limit", "in": "query", "description": "数量限制", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "enum": [300, 500] } }, "forward": { "name": "forward", "in": "query", "description": "向前查", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } }, "offset": { "name": "offset", "in": "query", "description": "位移", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }, "peer": { "name": "peer", "in": "query", "description": "对等地址", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "jabcdef0987654321ghijkomn" } }, "marker": { "name": "marker", "in": "query", "description": "位置标记", "required": false, "style": "deepObject", "explode": false, "schema": { "$ref": "#/components/schemas/Marker" } } } } }