Skip to content

Instantly share code, notes, and snippets.

@dmdeklerk

dmdeklerk/swagger.json

Last active September 30, 2018 13:47
Show Gist options
  • Save dmdeklerk/d5fa4d9342605a31c41bc74ae9692ef9 to your computer and use it in GitHub Desktop.
Save dmdeklerk/d5fa4d9342605a31c41bc74ae9692ef9 to your computer and use it in GitHub Desktop.
Download ZIP
paytah api
Raw
swagger.json
{
"swagger": "2.0",
"info": {
"description": "The PAYTAH <u><b>INTERACTIVE</b></u> REST API, ",
"version": "1.0",
"title": "PAYTAH API",
"contact": {
"url": "http://paytah.com/"
},
"license": {
"name": "MIT License",
"url": "https://raw.githubusercontent.com/Heat-Ledger-Ltd/heat-ui/master/LICENSE"
}
},
"host": "148.251.83.136:6688",
"basePath": "/api/v1",
"tags": [
{
"name": "Paytah Message"
},
{
"name": "Paytah History"
},
{
"name": "Paytah Transfer"
},
{
"name": "Paytah Withdrawal"
},
{
"name": "Paytah Deposit"
},
{
"name": "Paytah User"
},
{
"name": "Paytah Category"
}
],
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/blocktech-deposit-method/count/{enabledOnly}": {
"get": {
"tags": [
"DepositMethod"
],
"summary": "Count deposit methods",
"description": "",
"operationId": "count",
"produces": [
"application/json"
],
"parameters": [
{
"name": "enabledOnly",
"in": "path",
"description": "Enabled only",
"required": true,
"type": "string",
"default": "true",
"enum": [
"true",
"false"
]
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-deposit-method/find/{id}": {
"get": {
"tags": [
"DepositMethod"
],
"summary": "Find deposit method",
"description": "",
"operationId": "find",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DepositMethod"
}
}
}
}
},
"/blocktech-deposit-method/list/{enabledOnly}/{sortColumn}/{sortAsc}/{from}/{to}": {
"get": {
"tags": [
"DepositMethod"
],
"summary": "List deposits",
"description": "",
"operationId": "list",
"produces": [
"application/json"
],
"parameters": [
{
"name": "enabledOnly",
"in": "path",
"description": "Enabled only",
"required": true,
"type": "string",
"default": "true",
"enum": [
"true",
"false"
]
},
{
"name": "sortColumn",
"in": "path",
"description": "Sort column",
"required": true,
"type": "string",
"default": "TIMESTAMP"
},
{
"name": "sortAsc",
"in": "path",
"description": "Sort ascending",
"required": true,
"type": "string",
"default": "true"
},
{
"name": "from",
"in": "path",
"description": "From",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DepositMethod"
}
}
}
}
}
},
"/blocktech-deposit/count/{account}/{excludePending}/{excludeCompleted}/{excludeCancelled}": {
"get": {
"tags": [
"Paytah Deposit"
],
"summary": "Count deposits",
"description": "",
"operationId": "count",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account",
"required": true,
"type": "string"
},
{
"name": "excludePending",
"in": "path",
"description": "Exclude pending",
"required": true,
"type": "string"
},
{
"name": "excludeCompleted",
"in": "path",
"description": "Exclude completed",
"required": true,
"type": "string"
},
{
"name": "excludeCancelled",
"in": "path",
"description": "Exclude cancelled",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-deposit/create": {
"post": {
"tags": [
"Paytah Deposit"
],
"summary": "Create a deposit",
"description": "",
"operationId": "createDesposit",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
},
{
"name": "amount",
"in": "formData",
"description": "amount",
"required": false,
"type": "string"
},
{
"name": "depositMethod",
"in": "formData",
"description": "depositMethod",
"required": false,
"type": "string"
},
{
"name": "sender",
"in": "formData",
"description": "sender",
"required": false,
"type": "string"
},
{
"name": "destination",
"in": "formData",
"description": "destination",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-deposit/find/{id}": {
"get": {
"tags": [
"Paytah Deposit"
],
"summary": "Find deposit",
"description": "",
"operationId": "find",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Deposit"
}
}
}
}
},
"/blocktech-deposit/list/{account}/{excludePending}/{excludeCompleted}/{excludeCancelled}/{sortColumn}/{sortAsc}/{from}/{to}": {
"get": {
"tags": [
"Paytah Deposit"
],
"summary": "List deposits",
"description": "",
"operationId": "list",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "account",
"required": true,
"type": "string"
},
{
"name": "excludePending",
"in": "path",
"description": "Exclude pending",
"required": true,
"type": "string"
},
{
"name": "excludeCompleted",
"in": "path",
"description": "Exclude completed",
"required": true,
"type": "string"
},
{
"name": "excludeCancelled",
"in": "path",
"description": "Exclude cancelled",
"required": true,
"type": "string"
},
{
"name": "sortColumn",
"in": "path",
"description": "Sort column",
"required": true,
"type": "string",
"default": "TIMESTAMP"
},
{
"name": "sortAsc",
"in": "path",
"description": "Sort ascending",
"required": true,
"type": "string",
"default": "true"
},
{
"name": "from",
"in": "path",
"description": "From",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Deposit"
}
}
}
}
}
},
"/blocktech-deposit/update-notes": {
"post": {
"tags": [
"Paytah Deposit"
],
"summary": "Set deposit status",
"description": "",
"operationId": "updateNotes",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "secretPhrase",
"in": "formData",
"description": "secretPhrase",
"required": false,
"type": "string"
},
{
"name": "deposit",
"in": "formData",
"description": "deposit",
"required": false,
"type": "string"
},
{
"name": "notes",
"in": "formData",
"description": "notes",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-deposit/update-status": {
"post": {
"tags": [
"Paytah Deposit"
],
"summary": "Set deposit status",
"description": "",
"operationId": "updateStatus",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "secretPhrase",
"in": "formData",
"description": "secretPhrase",
"required": false,
"type": "string"
},
{
"name": "deposit",
"in": "formData",
"description": "deposit",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "formData",
"description": "status",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-history/contacts-all/{query}/{from}/{to}": {
"get": {
"tags": [
"Paytah History"
],
"summary": "Lists all contacts",
"description": "",
"operationId": "contactsAll",
"produces": [
"application/json"
],
"parameters": [
{
"name": "query",
"in": "path",
"description": "Query",
"required": true,
"type": "string"
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
}
}
}
}
},
"/blocktech-history/contacts/{account}/{query}/{from}/{to}": {
"get": {
"tags": [
"Paytah History"
],
"summary": "Lists contacts",
"description": "",
"operationId": "contacts",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account",
"required": true,
"type": "string"
},
{
"name": "query",
"in": "path",
"description": "Query",
"required": true,
"type": "string"
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
}
}
}
}
},
"/blocktech-history/list/{account}/{from}/{to}": {
"get": {
"tags": [
"Paytah History"
],
"summary": "Lists all users",
"description": "",
"operationId": "list",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account",
"required": true,
"type": "string"
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
}
}
},
"/blocktech-message/headers/{account}/{inbox}/{outbox}/{from}/{to}": {
"get": {
"tags": [
"Paytah Message"
],
"summary": "Lists all users",
"description": "",
"operationId": "headers",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account Id",
"required": true,
"type": "string"
},
{
"name": "inbox",
"in": "path",
"description": "Include inbox",
"required": true,
"type": "string"
},
{
"name": "outbox",
"in": "path",
"description": "Include outbox",
"required": true,
"type": "string"
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Message"
}
}
}
}
}
},
"/blocktech-message/headers2/count/{account}/{receivedOnly}/{sentOnly}/{contact}/{trashed}": {
"get": {
"tags": [
"Paytah Message"
],
"summary": "Lists all users",
"description": "",
"operationId": "headers2Count",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account Id",
"required": true,
"type": "string"
},
{
"name": "receivedOnly",
"in": "path",
"description": "receivedOnly",
"required": true,
"type": "string"
},
{
"name": "sentOnly",
"in": "path",
"description": "sentOnly",
"required": true,
"type": "string"
},
{
"name": "contact",
"in": "path",
"description": "contact",
"required": true,
"type": "string"
},
{
"name": "trashed",
"in": "path",
"description": "trashed",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Count"
}
}
}
}
}
},
"/blocktech-message/headers2/{account}/{receivedOnly}/{sentOnly}/{contact}/{trashed}/{from}/{to}": {
"get": {
"tags": [
"Paytah Message"
],
"summary": "Lists all users",
"description": "",
"operationId": "headers2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account Id",
"required": true,
"type": "string"
},
{
"name": "receivedOnly",
"in": "path",
"description": "receivedOnly",
"required": true,
"type": "string"
},
{
"name": "sentOnly",
"in": "path",
"description": "sentOnly",
"required": true,
"type": "string"
},
{
"name": "contact",
"in": "path",
"description": "contact",
"required": true,
"type": "string"
},
{
"name": "trashed",
"in": "path",
"description": "trashed",
"required": true,
"type": "string"
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MessageHeader"
}
}
}
}
}
},
"/blocktech-message/messages/{thread}/{from}/{to}": {
"get": {
"tags": [
"Paytah Message"
],
"summary": "Lists all users",
"description": "",
"operationId": "messages",
"produces": [
"application/json"
],
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Thread Id",
"required": true,
"type": "string"
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/User"
}
}
}
}
}
},
"/blocktech-message/thread-reply": {
"post": {
"tags": [
"Paytah Message"
],
"summary": "Start message thread",
"description": "",
"operationId": "threadReply",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
},
{
"name": "recipient",
"in": "formData",
"description": "recipient",
"required": false,
"type": "string"
},
{
"name": "thread",
"in": "formData",
"description": "thread",
"required": false,
"type": "string"
},
{
"name": "content",
"in": "formData",
"description": "content",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-message/thread-reply-secretphrase": {
"post": {
"tags": [
"Paytah Message"
],
"summary": "Start message thread",
"description": "",
"operationId": "threadReplySecretPhrase",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "secretPhrase",
"in": "formData",
"description": "secretPhrase",
"required": false,
"type": "string"
},
{
"name": "recipient",
"in": "formData",
"description": "recipient",
"required": false,
"type": "string"
},
{
"name": "thread",
"in": "formData",
"description": "thread",
"required": false,
"type": "string"
},
{
"name": "content",
"in": "formData",
"description": "content",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-message/thread-start": {
"post": {
"tags": [
"Paytah Message"
],
"summary": "Start message thread",
"description": "",
"operationId": "threadStart",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
},
{
"name": "recipient",
"in": "formData",
"description": "recipient",
"required": false,
"type": "string"
},
{
"name": "topic",
"in": "formData",
"description": "topic",
"required": false,
"type": "string"
},
{
"name": "content",
"in": "formData",
"description": "content",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-message/thread-start-secretphrase": {
"post": {
"tags": [
"Paytah Message"
],
"summary": "Start message thread",
"description": "",
"operationId": "threadStartSecretPhrase",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "secretPhrase",
"in": "formData",
"description": "secretPhrase",
"required": false,
"type": "string"
},
{
"name": "recipient",
"in": "formData",
"description": "recipient",
"required": false,
"type": "string"
},
{
"name": "topic",
"in": "formData",
"description": "topic",
"required": false,
"type": "string"
},
{
"name": "content",
"in": "formData",
"description": "content",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-message/thread-update": {
"post": {
"tags": [
"Paytah Message"
],
"summary": "Update message thread",
"description": "",
"operationId": "threadUpdateEmail",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
},
{
"name": "thread",
"in": "formData",
"description": "thread",
"required": false,
"type": "string"
},
{
"name": "property",
"in": "formData",
"description": "property",
"required": false,
"type": "string"
},
{
"name": "value",
"in": "formData",
"description": "value",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-message/thread-update-secretphrase": {
"post": {
"tags": [
"Paytah Message"
],
"summary": "Update message thread",
"description": "",
"operationId": "threadUpdateSecretPhrase",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "secretPhrase",
"in": "formData",
"description": "secretPhrase",
"required": false,
"type": "string"
},
{
"name": "thread",
"in": "formData",
"description": "thread",
"required": false,
"type": "string"
},
{
"name": "property",
"in": "formData",
"description": "property",
"required": false,
"type": "string"
},
{
"name": "value",
"in": "formData",
"description": "value",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-system/eur-asset-id": {
"get": {
"tags": [
"Paytah Debug"
],
"summary": "Create EUR asset, returns asset ID",
"description": "",
"operationId": "eurAssetId",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-transfer/transfer": {
"post": {
"tags": [
"Paytah Transfer"
],
"summary": "Transfer currency to other account",
"description": "",
"operationId": "createDesposit",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
},
{
"name": "amount",
"in": "formData",
"description": "amount",
"required": false,
"type": "string"
},
{
"name": "currency",
"in": "formData",
"description": "currency",
"required": false,
"type": "string"
},
{
"name": "recipient",
"in": "formData",
"description": "recipient",
"required": false,
"type": "string"
},
{
"name": "message",
"in": "formData",
"description": "message",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-user/balance/{account}/{currency}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Find user currency balance",
"description": "",
"operationId": "balance",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account id",
"required": true,
"type": "string"
},
{
"name": "currency",
"in": "path",
"description": "Currency id",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-user/confirm/{challenge}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Confirm the challenge",
"description": "",
"operationId": "confirm",
"produces": [
"application/json"
],
"parameters": [
{
"name": "challenge",
"in": "path",
"description": "Challenge",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "successful operation"
}
}
}
},
"/blocktech-user/find-by-email/{email}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Find user by id",
"description": "",
"operationId": "findByEmail",
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "path",
"description": "User email",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/User"
}
}
}
}
},
"/blocktech-user/find/{id}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Find user by id",
"description": "",
"operationId": "find",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "User id",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/User"
}
}
}
}
},
"/blocktech-user/list/count/{category}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Count all users",
"description": "",
"operationId": "listCount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "category",
"in": "path",
"description": "Category Id",
"required": true,
"type": "string",
"default": "0"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Count"
}
}
}
}
},
"/blocktech-user/list/{category}/{sort}/{asc}/{from}/{to}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Lists all users",
"description": "",
"operationId": "list",
"produces": [
"application/json"
],
"parameters": [
{
"name": "category",
"in": "path",
"description": "Category Id",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "sort",
"in": "path",
"description": "Sort order",
"required": true,
"type": "string",
"default": "sort",
"enum": [
"account",
"email",
"timestamp",
"name",
"address",
"postal_code",
"city",
"country",
"phone",
"social_id",
"iban",
"notes",
"category"
]
},
{
"name": "asc",
"in": "path",
"description": "Sort ascending",
"required": true,
"type": "string",
"default": "false",
"enum": [
"true",
"false"
]
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/User"
}
}
}
}
}
},
"/blocktech-user/register-onpex/{account}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Register an onpex client",
"description": "",
"operationId": "registerOnpex",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "Account",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
}
}
}
},
"/blocktech-user/search/count/{searchQuery}/{searchColumn}/{category}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Count search results",
"description": "",
"operationId": "countSearch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "searchQuery",
"in": "path",
"description": "Search query",
"required": true,
"type": "string"
},
{
"name": "searchColumn",
"in": "path",
"description": "Search column",
"required": true,
"type": "string",
"default": "email",
"enum": [
"email",
"name",
"address",
"postal_code",
"phone",
"social_id",
"iban"
]
},
{
"name": "category",
"in": "path",
"description": "Category Id",
"required": true,
"type": "string",
"default": "0"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Count"
}
}
}
}
},
"/blocktech-user/search/{searchQuery}/{searchColumn}/{category}/{sort}/{asc}/{from}/{to}": {
"get": {
"tags": [
"Paytah User"
],
"summary": "Lists all users",
"description": "",
"operationId": "search",
"produces": [
"application/json"
],
"parameters": [
{
"name": "searchQuery",
"in": "path",
"description": "Search query",
"required": true,
"type": "string"
},
{
"name": "searchColumn",
"in": "path",
"description": "Search column",
"required": true,
"type": "string",
"default": "email",
"enum": [
"email",
"name",
"address",
"postal_code",
"phone",
"social_id",
"iban"
]
},
{
"name": "category",
"in": "path",
"description": "Category Id",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "sort",
"in": "path",
"description": "Sort order",
"required": true,
"type": "string",
"default": "email",
"enum": [
"account",
"email",
"timestamp",
"name",
"address",
"postal_code",
"city",
"country",
"phone",
"social_id",
"iban",
"notes",
"category"
]
},
{
"name": "asc",
"in": "path",
"description": "Sort ascending",
"required": true,
"type": "string",
"default": "true",
"enum": [
"true",
"false"
]
},
{
"name": "from",
"in": "path",
"description": "From index",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To index",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/User"
}
}
}
}
}
},
"/blocktech-user/signin": {
"post": {
"tags": [
"Paytah User"
],
"summary": "Signin (returns your account number)",
"description": "",
"operationId": "signin",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-user/signup": {
"post": {
"tags": [
"Paytah User"
],
"summary": "User signup, reply to email to complete",
"description": "",
"operationId": "signup",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "name",
"in": "formData",
"description": "name",
"required": false,
"type": "string"
},
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "country",
"in": "formData",
"description": "country",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
},
{
"name": "isCompany",
"in": "formData",
"description": "isCompany",
"required": false,
"type": "string"
},
{
"name": "dateOfBirth",
"in": "formData",
"description": "dateOfBirth",
"required": false,
"type": "string"
},
{
"name": "placeOfBirth",
"in": "formData",
"description": "placeOfBirth",
"required": false,
"type": "string"
},
{
"name": "address",
"in": "formData",
"description": "address",
"required": false,
"type": "string"
},
{
"name": "socialId",
"in": "formData",
"description": "socialId",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-withdrawal/count/{account}/{excludePending}/{excludeCompleted}/{excludeCancelled}/{excludeFrozen}": {
"get": {
"tags": [
"Paytah Withdrawal"
],
"summary": "Count withdrawals",
"description": "",
"operationId": "count",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "account",
"required": true,
"type": "string"
},
{
"name": "excludePending",
"in": "path",
"description": "Exclude pending",
"required": true,
"type": "string"
},
{
"name": "excludeCompleted",
"in": "path",
"description": "Exclude completed",
"required": true,
"type": "string"
},
{
"name": "excludeCancelled",
"in": "path",
"description": "Exclude cancelled",
"required": true,
"type": "string"
},
{
"name": "excludeFrozen",
"in": "path",
"description": "Exclude frozen",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Value"
}
}
}
}
},
"/blocktech-withdrawal/create": {
"post": {
"tags": [
"Paytah Withdrawal"
],
"summary": "Create withdrawal",
"description": "",
"operationId": "createWithdrawal",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "email",
"in": "formData",
"description": "email",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "formData",
"description": "password",
"required": false,
"type": "string"
},
{
"name": "amount",
"in": "formData",
"description": "amount",
"required": false,
"type": "string"
},
{
"name": "currency",
"in": "formData",
"description": "currency",
"required": false,
"type": "string"
},
{
"name": "speed",
"in": "formData",
"description": "speed",
"required": false,
"type": "string"
},
{
"name": "receiver",
"in": "formData",
"description": "receiver",
"required": false,
"type": "string"
},
{
"name": "destination",
"in": "formData",
"description": "destination",
"required": false,
"type": "string"
},
{
"name": "swift",
"in": "formData",
"description": "swift",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
},
"/blocktech-withdrawal/find/{id}": {
"get": {
"tags": [
"Paytah Withdrawal"
],
"summary": "Find withdrawal",
"description": "",
"operationId": "find",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Withdrawal"
}
}
}
}
},
"/blocktech-withdrawal/list/{account}/{excludePending}/{excludeCompleted}/{excludeCancelled}/{excludeFrozen}/{sortColumn}/{sortAsc}/{from}/{to}": {
"get": {
"tags": [
"Paytah Withdrawal"
],
"summary": "List withdrawals",
"description": "",
"operationId": "list",
"produces": [
"application/json"
],
"parameters": [
{
"name": "account",
"in": "path",
"description": "account",
"required": true,
"type": "string"
},
{
"name": "excludePending",
"in": "path",
"description": "Exclude pending",
"required": true,
"type": "string"
},
{
"name": "excludeCompleted",
"in": "path",
"description": "Exclude completed",
"required": true,
"type": "string"
},
{
"name": "excludeCancelled",
"in": "path",
"description": "Exclude cancelled",
"required": true,
"type": "string"
},
{
"name": "excludeFrozen",
"in": "path",
"description": "Exclude frozen",
"required": true,
"type": "string"
},
{
"name": "sortColumn",
"in": "path",
"description": "Sort column",
"required": true,
"type": "string",
"default": "TIMESTAMP"
},
{
"name": "sortAsc",
"in": "path",
"description": "Sort ascending",
"required": true,
"type": "string",
"default": "true"
},
{
"name": "from",
"in": "path",
"description": "From",
"required": true,
"type": "string",
"default": "0"
},
{
"name": "to",
"in": "path",
"description": "To",
"required": true,
"type": "string",
"default": "100"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Withdrawal"
}
}
}
}
}
},
"/blocktech-withdrawal/update-status": {
"post": {
"tags": [
"Paytah Withdrawal"
],
"summary": "Set withdrawal status",
"description": "",
"operationId": "updateStatus",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "secretPhrase",
"in": "formData",
"description": "secretPhrase",
"required": false,
"type": "string"
},
{
"name": "withdrawal",
"in": "formData",
"description": "withdrawal",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "formData",
"description": "status",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Success"
}
}
}
}
}
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "query"
}
},
"definitions": {
"Account": {
"type": "object",
"required": [
"balance",
"currentLeasingHeightFrom",
"currentLeasingHeightTo",
"currentLessee",
"currentLesseeName",
"effectiveBalance",
"guaranteedBalance",
"id",
"keyHeight",
"nextLeasingHeightFrom",
"nextLeasingHeightTo",
"nextLessee",
"nextLesseeName",
"publicKey",
"publicName",
"unconfirmedBalance"
],
"properties": {
"id": {
"type": "string",
"description": "Numeric account id"
},
"keyHeight": {
"type": "integer",
"format": "int32",
"description": "Height at which the public key was registered"
},
"publicKey": {
"type": "string",
"description": "Account public key in HEX format"
},
"balance": {
"type": "string",
"description": "Account balance in HQT (1 HQT equals 0.00000001 HEAT)"
},
"unconfirmedBalance": {
"type": "string",
"description": "Unconfirmed account balance in HQT (1 HQT equals 0.00000001 HEAT)"
},
"effectiveBalance": {
"type": "string",
"description": "Effective account balance in HQT (1 HQT equals 0.00000001 HEAT)"
},
"guaranteedBalance": {
"type": "string",
"description": "Guaranteed account balance in HQT (1 HQT equals 0.00000001 HEAT)"
},
"currentLessee": {
"type": "string",
"description": "Account id of the lessee"
},
"currentLesseeName": {
"type": "string",
"description": "Public name of the current lessee"
},
"currentLeasingHeightFrom": {
"type": "integer",
"format": "int32",
"description": "Block height when the lease starts"
},
"currentLeasingHeightTo": {
"type": "integer",
"format": "int32",
"description": "Block height when the lease ends"
},
"nextLessee": {
"type": "string",
"description": "Account id of the next lessee"
},
"nextLesseeName": {
"type": "string",
"description": "Public name of the next lessee"
},
"nextLeasingHeightFrom": {
"type": "integer",
"format": "int32",
"description": "Block height when the next lease starts"
},
"nextLeasingHeightTo": {
"type": "integer",
"format": "int32",
"description": "Block height when the next lease ends"
},
"lessors": {
"type": "array",
"description": "All current and future lessors",
"items": {
"$ref": "#/definitions/Lessor"
}
},
"publicName": {
"type": "string",
"description": "Account public name"
}
},
"description": "Account class",
"xml": {
"name": "Account"
}
},
"JSONRewardsInfo": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"accountName": {
"type": "string"
},
"effectiveBalance": {
"type": "string"
},
"totalRewards": {
"type": "string"
},
"lastBlockTimestamp": {
"type": "integer",
"format": "int32"
}
}
},
"Count": {
"type": "object",
"required": [
"count"
],
"properties": {
"count": {
"type": "integer",
"format": "int32",
"description": "The count value"
}
},
"description": "Generic Count class",
"xml": {
"name": "Count"
}
},
"JSONAssetCertification": {
"type": "object",
"required": [
"asset",
"certified",
"certifierAccount",
"name",
"symbol"
],
"properties": {
"asset": {
"type": "string",
"description": "Asset id"
},
"certified": {
"type": "boolean",
"description": "Certified status [true,false]",
"default": false
},
"symbol": {
"type": "string",
"description": "Certified asset assigned symbol"
},
"name": {
"type": "string",
"description": "Certified asset assigned name"
},
"certifierAccount": {
"type": "string",
"description": "Certifier account id"
}
}
},
"Success": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"description": "Success",
"default": false
}
},
"description": "Success",
"xml": {
"name": "Success"
}
},
"Mining": {
"type": "object",
"properties": {
"deadline": {
"type": "integer",
"format": "int64",
"description": "The estimated time (in seconds since the last block) until the account will mine a block (startMining and getMining only)"
},
"hitTime": {
"type": "integer",
"format": "int32",
"description": "The estimated time (in seconds since 24 november 2013 00:00 UTC) when the account will mine a block (startMining and getMining only)"
},
"remaining": {
"type": "integer",
"format": "int32",
"description": "The deadline less the elapsed time since the last block (getInfo only)"
},
"foundAndStopped": {
"type": "boolean",
"description": "Is true if mining was stopped, false if mining was already stopped (stopMining only)",
"default": false
},
"account": {
"type": "string",
"description": "The account number (getInfo only)"
},
"stopped": {
"type": "integer",
"format": "int32",
"description": "Total number of stopped miners (stopMining only)"
}
},
"description": "Mining class",
"xml": {
"name": "Mining"
}
},
"Trade": {
"type": "object",
"required": [
"askOrder",
"askOrderHeight",
"asset",
"bidOrder",
"bidOrderHeight",
"block",
"buyer",
"currency",
"height",
"isBuy",
"price",
"quantity",
"seller",
"timestamp"
],
"properties": {
"block": {
"type": "string",
"description": "The ID of the block that contains the trade (0 for unconfirmed trades)"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The height of the block that contains the trade (0 for unconfirmed trades)"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The trade timestamp (in seconds since 24 november 2013 00:00 UTC)"
},
"currency": {
"type": "string",
"description": "The currency ID"
},
"asset": {
"type": "string",
"description": "The asset ID"
},
"askOrder": {
"type": "string",
"description": "The ask order ID"
},
"bidOrder": {
"type": "string",
"description": "The bid order ID"
},
"askOrderHeight": {
"type": "integer",
"format": "int32",
"description": "The ask order height (0 for unconfirmed orders)"
},
"bidOrderHeight": {
"type": "integer",
"format": "int32",
"description": "The bid order height (0 for unconfirmed orders)"
},
"seller": {
"type": "string",
"description": "Numeric ID of the seller account"
},
"sellerName": {
"type": "string",
"description": "Public name for seller account"
},
"buyer": {
"type": "string",
"description": "Numeric ID of the buyer account"
},
"buyerName": {
"type": "string",
"description": "Public name for buyer account"
},
"quantity": {
"type": "string",
"description": "The trade quantity (in QNT)"
},
"price": {
"type": "string",
"description": "The trade price (in QNT in case currency is an asset, in HQT in case currency is HEAT) (1 HQT equals 0.00000001 HEAT) "
},
"isBuy": {
"type": "boolean",
"description": "Wheter this is a BUY trade (false in case of a SELL trade)",
"default": false
},
"currencyProperties": {
"type": "string",
"description": "Currency properties based on protocol and account id (blank for all but 'list account trades')"
},
"assetProperties": {
"type": "string",
"description": "Asset properties based on protocol and account id (blank for all but 'list account trades')"
}
},
"description": "Trade class",
"xml": {
"name": "Trade"
}
},
"BlockMin": {
"type": "object",
"required": [
"block",
"blockSignature",
"height",
"numberOfTransactions",
"timestamp"
],
"properties": {
"numberOfTransactions": {
"type": "integer",
"format": "int32",
"description": "The number of transactions in the block"
},
"blockSignature": {
"type": "string",
"description": "The 64-byte block signature (as HEX string)"
},
"block": {
"type": "string",
"description": "The block ID"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The zero-based block height"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The timestamp (in seconds since 24 november 2013 00:00 UTC) of the block"
}
},
"description": "Minimal Block class",
"xml": {
"name": "BlockMin"
}
},
"TransactionExtended": {
"type": "object",
"required": [
"amount",
"attachment",
"deadline",
"ecBlockHeight",
"ecBlockId",
"fee",
"fullHash",
"height",
"messageBytes",
"messageIsEncrypted",
"messageIsEncryptedToSelf",
"messageIsText",
"recipient",
"recipientPublicKey",
"recipientPublicName",
"sender",
"senderPublicKey",
"senderPublicName",
"signature",
"signatureHash",
"subtype",
"timestamp",
"transaction",
"type",
"version"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"description": "The transaction type"
},
"subtype": {
"type": "integer",
"format": "int32",
"description": "The transaction subtype"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The time (in seconds since 24 november 2013 00:00 UTC) of the transaction"
},
"deadline": {
"type": "integer",
"format": "int32",
"description": "The deadline (in minutes) for the transaction to be confirmed"
},
"senderPublicKey": {
"type": "string",
"description": "The public key of the sending account for the transaction"
},
"recipient": {
"type": "string",
"description": "The account number of the recipient, if applicable"
},
"recipientPublicKey": {
"type": "string",
"description": "Recipient public key as HEX string"
},
"amount": {
"type": "string",
"description": "The amount in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"fee": {
"type": "string",
"description": "The fee in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"signature": {
"type": "string",
"description": "The digital signature of the transaction"
},
"signatureHash": {
"type": "string",
"description": "A SHA-256 hash of the transaction signature"
},
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The ID of the newly created transaction"
},
"attachment": {
"type": "object",
"description": "An object containing any additional data needed for the transaction, if applicable",
"additionalProperties": {
"type": "object"
}
},
"sender": {
"type": "string",
"description": "The account ID of the sender"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The height of the block in the blockchain"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The transaction version number"
},
"ecBlockId": {
"type": "string",
"description": "The economic clustering block ID"
},
"ecBlockHeight": {
"type": "integer",
"format": "int32",
"description": "The economic clustering block height"
},
"messageBytes": {
"type": "string",
"description": "The message bytes as HEX if any"
},
"messageIsText": {
"type": "boolean",
"description": "In case the message is a text message (binary otherwise)",
"default": false
},
"messageIsEncrypted": {
"type": "boolean",
"description": "Message is encrypted",
"default": false
},
"messageIsEncryptedToSelf": {
"type": "boolean",
"description": "Message is encrypted to self",
"default": false
},
"senderPublicName": {
"type": "string",
"description": "Sender public name"
},
"recipientPublicName": {
"type": "string",
"description": "Recipient public name"
}
},
"description": "Transaction Extended class",
"xml": {
"name": "TransactionExtended"
}
},
"EncryptedData": {
"type": "object",
"required": [
"data",
"nonce"
],
"properties": {
"data": {
"type": "string",
"description": "Encrypted data encoded as HEX"
},
"nonce": {
"type": "string",
"description": "Nonce"
}
},
"description": "EncryptedData class",
"xml": {
"name": "EncryptedData"
}
},
"DepositMethod": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"destination": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"disabled": {
"type": "boolean",
"default": false
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"currency": {
"type": "integer",
"format": "int64"
},
"notes": {
"type": "string"
}
},
"description": "Deposit method",
"xml": {
"name": "DepositMethod"
}
},
"KeyStoreBundle": {
"type": "object",
"required": [
"account",
"key",
"transaction",
"value"
],
"properties": {
"account": {
"type": "string",
"description": "Account scope"
},
"key": {
"type": "string",
"description": "The key that identifies this entry"
},
"value": {
"type": "string",
"description": "The entry value"
},
"transaction": {
"type": "string",
"description": "Transaction id for transaction that last set this entry"
}
},
"description": "Generic KeyStoreBundle class",
"xml": {
"name": "KeyStoreBundle"
}
},
"Order": {
"type": "object",
"required": [
"account",
"asset",
"cancelled",
"currency",
"currentlyNotValid",
"expiration",
"height",
"order",
"price",
"quantity",
"transactionIndex",
"type",
"unconfirmed",
"unconfirmedQuantity"
],
"properties": {
"order": {
"type": "string",
"description": "The ID of the order"
},
"currency": {
"type": "string",
"description": "The ID of the currency with which we are paying (BID order) or which we will be receiving (ASK order)"
},
"asset": {
"type": "string",
"description": "The ID of the asset being bought or sold"
},
"account": {
"type": "string",
"description": "The account number associated with the order"
},
"accountName": {
"type": "string",
"description": "The account name associated with the order"
},
"quantity": {
"type": "string",
"description": "The order quantity (in QNT)"
},
"unconfirmedQuantity": {
"type": "string",
"description": "the unconfirmed order quantity (in QNT)"
},
"price": {
"type": "string",
"description": "The order price (given in currency units, could be either HQT if currency is HEAT or QNT if currency is an asset)"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The block height of the order transaction"
},
"transactionIndex": {
"type": "integer",
"format": "int32",
"description": "A zero-based index giving the order of the transaction in its block"
},
"type": {
"type": "string",
"description": "Order type, either `ask` or `bid`",
"enum": [
"ask",
"bid"
]
},
"cancelled": {
"type": "boolean",
"description": "Indicates an unconfirmed cancellation is pending",
"default": false
},
"unconfirmed": {
"type": "boolean",
"description": "This is an unconfirmed or pending order",
"default": false
},
"expiration": {
"type": "integer",
"format": "int32",
"description": "The expiration time (in seconds since 24 november 2013 00:00 UTC)"
},
"currentlyNotValid": {
"type": "boolean",
"description": "Order is currently not valid, but might become valid in the future",
"default": false
}
},
"description": "Order class",
"xml": {
"name": "Order"
}
},
"Deposit": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"sender": {
"type": "string"
},
"destination": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"account": {
"type": "integer",
"format": "int64"
},
"amount": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "integer",
"format": "int64"
},
"depositMethod": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "integer",
"format": "int32"
},
"ref": {
"type": "string"
},
"notes": {
"type": "string"
},
"userName": {
"type": "string"
},
"userEmail": {
"type": "string"
}
},
"description": "Deposit",
"xml": {
"name": "Deposit"
}
},
"ChartData": {
"type": "object",
"required": [
"asset",
"currency",
"data",
"timestamp",
"window"
],
"properties": {
"currency": {
"type": "string",
"description": "Currency id"
},
"asset": {
"type": "string",
"description": "Asset id"
},
"window": {
"type": "integer",
"format": "int32",
"description": "Window interval in seconds"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The genetation timestamp (in seconds since 24 november 2013 00:00 UTC)"
},
"data": {
"type": "array",
"description": "Array of chartdata entries, each entry is an array",
"items": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": "Generic ChardData class",
"xml": {
"name": "ChartData"
}
},
"DecryptedData": {
"type": "object",
"required": [
"isText",
"message"
],
"properties": {
"message": {
"type": "string",
"description": "Unencrypted data as either UTF-8 text or encoded as HEX (since binary)"
},
"isText": {
"type": "boolean",
"description": "Indicates if message holds UTF-8 or HEX encoded binary data",
"default": false
}
},
"description": "DecryptedData class",
"xml": {
"name": "DecryptedData"
}
},
"TransactionUnconfirmed": {
"type": "object",
"required": [
"amount",
"attachment",
"deadline",
"ecBlockHeight",
"ecBlockId",
"fee",
"fullHash",
"height",
"messageBytes",
"messageIsEncrypted",
"messageIsEncryptedToSelf",
"messageIsText",
"recipient",
"recipientPublicKey",
"sender",
"senderPublicKey",
"signature",
"signatureHash",
"subtype",
"timestamp",
"transaction",
"type",
"version"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"description": "The transaction type"
},
"subtype": {
"type": "integer",
"format": "int32",
"description": "The transaction subtype"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The time (in seconds since 24 november 2013 00:00 UTC) of the transaction"
},
"deadline": {
"type": "integer",
"format": "int32",
"description": "The deadline (in minutes) for the transaction to be confirmed"
},
"senderPublicKey": {
"type": "string",
"description": "The public key of the sending account for the transaction"
},
"recipient": {
"type": "string",
"description": "The account number of the recipient, if applicable"
},
"recipientPublicKey": {
"type": "string",
"description": "Recipient public key as HEX string"
},
"amount": {
"type": "string",
"description": "The amount in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"fee": {
"type": "string",
"description": "The fee in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"signature": {
"type": "string",
"description": "The digital signature of the transaction"
},
"signatureHash": {
"type": "string",
"description": "A SHA-256 hash of the transaction signature"
},
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The ID of the newly created transaction"
},
"attachment": {
"type": "object",
"description": "An object containing any additional data needed for the transaction, if applicable",
"additionalProperties": {
"type": "object"
}
},
"sender": {
"type": "string",
"description": "The account ID of the sender"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The height of the block in the blockchain"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The transaction version number"
},
"ecBlockId": {
"type": "string",
"description": "The economic clustering block ID"
},
"ecBlockHeight": {
"type": "integer",
"format": "int32",
"description": "The economic clustering block height"
},
"messageBytes": {
"type": "string",
"description": "The message bytes as HEX if any"
},
"messageIsText": {
"type": "boolean",
"description": "In case the message is a text message (binary otherwise)",
"default": false
},
"messageIsEncrypted": {
"type": "boolean",
"description": "Message is encrypted",
"default": false
},
"messageIsEncryptedToSelf": {
"type": "boolean",
"description": "Message is encrypted to self",
"default": false
}
},
"description": "Unconfirmed Transaction class",
"xml": {
"name": "TransactionUnconfirmed"
}
},
"Hallmark": {
"type": "object",
"required": [
"account",
"date",
"host",
"valid",
"weight"
],
"properties": {
"valid": {
"type": "boolean",
"description": "True if host is less than 100 characters, weight > 0 and the embedded signature is verified",
"default": false
},
"weight": {
"type": "integer",
"format": "int32",
"description": "The weight assigned to the hallmark"
},
"host": {
"type": "string",
"description": "The IP address or domain name associated with the hallmark"
},
"account": {
"type": "string",
"description": "The account number associated with the hallmark"
},
"date": {
"type": "string",
"description": "The date the hallmark was created, in YYYY-MM-DD format"
}
},
"description": "Hallmark class",
"xml": {
"name": "Hallmark"
}
},
"Peer": {
"type": "object",
"required": [
"address",
"announcedAddress",
"application",
"blacklisted",
"blacklistingCause",
"blockchainHeight",
"downloadedVolume",
"lastUpdated",
"platform",
"shareAddress",
"state",
"uploadedVolume",
"version",
"weight"
],
"properties": {
"hallmark": {
"type": "string",
"description": "Hex string of the peer's hallmark, if it is defined"
},
"downloadedVolume": {
"type": "integer",
"format": "int64",
"description": "Number of bytes downloaded by the peer"
},
"address": {
"type": "string",
"description": "IP address or DNS name of the peer"
},
"weight": {
"type": "integer",
"format": "int32",
"description": "Peer's weight value"
},
"uploadedVolume": {
"type": "integer",
"format": "int64",
"description": "Number of bytes uploaded by the peer"
},
"version": {
"type": "string",
"description": "Version of the software running on the peer"
},
"platform": {
"type": "string",
"description": "String representing the peer's platform"
},
"lastUpdated": {
"type": "integer",
"format": "int32",
"description": "timestamp (in seconds since the genesis block) of the last peer status update"
},
"blacklisted": {
"type": "boolean",
"description": "True if the peer is blacklisted",
"default": false
},
"blacklistingCause": {
"type": "string",
"description": "The cause of blacklisting (if blacklisted is true)"
},
"announcedAddress": {
"type": "string",
"description": "The name that the peer announced to the network (could be a DNS name, IP address, or any other string)"
},
"application": {
"type": "string",
"description": "The name of the software application"
},
"state": {
"type": "integer",
"format": "int32",
"description": "The state of the peer: 0 for NON_CONNECTED, 1 for CONNECTED, or 2 for DISCONNECTED"
},
"shareAddress": {
"type": "boolean",
"description": "True if the address is allowed to be shared with other peers",
"default": false
},
"blockchainHeight": {
"type": "integer",
"format": "int32",
"description": "Last known blockchain height"
}
},
"description": "Peer class",
"xml": {
"name": "Peer"
}
},
"AssetProperties": {
"type": "object",
"required": [
"account",
"accountPublicName",
"asset",
"decimals",
"descriptionHash",
"descriptionUrl",
"dillutable",
"properties",
"propertiesAccount",
"propertiesProtocol",
"quantityQNT",
"timestamp"
],
"properties": {
"account": {
"type": "string",
"description": "The number of the account that issued the asset"
},
"accountPublicName": {
"type": "string",
"description": "The account public name that issued the asset"
},
"asset": {
"type": "string",
"description": "The asset ID"
},
"quantityQNT": {
"type": "string",
"description": "The total asset quantity (in QNT) in existence"
},
"decimals": {
"type": "string",
"format": "byte",
"description": "The number of decimal places used by the asset"
},
"descriptionUrl": {
"type": "string",
"description": "HTTP/HTTPS url pointing to the asset description file"
},
"descriptionHash": {
"type": "string",
"description": "SHA256 hash of description document contents as UTF-8 (hash is HEX string)"
},
"dillutable": {
"type": "boolean",
"description": "True in case new assets can later be issued by the asset issuer ",
"default": false
},
"propertiesAccount": {
"type": "string",
"description": "Asset properties account"
},
"propertiesProtocol": {
"type": "integer",
"format": "int32",
"description": "Asset properties protocol"
},
"properties": {
"type": "string",
"description": "Asset properties based on protocol and account id"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "Asset properties timestamp"
}
},
"description": "AssetProperties class",
"xml": {
"name": "AssetProperties"
}
},
"Lessor": {
"type": "object",
"required": [
"effectiveBalance",
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Numeric account id"
},
"currentLessee": {
"type": "string",
"description": "Account id of the lessee"
},
"currentHeightFrom": {
"type": "integer",
"format": "int32",
"description": "Block height when the lease starts,"
},
"currentHeightTo": {
"type": "integer",
"format": "int32",
"description": "Block height when the lease completes"
},
"nextLessee": {
"type": "string",
"description": "Account id of the next lessee"
},
"nextHeightFrom": {
"type": "integer",
"format": "int32",
"description": "Block height when the next lease starts"
},
"nextHeightTo": {
"type": "integer",
"format": "int32",
"description": "Block height when the next lease completes"
},
"effectiveBalance": {
"type": "string",
"description": "Effective account balance in HQT (1 HQT equals 0.00000001 HEAT)"
}
},
"description": "Lessor class",
"xml": {
"name": "Lessor"
}
},
"MessageContact": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"privateName": {
"type": "string"
},
"publicName": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
}
},
"description": "Generic MessageContact class",
"xml": {
"name": "MessageContact"
}
},
"TransactionCreate": {
"type": "object",
"required": [
"broadcasted",
"transactionJSON",
"unsignedTransactionBytes"
],
"properties": {
"signatureHash": {
"type": "string",
"description": "SHA-256 hash of the transaction signature (only when secretPhrase sent to server)"
},
"transaction": {
"type": "string",
"description": "The ID of the newly created transaction (only when secretPhrase sent to server)"
},
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction (only when secretPhrase sent to server)"
},
"transactionBytes": {
"type": "string",
"description": "The signed transaction bytes (only when secretPhrase sent to server)"
},
"broadcasted": {
"type": "boolean",
"description": "True if the transaction was broadcast, false otherwise",
"default": false
},
"transactionJSON": {
"description": "A transaction object",
"$ref": "#/definitions/Transaction"
},
"unsignedTransactionBytes": {
"type": "string",
"description": "The unsigned transaction bytes as HEX string"
}
},
"description": "Create transaction response",
"xml": {
"name": "TransactionCreate"
}
},
"HallmarkResponse": {
"type": "object",
"required": [
"hallmark"
],
"properties": {
"hallmark": {
"type": "string",
"description": "The hallmark hex string"
}
},
"description": "Hallmark class",
"xml": {
"name": "HallmarkResponse"
}
},
"Market": {
"type": "object",
"required": [
"askOrderTotal",
"asset",
"bidOrderTotal",
"currency",
"hr24AssetVolume",
"hr24Change",
"hr24CurrencyVolume",
"hr24High",
"hr24Low",
"lastPrice"
],
"properties": {
"currency": {
"type": "string",
"description": "Currency id"
},
"asset": {
"type": "string",
"description": "Asset id"
},
"lastPrice": {
"type": "string",
"description": "Last price"
},
"hr24Change": {
"type": "string",
"description": "24 hour change percentage (double)"
},
"hr24High": {
"type": "string",
"description": "24 hour high"
},
"hr24Low": {
"type": "string",
"description": "24 hour low"
},
"hr24CurrencyVolume": {
"type": "string",
"description": "24 hour currency volume"
},
"hr24AssetVolume": {
"type": "string",
"description": "24 hour asset volume"
},
"askOrderTotal": {
"type": "string",
"description": "Total amount of all ask orders"
},
"bidOrderTotal": {
"type": "string",
"description": "Total amount of all bid orders"
},
"currencyProperties": {
"type": "string",
"description": "Currency properties based on protocol and account id"
},
"assetProperties": {
"type": "string",
"description": "Asset properties based on protocol and account id"
},
"currencyDecimals": {
"type": "integer",
"format": "int32",
"description": "Currency decimals"
},
"assetDecimals": {
"type": "integer",
"format": "int32",
"description": "Asset decimals"
}
},
"description": "Generic Market class",
"xml": {
"name": "Market"
}
},
"PeerStateIndicator": {
"type": "object",
"properties": {
"timestamp": {
"type": "integer",
"format": "int64",
"description": "Timestamp"
},
"connected": {
"type": "integer",
"format": "int32",
"description": "Connected count"
},
"blacklisted": {
"type": "integer",
"format": "int32",
"description": "Blacklisted count"
},
"nonConnected": {
"type": "integer",
"format": "int32",
"description": "Non connected count"
},
"disconnected": {
"type": "integer",
"format": "int32",
"description": "Disconnected count"
},
"all": {
"type": "integer",
"format": "int32",
"description": "Number of all peers"
}
},
"description": "Peer state indicator",
"xml": {
"name": "PeerStateIndicator"
}
},
"Payment": {
"type": "object",
"required": [
"currency"
],
"properties": {
"transaction": {
"type": "string"
},
"currency": {
"type": "string",
"description": "Currency id, currency 0 is HEAT all others are assets"
},
"quantity": {
"type": "string"
},
"sender": {
"type": "string"
},
"recipient": {
"type": "string"
},
"senderPrivateName": {
"type": "string"
},
"recipientPrivateName": {
"type": "string"
},
"senderPublicName": {
"type": "string"
},
"recipientPublicName": {
"type": "string"
},
"senderPublicKey": {
"type": "string"
},
"recipientPublicKey": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"blockId": {
"type": "string"
},
"messageBytes": {
"type": "string"
},
"messageIsText": {
"type": "boolean",
"default": false
},
"messageIsEncrypted": {
"type": "boolean",
"default": false
},
"messageIsEncryptedToSelf": {
"type": "boolean",
"default": false
}
},
"description": "Generic Payment class",
"xml": {
"name": "Payment"
}
},
"Transaction": {
"type": "object",
"required": [
"amount",
"attachment",
"block",
"blockTimestamp",
"confirmations",
"deadline",
"ecBlockHeight",
"ecBlockId",
"fee",
"fullHash",
"height",
"messageBytes",
"messageIsEncrypted",
"messageIsEncryptedToSelf",
"messageIsText",
"recipient",
"recipientPublicKey",
"sender",
"senderPublicKey",
"signature",
"signatureHash",
"subtype",
"timestamp",
"transaction",
"transactionIndex",
"type",
"version"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"description": "The transaction type"
},
"subtype": {
"type": "integer",
"format": "int32",
"description": "The transaction subtype"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The time (in seconds since 24 november 2013 00:00 UTC) of the transaction"
},
"deadline": {
"type": "integer",
"format": "int32",
"description": "The deadline (in minutes) for the transaction to be confirmed"
},
"senderPublicKey": {
"type": "string",
"description": "The public key of the sending account for the transaction"
},
"recipient": {
"type": "string",
"description": "The account number of the recipient, if applicable"
},
"recipientPublicKey": {
"type": "string",
"description": "Recipient public key as HEX string"
},
"amount": {
"type": "string",
"description": "The amount in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"fee": {
"type": "string",
"description": "The fee in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"signature": {
"type": "string",
"description": "The digital signature of the transaction"
},
"signatureHash": {
"type": "string",
"description": "A SHA-256 hash of the transaction signature"
},
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The ID of the newly created transaction"
},
"attachment": {
"type": "object",
"description": "An object containing any additional data needed for the transaction, if applicable",
"additionalProperties": {
"type": "object"
}
},
"sender": {
"type": "string",
"description": "The account ID of the sender"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The height of the block in the blockchain"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The transaction version number"
},
"ecBlockId": {
"type": "string",
"description": "The economic clustering block ID"
},
"ecBlockHeight": {
"type": "integer",
"format": "int32",
"description": "The economic clustering block height"
},
"messageBytes": {
"type": "string",
"description": "The message bytes as HEX if any"
},
"messageIsText": {
"type": "boolean",
"description": "In case the message is a text message (binary otherwise)",
"default": false
},
"messageIsEncrypted": {
"type": "boolean",
"description": "Message is encrypted",
"default": false
},
"messageIsEncryptedToSelf": {
"type": "boolean",
"description": "Message is encrypted to self",
"default": false
},
"transactionIndex": {
"type": "integer",
"format": "int32",
"description": "A zero-based index giving the order of the transaction in its block"
},
"confirmations": {
"type": "integer",
"format": "int32",
"description": "Number of transaction confirmations"
},
"block": {
"type": "string",
"description": "The ID of the block containing the transaction"
},
"blockTimestamp": {
"type": "integer",
"format": "int32",
"description": "The timestamp (in seconds since 24 november 2013 00:00 UTC) of the block"
}
},
"description": "Transaction class",
"xml": {
"name": "Transaction"
}
},
"State": {
"type": "object",
"properties": {
"isScanning": {
"type": "boolean",
"description": "True if this node is scanning the blockchain, false otherwise",
"default": false
},
"cumulativeDifficulty": {
"type": "string",
"description": "The current cumulative miner difficulty"
},
"numberOfBlocks": {
"type": "integer",
"format": "int32",
"description": "The number of blocks (height + 1) in the blockchain"
},
"numberOfTransactions": {
"type": "integer",
"format": "int32",
"description": "The number of transactions in the blockchain"
},
"numberOfUnconfirmedTransactions": {
"type": "integer",
"format": "int32",
"description": "The number of unconfirmed transactions"
},
"version": {
"type": "string",
"description": "The software version on this node"
},
"lastBlock": {
"type": "string",
"description": "The last block numeric id"
},
"lastBlockTimestamp": {
"type": "integer",
"format": "int32",
"description": "Timestamp of the last block"
},
"application": {
"type": "string",
"description": "The name of the software running on this node"
},
"lastBlockchainFeederHeight": {
"type": "integer",
"format": "int32",
"description": "The height of the last blockchain feeder"
},
"time": {
"type": "integer",
"format": "int32",
"description": "The current node time (in seconds since 24 november 2013 00:00 UTC)"
},
"lastBlockchainFeeder": {
"type": "string",
"description": "The announced name of the feeder of the last blockchain"
},
"initialCoinSupply": {
"type": "string",
"description": "Amount of HEAT in genesis block (in HQT, 1 HQT is 0.00000001 HEAT)"
},
"currentCoinSupply": {
"type": "string",
"description": "Current total amount of HEAT (in HQT, 1 HQT is 0.00000001 HEAT)"
},
"numberOfPeers": {
"type": "integer",
"format": "int32",
"description": "The number of known peers on the network"
},
"numberOfUnlockedAccounts": {
"type": "integer",
"format": "int32",
"description": "The number of unlocked accounts on this node"
},
"maxMemory": {
"type": "integer",
"format": "int64",
"description": "The maximum amount of memory the node may use (in Bytes)"
},
"freeMemory": {
"type": "integer",
"format": "int64",
"description": "The amount of free memory on this node (in Bytes)"
},
"peerPort": {
"type": "integer",
"format": "int32",
"description": "The port used for connecting to peers"
},
"availableProcessors": {
"type": "integer",
"format": "int32",
"description": "The number of processors on this node"
},
"numberOfAccounts": {
"type": "integer",
"format": "int32",
"description": "The number of accounts in the blockchain"
},
"needsAdminPassword": {
"type": "boolean",
"description": "True if the heat.disableAdminPassword property is false",
"default": false
},
"totalMemory": {
"type": "integer",
"format": "int64",
"description": "The amount of memory this node is using (in Bytes)"
},
"isOffline": {
"type": "boolean",
"description": "True if this node is connected to other peers, false otherwise",
"default": false
}
},
"description": "State class",
"xml": {
"name": "State"
}
},
"PeerRejection": {
"type": "object",
"properties": {
"timestamp": {
"type": "integer",
"format": "int64",
"description": "Timestamp"
},
"peer": {
"type": "integer",
"format": "int32",
"description": "Peer"
},
"heightDelta": {
"type": "integer",
"format": "int32",
"description": "Delta between peers's height and local height"
},
"commonBlockHeightDelta": {
"type": "integer",
"format": "int32",
"description": "Non connected count"
},
"commonBlockId": {
"type": "integer",
"format": "int32",
"description": "Common block id"
},
"commonMilestoneBlockId": {
"type": "integer",
"format": "int32",
"description": "Common milestone block id"
},
"peerHasMoreBlocks": {
"type": "integer",
"format": "int32",
"description": "Is peer has more blocks"
},
"cumulativeDifficultyRatio": {
"type": "integer",
"format": "int32",
"description": "Cumulative difficulty ratio (peer's cumulative difficulty divided to local cumulative difficulty)"
}
},
"description": "Details why peer rejects the block. Here are the attributes by which the block is rejected.",
"xml": {
"name": "PeerStateIndicator"
}
},
"Value": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "Value"
}
},
"description": "Value class",
"xml": {
"name": "Value"
}
},
"Block": {
"type": "object",
"required": [
"baseTarget",
"block",
"blockSignature",
"cumulativeDifficulty",
"generationSignature",
"generator",
"generatorPublicKey",
"generatorPublicName",
"height",
"nextBlock",
"numberOfTransactions",
"payloadHash",
"payloadLength",
"popRewardHQT",
"posRewardHQT",
"previousBlock",
"previousBlockHash",
"timestamp",
"totalAmountHQT",
"totalFeeHQT",
"transactions",
"version"
],
"properties": {
"previousBlockHash": {
"type": "string",
"description": "The 32-byte hash of the previous block (as HEX string)"
},
"payloadLength": {
"type": "integer",
"format": "int32",
"description": "The length (in bytes) of all transactions included in the block"
},
"totalAmountHQT": {
"type": "string",
"description": "The total amount in HQT (1 HQT equals 0.00000001 HEAT) of the transactions in the block"
},
"generationSignature": {
"type": "string",
"description": "The 32-byte generation signature of the generating account"
},
"generator": {
"type": "string",
"description": "The generating account number"
},
"generatorPublicName": {
"type": "string",
"description": "The generator public name"
},
"generatorPublicKey": {
"type": "string",
"description": "The 32-byte public key of the generating account (as HEX string)"
},
"baseTarget": {
"type": "string",
"description": "The base target for the next block generation"
},
"payloadHash": {
"type": "string",
"description": "The 32-byte hash of the payload (all transactions as HEX string)"
},
"nextBlock": {
"type": "string",
"description": "The next block ID"
},
"numberOfTransactions": {
"type": "integer",
"format": "int32",
"description": "The number of transactions in the block"
},
"blockSignature": {
"type": "string",
"description": "The 64-byte block signature (as HEX string)"
},
"transactions": {
"type": "array",
"description": "An array of transaction IDs or transaction objects (if includeTransactions provided, refer to Get Transaction for details)",
"items": {
"$ref": "#/definitions/Transaction"
}
},
"version": {
"type": "integer",
"format": "int32",
"description": "The block version"
},
"totalFeeHQT": {
"type": "string",
"description": "The total fee in HQT (1 HQT equals 0.00000001 HEAT) of the transactions in the block"
},
"previousBlock": {
"type": "string",
"description": "The previous block ID"
},
"cumulativeDifficulty": {
"type": "string",
"description": "The cumulative difficulty for the next block generation"
},
"block": {
"type": "string",
"description": "The block ID"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The zero-based block height"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The timestamp (in seconds since 24 november 2013 00:00 UTC) of the block"
},
"popRewardHQT": {
"type": "string",
"description": "The total POP fee in HQT (1 HQT equals 0.00000001 HEAT)"
},
"posRewardHQT": {
"type": "string",
"description": "The total POS miner fee in HQT (1 HQT equals 0.00000001 HEAT)"
}
},
"description": "Block class",
"xml": {
"name": "Block"
}
},
"PeerTelemetry": {
"type": "object",
"properties": {
"peer": {
"type": "string",
"description": "Peer"
},
"time": {
"type": "integer",
"format": "int64",
"description": "Blockchain time of peer telemetry"
},
"height": {
"type": "integer",
"format": "int32",
"description": "Height of peer telemetry"
},
"balancesEquality": {
"type": "integer",
"format": "int32",
"description": "Balances equality to the peer: 0 - mismatch, 1 - equals, 2 - unknown"
},
"blockBalancesEquality": {
"type": "integer",
"format": "int32",
"description": "Block balances equality to the peer: 0 - mismatch, 1 - equals, 2 - unknown"
}
},
"description": "Peer telemetry",
"xml": {
"name": "PeerTelemetry"
}
},
"JSONAssetProtocol1": {
"type": "object",
"properties": {
"asset": {
"type": "string"
},
"decimals": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"Category": {
"type": "object",
"properties": {
"disabled": {
"type": "boolean",
"default": false
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"txFeeEUR": {
"type": "integer",
"format": "int64"
},
"minFeeEUR": {
"type": "integer",
"format": "int64"
},
"unloadFeeEUR": {
"type": "integer",
"format": "int64"
},
"icon": {
"type": "string"
},
"notes": {
"type": "string"
}
},
"description": "Category",
"xml": {
"name": "Category"
}
},
"User": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"socialId": {
"type": "string"
},
"iban": {
"type": "string"
},
"notes": {
"type": "string"
},
"category": {
"$ref": "#/definitions/Category"
},
"eurBalance": {
"type": "string"
},
"placeOfBirth": {
"type": "string"
},
"dateOfBirth": {
"type": "string"
}
},
"description": "User",
"xml": {
"name": "User"
}
},
"Message": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"sender": {
"type": "integer",
"format": "int64"
},
"recipient": {
"type": "integer",
"format": "int64"
},
"senderEmail": {
"type": "string"
},
"recipientEmail": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "string"
},
"topic": {
"type": "string"
},
"threadId": {
"type": "integer",
"format": "int64"
},
"isRead": {
"type": "boolean",
"default": false
},
"isTrashed": {
"type": "boolean",
"default": false
},
"isReplied": {
"type": "boolean",
"default": false
}
},
"description": "Message",
"xml": {
"name": "Message"
}
},
"BundleResponse": {
"type": "object",
"required": [
"bundleId",
"status",
"success"
],
"properties": {
"bundleId": {
"type": "integer",
"format": "int32",
"description": "Bundle ID"
},
"success": {
"type": "boolean",
"description": "Success indicator, iff TRUE operation succeeded",
"default": false
},
"status": {
"type": "integer",
"format": "int32",
"description": "Response status, [1=success,2=filter failed,3=message null,4=exception]"
},
"error": {
"type": "string",
"description": "Optional error message"
}
},
"description": "BundleResponse",
"xml": {
"name": "BundleResponse"
}
},
"BlockCondensed": {
"type": "object",
"required": [
"block",
"generator",
"generatorPublicName",
"height",
"numberOfTransactions",
"popRewardHQT",
"posRewardHQT",
"timestamp",
"totalAmountHQT",
"totalFeeHQT",
"transactions"
],
"properties": {
"totalAmountHQT": {
"type": "string",
"description": "The total amount in HQT (1 HQT equals 0.00000001 HEAT) of the transactions in the block"
},
"generator": {
"type": "string",
"description": "The generating account number"
},
"generatorPublicName": {
"type": "string",
"description": "The generator public name"
},
"numberOfTransactions": {
"type": "integer",
"format": "int32",
"description": "The number of transactions in the block"
},
"totalFeeHQT": {
"type": "string",
"description": "The total fee in HQT (1 HQT equals 0.00000001 HEAT) of the transactions in the block"
},
"block": {
"type": "string",
"description": "The block ID"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The zero-based block height"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The timestamp (in seconds since 24 november 2013 00:00 UTC) of the block"
},
"posRewardHQT": {
"type": "string",
"description": "The total POS miner fee in HQT (1 HQT equals 0.00000001 HEAT)"
},
"popRewardHQT": {
"type": "string",
"description": "The total POP fee in HQT (1 HQT equals 0.00000001 HEAT)"
},
"transactions": {
"type": "array",
"description": "An array of transaction IDs or transaction objects (if includeTransactions provided, refer to Get Transaction for details)",
"items": {
"$ref": "#/definitions/Transaction"
}
}
},
"description": "BlockCondensed class",
"xml": {
"name": "BlockCondensed"
}
},
"JSONStake": {
"type": "object",
"properties": {
"generatorCount": {
"type": "integer",
"format": "int32"
},
"generatorStake": {
"type": "string"
},
"height": {
"type": "integer",
"format": "int32"
}
}
},
"SHA256Hash": {
"type": "object",
"required": [
"digest",
"isText",
"message"
],
"properties": {
"message": {
"type": "string",
"description": "The input data, could be either UTF-8 text or binary data encoded as HEX"
},
"isText": {
"type": "boolean",
"description": "Indicator if the the input is either text/utf-8 or binary data encoded as HEX",
"default": false
},
"digest": {
"type": "string",
"description": "The hash value encoded as HEX string"
}
},
"description": "SHA256Hash class",
"xml": {
"name": "SHA256Hash"
}
},
"AccountAsset": {
"type": "object",
"required": [
"account",
"asset",
"quantity",
"unconfirmedQuantity"
],
"properties": {
"account": {
"type": "string",
"description": "The account id"
},
"asset": {
"type": "string",
"description": "The asset id"
},
"quantity": {
"type": "string",
"description": "Confirmed balance"
},
"unconfirmedQuantity": {
"type": "string",
"description": "Unconfirmed balance"
}
},
"description": "AccountAsset class",
"xml": {
"name": "AccountAsset"
}
},
"SignResponse": {
"type": "object",
"required": [
"fullHash",
"signatureHash",
"transaction",
"transactionBytes",
"verify"
],
"properties": {
"signatureHash": {
"type": "string",
"description": "A SHA-256 hash of the transaction signature, used in escrow transactions"
},
"verify": {
"type": "boolean",
"description": "Is true if the signature is verified, false if not",
"default": false
},
"transactionBytes": {
"type": "string",
"description": "The signed transaction bytes"
},
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The transaction ID, derived from the fullHash"
}
},
"description": "Sign Response class",
"xml": {
"name": "SignResponse"
}
},
"Broadcast": {
"type": "object",
"required": [
"fullHash",
"transaction"
],
"properties": {
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The transaction ID"
}
},
"description": "Broadcast response",
"xml": {
"name": "Broadcast"
}
},
"AccountBalance": {
"type": "object",
"required": [
"asset",
"balance",
"unconfirmedBalance",
"virtualBalance"
],
"properties": {
"asset": {
"type": "string",
"description": "Asset ID, asset=0 is your HEAT balance all others are assets you own"
},
"balance": {
"type": "string",
"description": "Account balance in QNT (1 QNT equals 0.00000001)"
},
"unconfirmedBalance": {
"type": "string",
"description": "Unconfirmed balance in QNT (1 QNT equals 0.00000001)"
},
"virtualBalance": {
"type": "string",
"description": "Virtual balance in QNT (1 QNT equals 0.00000001)"
},
"properties": {
"type": "string",
"description": "Currency properties based on protocol and account id"
},
"decimals": {
"type": "integer",
"format": "int32",
"description": "Currency decimals"
}
},
"description": "AccountBalance class",
"xml": {
"name": "AccountBalance"
}
},
"Withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"account": {
"type": "integer",
"format": "int64"
},
"amount": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"format": "byte"
},
"receiver": {
"type": "string"
},
"destination": {
"type": "string"
},
"notes": {
"type": "string"
},
"type": {
"type": "string",
"format": "byte"
},
"speed": {
"type": "string",
"format": "byte"
},
"swift": {
"type": "string"
},
"conf": {
"type": "string"
},
"fee": {
"type": "integer",
"format": "int64"
},
"userName": {
"type": "string"
},
"userEmail": {
"type": "string"
}
},
"description": "Withdrawal",
"xml": {
"name": "JSONWithdrawal"
}
},
"Fees": {
"type": "object",
"properties": {
"arbitraryMessageFee": {
"type": "string"
},
"ordinaryPaymentFee": {
"type": "string"
},
"orderCancellationFee": {
"type": "string"
},
"orderPlacementFee": {
"type": "string"
},
"assetTransferFee": {
"type": "string"
}
},
"description": "Fees class",
"xml": {
"name": "Fees"
}
},
"Contact": {
"type": "object",
"properties": {
"account": {
"type": "integer",
"format": "int64"
},
"email": {
"type": "string"
}
},
"description": "Contact",
"xml": {
"name": "Contact"
}
},
"BroadcastBundleResponse": {
"type": "object",
"required": [
"bundles",
"fullHash",
"transaction"
],
"properties": {
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The transaction ID"
},
"bundles": {
"type": "array",
"description": "Bundle responses",
"items": {
"$ref": "#/definitions/BundleResponse"
}
}
},
"description": "BroadcastBundleResponse",
"xml": {
"name": "BroadcastBundleResponse"
}
},
"BlockchainStatus": {
"type": "object",
"properties": {
"isScanning": {
"type": "boolean",
"description": "True if this node is scanning the blockchain, false otherwise",
"default": false
},
"cumulativeDifficulty": {
"type": "string",
"description": "The current cumulative miner difficulty"
},
"numberOfBlocks": {
"type": "integer",
"format": "int32",
"description": "The number of blocks (height + 1) in the blockchain"
},
"numberOfTransactions": {
"type": "integer",
"format": "int32",
"description": "The number of transactions in the blockchain"
},
"numberOfUnconfirmedTransactions": {
"type": "integer",
"format": "int32",
"description": "The number of unconfirmed transactions"
},
"version": {
"type": "string",
"description": "The software version on this node"
},
"lastBlock": {
"type": "string",
"description": "The last block numeric id"
},
"lastBlockTimestamp": {
"type": "integer",
"format": "int32",
"description": "Timestamp of the last block"
},
"application": {
"type": "string",
"description": "The name of the software running on this node"
},
"lastBlockchainFeederHeight": {
"type": "integer",
"format": "int32",
"description": "The height of the last blockchain feeder"
},
"time": {
"type": "integer",
"format": "int32",
"description": "The current node time (in seconds since 24 november 2013 00:00 UTC)"
},
"lastBlockchainFeeder": {
"type": "string",
"description": "The announced name of the feeder of the last blockchain"
},
"initialCoinSupply": {
"type": "string",
"description": "Amount of HEAT in genesis block (in HQT, 1 HQT is 0.00000001 HEAT)"
},
"currentCoinSupply": {
"type": "string",
"description": "Current total amount of HEAT (in HQT, 1 HQT is 0.00000001 HEAT)"
}
},
"description": "Blockchain Status class",
"xml": {
"name": "BlockchainStatus"
}
},
"FullHash": {
"type": "object",
"required": [
"fullHash",
"transaction"
],
"properties": {
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The transaction ID"
}
},
"description": "FullHash class",
"xml": {
"name": "FullHash"
}
},
"MessageHeader": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"account": {
"type": "integer",
"format": "int64"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int32"
},
"topic": {
"type": "string"
},
"preview": {
"type": "string"
},
"read": {
"type": "boolean",
"default": false
},
"trashed": {
"type": "boolean",
"default": false
},
"starred": {
"type": "boolean",
"default": false
},
"count": {
"type": "integer",
"format": "int32"
}
},
"description": "MessageHeader",
"xml": {
"name": "MessageHeader"
}
},
"TransactionVerify": {
"type": "object",
"required": [
"amount",
"attachment",
"block",
"blockTimestamp",
"confirmations",
"deadline",
"ecBlockHeight",
"ecBlockId",
"fee",
"fullHash",
"height",
"messageBytes",
"messageIsEncrypted",
"messageIsEncryptedToSelf",
"messageIsText",
"recipient",
"recipientPublicKey",
"sender",
"senderPublicKey",
"signature",
"signatureHash",
"subtype",
"timestamp",
"transaction",
"transactionIndex",
"type",
"verify",
"version"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"description": "The transaction type"
},
"subtype": {
"type": "integer",
"format": "int32",
"description": "The transaction subtype"
},
"timestamp": {
"type": "integer",
"format": "int32",
"description": "The time (in seconds since 24 november 2013 00:00 UTC) of the transaction"
},
"deadline": {
"type": "integer",
"format": "int32",
"description": "The deadline (in minutes) for the transaction to be confirmed"
},
"senderPublicKey": {
"type": "string",
"description": "The public key of the sending account for the transaction"
},
"recipient": {
"type": "string",
"description": "The account number of the recipient, if applicable"
},
"recipientPublicKey": {
"type": "string",
"description": "Recipient public key as HEX string"
},
"amount": {
"type": "string",
"description": "The amount in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"fee": {
"type": "string",
"description": "The fee in HQT (1 HQT equals 0.00000001 HEAT) of the transaction"
},
"signature": {
"type": "string",
"description": "The digital signature of the transaction"
},
"signatureHash": {
"type": "string",
"description": "A SHA-256 hash of the transaction signature"
},
"fullHash": {
"type": "string",
"description": "The full hash of the signed transaction"
},
"transaction": {
"type": "string",
"description": "The ID of the newly created transaction"
},
"attachment": {
"type": "object",
"description": "An object containing any additional data needed for the transaction, if applicable",
"additionalProperties": {
"type": "object"
}
},
"sender": {
"type": "string",
"description": "The account ID of the sender"
},
"height": {
"type": "integer",
"format": "int32",
"description": "The height of the block in the blockchain"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The transaction version number"
},
"ecBlockId": {
"type": "string",
"description": "The economic clustering block ID"
},
"ecBlockHeight": {
"type": "integer",
"format": "int32",
"description": "The economic clustering block height"
},
"messageBytes": {
"type": "string",
"description": "The message bytes as HEX if any"
},
"messageIsText": {
"type": "boolean",
"description": "In case the message is a text message (binary otherwise)",
"default": false
},
"messageIsEncrypted": {
"type": "boolean",
"description": "Message is encrypted",
"default": false
},
"messageIsEncryptedToSelf": {
"type": "boolean",
"description": "Message is encrypted to self",
"default": false
},
"transactionIndex": {
"type": "integer",
"format": "int32",
"description": "A zero-based index giving the order of the transaction in its block"
},
"confirmations": {
"type": "integer",
"format": "int32",
"description": "Number of transaction confirmations"
},
"block": {
"type": "string",
"description": "The ID of the block containing the transaction"
},
"blockTimestamp": {
"type": "integer",
"format": "int32",
"description": "The timestamp (in seconds since 24 november 2013 00:00 UTC) of the block"
},
"verify": {
"type": "boolean",
"description": "Is true if the signature is verified, false otherwise",
"default": false
}
},
"description": "Transaction Verify class",
"xml": {
"name": "TransactionVerify"
}
}
},
"externalDocs": {
"description": "Privacy policy",
"url": "http://paytah.com/privacy-policy/"
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment