API URL endpoint: http(s)://127.0.0.1:port number/api/1.0
API allows creating services that directly interact with the ecosystem of Utopia. It significantly extends the capabilities of users and developers to implement the anonymous and secure solutions on the network.
See the list of available methods at the left side.
Access token
|
|
Turn on setWebSocketState first! Notificator Port: The protocol ws / wss matches the current page http / https protocol You can use whatever you need in your products |
Notifications |
This filter can be applied to ANY method returning an array, it's supported only then passing a
request via JSON POST, just specify an object with name 'filter' and following fields (all
optional): 'sortby', 'offset' and 'limit'.
Sortby format: propertyName1:sortingorder,propertyName2:sortingorder etc. (sortingorder is optional.)
| Sort by: | |
| Offset by: | |
| limitRows: |
Request- Response- |
Request
{
"method": "getProfileStatus",
"token": "TEMPTOKEN"
}
Response
{
"result": {
"mood": "",
"status": "Available",
"status_code": 4096
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "setProfileStatus",
"params": {
"status": "Available",
"mood": "Hi"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "4624"
}
}
| Status: | |
| Mood: |
Request
{
"method": "getReleaseNotes",
"params": {
},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"en": {
"versionNumber": {
"fixed": [...],
"issues": [...],
"new": [...],
"version": {
"OS - version"
}}},
},
"resultExtraInfo": {
"elapsed": "4624"
}
}
Request
{
"method": "getSettingInfo",
"params": {
"settingId": ""
},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"TrayIconMode":"Always",
"AutoStart": "true"
},
"resultExtraInfo": {
"elapsed": "4624"
}
}
| setting Id: |
Request
{
"method": "setSettingInfo",
"params": {
"settingId":"TrayIconMode",
"newValue":"Always"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "4624"
}
}
| setting Id: | |
| new value: |
Request
{
"method": "getBalance",
"params": {
"currency": "CRP"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 0,
"resultExtraInfo": {
"elapsed": "0"
}
}
| Currency: |
Request
{
"method": "getFinanceHistory",
"params": {
"currency": "CRP",
"filters": "",
"referenceNumber": "",
"fromDate": "",
"toDate": "",
"batchId": "",
"fromAmount": "",
"toAmount": "",
"sourcePk" : "",
"destinationPk" : ""
},
"token": "TEMPTOKEN"
}
| Filters: | |
| Reference Number: | |
| FromDate: | |
| ToDate: | |
| BatchId: | |
| FromAmount: | |
| ToAmount: | |
| SourcePk: | |
| DestinationPk: | |
| Currency: |
Request
{
"method": "getSystemInfo",
"token": "TEMPTOKEN"
}
Response
{
"result": {
"buildAbi": "x86_64-little_endian-llp64",
"buildCpuArchitecture": "x86_64",
"build_number": "0.3.9",
"currentCpuArchitecture": "x86_64",
"netCoreRate": 25,
"networkCores": 1,
"networkEnabled": true,
"numberOfConnections": 8,
"packetCacheSize": 301,
"uptime": "00:00:47"
},
"resultExtraInfo": {
"elapsed": "2603"
}
}
Request
{
"method": "ucodeEncode",
"params": {
"hex_code": "",
"size_image": "",
"coder": "BASE64",
"format": "JPG"
},
"token": "TEMPTOKEN"
}
| hex_code: | |
| size_image: | |
| Coder (BASE64/HEX): | |
| Format (JPG/PNG): |
Request
{
"method": "ucodeDecode",
"params": {
"base64_image": ""
},
"token": "TEMPTOKEN"
}
| base64_image: |
Request
{
"method": "getChannelAvatar",
"params": {
"channelid": "3436365645645645643456",
"coder": "BASE64",
"format": "JPG"
},
"token": "TEMPTOKEN"
}
Response
{
"result": "/9j/4AAQSkZJRgABAQGRolJicoKS.......CiiigAooooA//9k=",
"resultExtraInfo": {
"elapsed": "2"
}
}
| Channel ID: | |
| Coder (BASE64/HEX): | |
| Format (JPG/PNG): |
Request
{
"method": "setProfileData",
"params": {
"nick": "new nick",
"firstName": "Jack",
"lastName": "Black"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true
}
}
| Nick: | |
| First Name: | |
| Last Name: |
Request
{
"method":"getAvatarByKey",
"params": {
"pk":"CDEC99906E4F90799E4399592CC7C59E75BA0AC89FE7EB52C01A89F3F0C5F36A",
"coder":"BASE64",
"format":"JPG"
},
"token":"TEMPTOKEN"
}
Response
{
"result": "/9j/4AAQSkZJRgABAQGRolJicoKS.......CiiigAooooA//9k=",
"resultExtraInfo": {
"elapsed": "2"
}
}
| Public Key: | |
| Coder (BASE64/HEX): | |
| Format (JPG/PNG): |
Request
{
"method":"getContactAvatar",
"params": {
"pk":"CDEC99906E4F90799E4399592CC7C59E75BA0AC89FE7EB52C01A89F3F0C5F36A",
"coder":"BASE64",
"format":"JPG"
},
"token":"TEMPTOKEN"
}
Response
{
"result": "/9j/4AAQSkZJRgABAQGRolJicoKS.......CiiigAooooA//9k=",
"resultExtraInfo": {
"elapsed": "2"
}
}
| Public Key: | |
| Coder (BASE64/HEX): | |
| Format (JPG/PNG): |
Request
{
"method": "getContactGroups",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": [ ]
}
Request
{
"method": "getContactsByGroup",
"params": {
"groupName": "Freedom Society"
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
{
"authorizationStatus": 3,
"avatarMd5": "defAvatar_E0B48BF95ACD8D726D055B27B5324526B4B3A07845CCEE34B085673488525924",
"group": "",
"hashedPk": "AEEBB7A78850724A177E1E649E35A47B",
"isFriend": false,
"nick": "Utopia",
"pk": "E0B48BF95ACD8D726D055B27B5324526B4B3A07845CCEE34B085673488525924",
"status": 4096
}
}
| groupName: |
Request
{
"method": "getContacts",
"params": {
"filter": ""
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
{
"authorizationStatus": 3,
"avatarMd5": "defAvatar_E0B48BF95ACD8D726D055B27B5324526B4B3A07845CCEE34B085673488525924",
"group": "",
"hashedPk": "AEEBB7A78850724A177E1E649E35A47B",
"isFriend": false,
"nick": "Utopia",
"pk": "E0B48BF95ACD8D726D055B27B5324526B4B3A07845CCEE34B085673488525924",
"status": 4096
},
{
"authorizationStatus": 3,
"avatarMd5": "DA67E64C030A727C99B045B0854259B3",
"group": "Freedom Society",
"hashedPk": "2A1004A5361A6078DCA2A86077D460BA",
"isFriend": false,
"nick": "contact",
"pk": "7086C343338A5FF2BE11E94E9E0FCEE67E295A0094930AA8936B1F993A994116",
"status": 4096
}
}
| Filter: |
Request
{
"method": "getOwnContact",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"avatarMd5": "8AFDAB98B48A90F7D3B18AFF96F0852C",
"hashedPk": "809262B77E2EF657F04C7FA9822426D6",
"isFriend": false,
"nick": "contact",
"pk": "CFF4DB80DCA10BD2317D538FF790A03EDA26274768E5EB04E0FDA51989131F32",
"status": 4096
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "sendInstantMessage",
"params": {
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"text": "test"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 49863,
"resultExtraInfo": {
"elapsed": "21"
}
}
| To: | |
| Text: |
Request
{
"method": "sendInstantQuote",
"params": {
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"text": "test",
"id_message": "232"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 0,
"resultExtraInfo": {
"elapsed": "0"
}
}
| To: | |
| Text: | |
| Id message: |
Request
{
"method": "sendInstantSticker",
"params": {
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"collection": "434",
"name": "343"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 49864,
"resultExtraInfo": {
"elapsed": "11"
}
}
| To: | |
| Collection: | |
| Name: |
Request
{
"method": "pinInstantMessage",
"params": {
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"messageId": "123",
"pin": true
},
"token": "TEMPTOKEN"
}
Response
{
"result": 0,
"resultExtraInfo": {
"elapsed": "0"
}
}
| To: | |
| Message Id: | |
| Pin (true for pin or false for unpin): |
Request
{
"method": "getPinnedMessages",
"params": {
"pk": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 0,
"resultExtraInfo": {
"elapsed": "0"
}
}
| Pk: |
Request
{
"method": "bookmarkInstantMessage",
"params": {
"messageId": 11,
"comments": "test"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 0,
"resultExtraInfo": {
"elapsed": "0"
}
}
| Message Id: | |
| Comments: |
Request
{
"method": "getStickerCollections",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": [
"Default Stickers"
],
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "getStickerNamesByCollection",
"params": {
"collection_name": "Default Stickers"
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
"airstrike",
"rich",
"sick",
"hide",
"fries",
"knife",
"airship",
"gift"
],
"resultExtraInfo": {
"elapsed": "1"
}
}
| collection_name: |
Request
{
"method": "getImageSticker",
"params": {
"collection_name": "test",
"sticker_name": "test",
"coder": "1"
},
"token": "TEMPTOKEN"
}
| collection_name: | |
| sticker_name: | |
| coder: |
Request
{
"method": "sendInstantBuzz",
"params": {
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"comments": "test"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 49866,
"resultExtraInfo": {
"elapsed": "8"
}
}
| To: | |
| Comments: |
Request
{
"method": "sendInstantInvitation",
"params": {
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"channelid": "123",
"description": "123",
"comments": "123"
},
"token": "TEMPTOKEN"
}
| To: | |
| Channel Id: | |
| Description: | |
| Comments: |
Request
{
"method": "removeInstantMessages",
"params": {
"hex_contact_public_key": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F"
},
"token": "TEMPTOKEN"
}
| public key: |
Request
{
"method": "sendEmailMessage",
"params": {
"to": ["9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F", "nick_of_friend"],
"subject": "test",
"body": "test",
"attachmentFileId": ""
},
"token": "TEMPTOKEN"
}
| To: (list of recipients from public key or nick name ) | |
| Subject: | |
| Body: | |
| attachment fileId: |
Request
{
"method": "getContactMessages",
"params": {
"pk": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F"
},
"token": "TEMPTOKEN"
}
| Public Key: |
Request
{
"method": "requestNewPublicKeyPaymentAlias",
"params": { },
"token": "TEMPTOKEN"
}
Request
{
"method": "createPromoCode",
"params": { "promocode": "CASINO" },
"token": "TEMPTOKEN"
}
| promocode: |
Request
{
"method": "deletePromoCode",
"params": { "promocode": "CASINO" },
"token": "TEMPTOKEN"
}
| promocode: |
Request
{
"method": "getMyPublicKeyPaymentAliases",
"params": { "requestId": "12312312" },
"token": "TEMPTOKEN"
}
| Request Id: |
Request
{
"method": "verifyTransaction",
"params": { "source": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"destination": "70AE0077C023EF30",
"amount": 1,4,
"currency": "CRP",
"batch": "0KC87SL67W585"},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"request_id": "1855153199043290528"
},
"resultExtraInfo": {
"elapsed": "17"
}
}
After that you can use value of request_id to obtain responsefrom the server by api method getVerifyTransactionResponse
| Source PK: | |
| Destination PK: | |
| Amount: | |
| Currency ('CRP' or 'USD'): | |
| Batch Id: |
Request
{
"method": "verifyTransactionByHash",
"params": { "hash": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F"},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"request_id": "1855153199043290528"
},
"resultExtraInfo": {
"elapsed": "17"
}
}
After that you can use value of request_id to obtain responsefrom the server by api method getVerifyTransactionResponse
| Hash of transaction: |
Request
{
"method": "verifyVoucherByHash",
"params": { "hash": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"voucherid": "USD-HREU-IAWP-LVCZ-XKND-S2B2" },
"token": "TEMPTOKEN"
}
Response
{
"result": {
"request_id": "1855153199043290528"
},
"resultExtraInfo": {
"elapsed": "17"
}
}
After that you can use value of request_id to obtain responsefrom the server by api method getVerifyTransactionResponse
| Hash of transaction: | |
| Voucher name: |
Request
{
"method": "getVerifyTransactionResponse",
"params": { "requestId": "12312312" },
"token": "TEMPTOKEN"
}
| Request Id: |
Request
{
"method": "sendPayment",
"params": {
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"comment": "gift",
"cardid": "70AE0077C023EF30",
"amount": "10",
"currency": "CRP"
},
"token": "TEMPTOKEN"
}
Possible erros:
- Corresponded source card is not present
- Corresponded amount must be more than 0.01 UUSD
- Corresponded amount must be multiple one cent
- Corresponded amount and fee must be more than your balance, your amount
| To (nick, pk, card): | |
| Amount: | |
| Comment (optional): | |
| From card (optional): | |
| Currency: |
Request
{
"method": "addDelegate",
"params": {
"pk": "CDEC99906E4F90799E4399592CC7C59E75BA0AC89FE7EB52C01A89F3F0C5F360",
"amount": "10"
},
"token": "TEMPTOKEN"
}
| Public Key: | |
| Amount: |
Request
{
"method": "revokeDelegated",
"params": {
"pk": "CDEC99906E4F90799E4399592CC7C59E75BA0AC89FE7EB52C01A89F3F0C5F360"
},
"token": "TEMPTOKEN"
}
| Public Key: |
Request
{
"method": "getDPoSInfo",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "sendInvoice",
"params": {
"comment": "",
"cardid": "123",
"amount": ""
},
"token": "TEMPTOKEN"
}
| Card Id: | |
| Amount: | |
| Comment (optional): |
Request
{
"method": "acceptInvoice",
"params": {
"invoiceid": "123"
},
"token": "TEMPTOKEN"
}
| Invoice Id: |
Request
{
"method": "declineInvoice",
"params": {
"invoiceid": "123"
},
"token": "TEMPTOKEN"
}
| Invoice Id: |
Request
{
"method": "requestUnsTransfer",
"params": {
"name": "e22",
"hexNewOwnerPk": "77D1832EBB35F233A1BB4B4AD9ECC7774F8F2000733EAA81F615A9173A487A52"
},
"token": "TEMPTOKEN"
}
Response
{
"result": "8EF88CC4055DB9A71AF60FBB3A48300BC051DC000B636AA020F4E5FF0433BD84",
"resultExtraInfo": {
"elapsed": "2"
}
}
| Name: | |
| Public Key: |
Request
{
"method": "acceptUnsTransfer",
"params": {
"requestId": "123"
},
"token": "TEMPTOKEN"
}
Response
{
"result": "656863B6D6AA80C0B38DF1D6C64FDC7FBCD658736D666EE2EC22B55DA2052560",
"resultExtraInfo": {
"elapsed": "3"
}
}
| RequestId: |
Request
{
"method": "declineUnsTransfer",
"params": {
"requestId": "123"
},
"token": "TEMPTOKEN"
}
Response
{
"result": "656863B6D6AA80C0B38DF1D6C64FDC7FBCD658736D666EE2EC22B55DA2052560",
"resultExtraInfo": {
"elapsed": "3"
}
}
| RequestId: |
Request
{
"method": "incomingUnsTransfer",
"token": "TEMPTOKEN"
}
Response
{
"result": [
],
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "outgoingUnsTransfer",
"token": "TEMPTOKEN"
}
Response
{
"result": [
],
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "storageWipe",
"token": "TEMPTOKEN"
}
Request
{
"method": "cancelInvoice",
"params": {
"invoiceid": "123"
},
"token": "TEMPTOKEN"
}
| Invoice Id: |
Request
{
"method": "getTransactionIdByReferenceNumber",
"params": {
"referenceNumber": "123",
"fullInfo": true
},
"token": "TEMPTOKEN"
}
| Reference Number: | |
| Full Info: |
Request
{
"method": "getInvoiceByReferenceNumber",
"params": {
"referenceNumber": "123"
},
"token": "TEMPTOKEN"
}
| ReferenceNumber: |
Request
{
"method": "getInvoices",
"params": {
"parameters": {
"cardId": "",
"invoiceId": "",
"pk": "",
"transactionId": "",
"status": "",
"startDateTime": "",
"endDateTime": "",
"referenceNumber": ""
}
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
],
"resultExtraInfo": {
"elapsed": "0"
}
}
| CardId: | |
| InvoiceId: | |
| Publick Key: | |
| TransactionId: | |
| Status: | |
| StartDateTime: | |
| EndDateTime: | |
| ReferenceNumber: |
Request
{
"method": "getVouchers",
"params": {
"currency": "CRP"
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
],
"resultExtraInfo": {
"elapsed": "0"
}
}
| Currency: |
Request
{
"method": "getCards",
"token": "TEMPTOKEN"
}
Request
{
"method": "enableMining",
"params": {
"enable": "true"
},
"token": "TEMPTOKEN"
}
| Enable (true/false): |
Request
{
"method": "enablePoS",
"params": {
"enable": "true"
},
"token": "TEMPTOKEN"
}
| Enable (true/false): |
Request
{
"method": "enableHistoryMining",
"params": {
"enable": "true"
},
"token": "TEMPTOKEN"
}
| Enable (true/false): |
Request
{
"method": "statusHistoryMining",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "getMiningBlocks",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "getMiningBlocksWithTreasury",
"params": {
"fromBlockId": "71464",
"toBlockId": "",
"limit": ""} ,
"token": "TEMPTOKEN"
}
Response
{
"result": [
{
"dateTime": "2022-05-13T09:46:17.392Z", - time of block
"id": 86926, - id of mining block
"involvedIn": false,
"involvedInCount": 1, - count your miners that have mined in this block
"numberMiners": 18252, - total count of miners that have mined in this block
"price": 0.002629848, - price for one block
"treasury": {
"CRP": [
{
"amount": 6567876.338597688, - total amount of CRP
"type": "TOTAL_AMOUNT",
"volume": 178339 - total count of wallets with CRP
},
{
"amount": 6400547.52158307, - total supply of CRP after mining
"type": "TOTAL_SUPPLY",
"volume": 86476 - total count of wallets with CRP
},
{
"amount": 16445706.66712978, - total transferred amount in CRP
"type": "AMOUNT_BY_TRANSACTIONS_ALL",
"volume": 314797 - total transaction in CRP
}
],
"UUSD": [
{
"amount": 999217.233752968, - total amount of UUSD
"type": "TOTAL_AMOUNT",
"volume": 177871 - total count of wallets with UUSD
}
]
}
},
....
| from block id: | |
| to block id: | |
| limit: |
Request
{
"method": "getMiningInfo",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"minedAllTime": 0,
"minedSession": 0
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "getFinanceSystemInformation",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"cardCreatePrice": 0.0001,
"cardCreatePrice10": 0.001,
"cardCreatePrice100": 0.01,
"cardCreatePrice1000": 0.1,
"cardCreatePrice10000": 1,
"cardsCreationEnabled": true,
"cardsMaxActive": 50,
"cardsMaxPerDay": 10,
"enableToUseMining": true,
"PoS": false,
"invoicesDefaultTtl": 14400,
"invoicesEnabled": true,
"invoicesMaxTotal": 50,
"invoicesMaxTotalFromMerchant": 5,
"invoicesMinAmount": 1e-09,
"miningEnabled": false,
"settingsVersion": 0,
"transferCardFee": 4.123,
"transferCheckFee": true,
"transferExternalFee": 2,
"transferInternalFee": 1,
"transfersEnabled": true,
"unsDefaultTtl": 43200,
"unsDeleteNameFee": 0.01,
"unsModifyNameFee": 0.01,
"unsName1RegistrationFee": 1000,
"unsName2RegistrationFee": 100,
"unsName3RegistrationFee": 5,
"unsName4RegistrationFee": 0.1,
"unsProxyEnabled": false,
"unsTransferFee": 0.1,
"vouchersCreateEnabled": true,
"vouchersMaxActive": 1000,
"vouchersMaxPerBatch": 50,
"vouchersMinAmount": 1e-09,
"vouchersMinPerBatch": 2,
"vouchersUseEnabled": true
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "addCard",
"params": {
"color": "",
"name": "test",
"preorderNumberInCard": ""
},
"token": "TEMPTOKEN"
}
| Name of card: | |
| Color (In RGB format, for example '#FFFFFF'): | |
| First 4 numbers of the card (optional): |
Request
{
"method": "deleteCard",
"params": {
"cardId": "123"
},
"token": "TEMPTOKEN"
}
| CardId: |
Request
{
"method": "createVoucher",
"params": {
"amount": "1",
"currency": "CRP"
},
"token": "TEMPTOKEN"
}
Response
{
"result": "C22CBFA08DC02C7CE27811DFABC2812828A7075CFDEF807355742D7931664241",
"resultExtraInfo": {
"elapsed": "2"
}
}
| Amount: | |
| Currency: |
Request
{
"method": "createVoucherBatch",
"params": {
"amount": "1",
"count": "5",
"currency": "CRP"
},
"token": "TEMPTOKEN"
}
Response
{
"result": "C22CBFA08DC02C7CE27811DFABC2812828A7075CFDEF807355742D7931664241",
"resultExtraInfo": {
"elapsed": "2"
}
}
| Amount: | |
| Count: | |
| Currency: |
Request
{
"method": "useVoucher",
"params": {
"voucherid": "UTP-LWG3-ETOR-XPYC-NVSU-MHJ3"
},
"token": "TEMPTOKEN"
}
| VoucherId: |
Request
{
"method": "deleteVoucher",
"params": {
"voucherid": "UTP-LWG3-ETOR-XPYC-NVSU-MHJ3"
},
"token": "TEMPTOKEN"
}
Response
{
"result": "B0C719276EDD5DFCA519E9EF16B1FF64D582A9731C8FC7E60A3F200E68D0B9A0",
"resultExtraInfo": {
"elapsed": "2"
}
}
| VoucherId: |
Request
{
"method": "sendAuthorizationRequest",
"params": {
"pk": "FC4A715DF0C71B4623EBB56876262945D81C48972F2A34060892D17D55C88418",
"message": "123"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "23"
}
}
| Public Key: | |
| Message: |
Request
{
"method": "acceptAuthorizationRequest",
"params": {
"pk": "FC4A715DF0C71B4623EBB56876262945D81C48972F2A34060892D17D55C88418",
"message": ""
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "10"
}
}
| Public Key: | |
| Message: |
Request
{
"method": "rejectAuthorizationRequest",
"params": {
"pk": "FC4A715DF0C71B4623EBB56876262945D81C48972F2A34060892D17D55C88418",
"message": "123"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "78"
}
}
| Public Key: | |
| Message: |
Request
{
"method": "deleteContact",
"params": {
"pk": "82348F684E8C3E2F8E0EF3C960D25619F813D7A2ABB049FB79A370D39A987F3D"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "1"
}
}
| Public Key: |
Request
{
"method": "setContactGroup",
"params": {
"contactPublicKey": "CDEC99906E4F90799E4399592CC7C59E75BA0AC89FE7EB52C01A89F3F0C5F36A",
"groupName": "test"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "70"
}
}
| Public Key: | |
| Group Name: |
Request
{
"method": "renameContactGroup",
"params": {
"oldGroupName": "friends",
"newGroupName": "best friends"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 3,
"resultExtraInfo": {
"elapsed": "70"
}
}
| Old group name: | |
| New group name: |
Request
{
"method": "deleteContactGroup",
"params": {
"groupName": "co-workers"
},
"token": "TEMPTOKEN"
}
Response
{
"result": 3,
"resultExtraInfo": {
"elapsed": "70"
}
}
| Group name: |
Request
{
"method": "setContactNick",
"params": {
"contactPublicKey": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
"newNick": "temp"
},
"token": "TEMPTOKEN"
}
Response
{
"result": true,
"resultExtraInfo": {
"elapsed": "2"
}
}
| Public Key: | |
| New Nick: |
Request
{
"method": "getChannels",
"params": {
"filter": "talk",
"channel_type": "5",
"from": "", // or "2019-11-23T10:00:00.001",
"to": "" // or "2021-11-23T10:00:00.001"
},
"token": "TEMPTOKEN"
}
| Filter: | |
| Type: 0-Registred, 1-Recent, 2-My, 3-Friends, 4-Bookmarked, 5-Joined, 6-Opened, 7-Black List, 9-Deleted: | |
| Datetime from or empty: | |
| Datetime tor or empty: |
Request
{
"method": "sendChannelPrivateMessageToContact",
"params": {
"channelid": "C160AB99F292C98746C3EA6ABB6AC7CD",
"contactHashedPk": "2F4413F9228215B2F76595C88231441C",
"message": "test"
},
"token": ""
}
| Channel Id: | |
| ContactHashedPk: | |
| Message: |
Request
{
"method": "getChannelPrivateMessagesOfContact",
"params": {
"channelid": "C160AB99F292C98746C3EA6ABB6AC7CD",
"contactHashedPk": "2F4413F9228215B2F76595C88231441C"
},
"token": ""
}
| Channel Id: | |
| ContactHashedPk: |
Request
{
"method": "sendChannelMessage",
"params": {
"channelid": "123",
"message": "123"
},
"token": ""
}
| Channel Id: | |
| Message: |
Request
{
"method": "sendChannelComment",
"params": {
"channelid": "C160AB99F292C98746C3EA6ABB6AC7CD",
"comment": "Text of comment",
"message_id": "123456",
},
"token": ""
}
| Channel Id: | |
| Comment: | |
| Message Id: |
Request
{
"method": "getChannelComments",
"params": {
"channelid": "C160AB99F292C98746C3EA6ABB6AC7CD",
"message_id": "123456",
},
"token": ""
}
| Channel Id: | |
| Message Id: |
Request
{
"method": "sendChannelPicture",
"params": {
"channelid": "C160AB99F292C98746C3EA6ABB6AC7CD",
"base64_image": "af44......",
"comment": "gift"
"filename_image": "a.gif"
},
"token": "TEMPTOKEN"
}
| Channel Id: | |||
| Image in base64: | Or select image: | ||
| Comment: | |||
| Filename: | |||
Request
{
"method": "sendChannelQuote",
"params": {
"channelid": "123",
"text": "test",
"id_message": "12345"
},
"token": "TEMPTOKEN"
}
| Channel Id: | |
| Text: | |
| Id message: |
Request
{
"method": "removeChannelMessage",
"params": {
"channelid": "123",
"id_message": "12345"
},
"token": "TEMPTOKEN"
}
| Channel Id: | |
| Id message: |
Request
{
"method": "enableChannelNotification",
"params": {
"channelid": "123",
"enabled": false
},
"token": "TEMPTOKEN"
}
| Channel Id: | |
| Enabled: |
Request
{
"method": "getChannelMessages",
"params": {
"channelid": "123",
"limitRows": 1
},
"token": "TEMPTOKEN"
}
| channelid: | |
| limitRows: | |
| offsetRows: |
Request
{
"method": "getChannelInfo",
"params": {
"channelid": "123"
},
"token": "TEMPTOKEN"
}
| Channel Id: |
Request
{
"method": "getChannelModerators",
"params": {
"channelid": "123"
},
"token": "TEMPTOKEN"
}
| Channel Id: |
Request
{
"method": "getChannelContacts",
"params": {
"channelid": "123"
},
"token": "TEMPTOKEN"
}
| Channel Id: |
Request
{
"method": "getChannelModeratorRight",
"params": {
"channelid": "123",
"moderator": "1"
},
"token": "TEMPTOKEN"
}
| Channel Id: | |
| Moderator: |
Request
{
"method": "createChannel",
"params": {
"channel_name": "",
"description": "",
"read_only": "",
"read_only_privacy": "",
"password": "",
"languages": "",
"hashtags": "",
"geoTag": "",
"base64_avatar_image": "",
"hide_in_UI": ""
},
"token": "TEMPTOKEN"
}
| channel_name: | |
| description: | |
| read_only: | |
| read_only_privacy: | |
| password: | |
| languages: | |
| hashtags: | |
| geoTag: | |
| base64_avatar_image: | |
| hide_in_UI: |
Request
{
"method": "modifyChannel",
"params": {
"channelid": "",
"description": "",
"read_only": "",
"read_only_privacy": "",
"password": "",
"languages": "",
"hashtags": "",
"geoTag": "",
"base64_avatar_image": "",
"hide_in_UI": ""
},
"token": "TEMPTOKEN"
}
| channelid: | |
| description: | |
| read_only: | |
| read_only_privacy: | |
| password: | |
| languages: | |
| hashtags: | |
| geoTag: | |
| base64_avatar_image: | |
| hide_in_UI: |
Request
{
"method": "modifyChannelTitle",
"params": {
"channelid": "123",
"newTitle": "new title",
"password": "pass"
},
"token": "TEMPTOKEN"
}
| channelid: | |
| new title: | |
| password: |
Request
{
"method": "modifyChannelPassword",
"params": {
"channelid": "123",
"newPassword": "new pass",
"password": "pass"
},
"token": "TEMPTOKEN"
}
| channelid: | |
| new password: | |
| password: |
Request
{
"method": "deleteChannel",
"params": {
"channelid": "123"
"password": "pass"
},
"token": "TEMPTOKEN"
}
| channelid: | |
| password: |
Request
{
"method": "getChannelSystemInfo",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"local_db_channels": 2972,
"last_downloaded_channel": "IMAGES",
"peers_connected": 16,
"total_channels": 3081
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "getChannelBannedContacts",
"params": {
"channelid": "123123121"
},
"token": "TEMPTOKEN"
}
| channelid |
Request
{
"method": "applyChannelBannedContacts",
"params": {
"channelid": "123123121"
"newList": "[{"hash":"04E06F309930BD34B2FE1E95C852E6FF","nick":"mick"},{"hash":"BD287E72AB20D619737478D24D28949E","nick":"spammer"}]"
},
"token": "TEMPTOKEN"
}
Or
{
"method": "applyChannelBannedContacts",
"params": {
"channelid": "123123121"
"newList": "04E06F309930BD34B2FE1E95C852E6FF,BD287E72AB20D619737478D24D28949E"
},
"token": "TEMPTOKEN"
}
| channelid | |
| newList |
Request
{
"method": "leaveChannel",
"params": {
"channelid": "123"
},
"token": "TEMPTOKEN"
}
| Channel Id: |
Request
{
"method": "joinChannel",
"params": {
"ident": "123",
"password": "123"
},
"token": "TEMPTOKEN"
}
Possible errrors:
- Cannot find channel by corresponded ident
- Your password is incorrect
- Your don't have right to join
| Ident: | |
| Password: |
Request
{
"method": "fetchChannelHistory",
"params": {
"channelid": "123"
},
"token": "TEMPTOKEN"
}
| ChannelId: |
Request
{
"method": "unsCreateRecordRequest",
"params": {
"nick": "",
"valid (obsolete)": "",
"isPrimary": "false",
"channelId": ""
},
"token": "TEMPTOKEN"
}
| Nick: | |
| (Obsolete) Valid (yyyy-mm-dd): | |
| isPrimary: | |
| ChannelId: |
Request
{
"method": "unsModifyRecordRequest",
"params": {
"nick": "",
"valid": "",
"isPrimary": "false",
"channelId": ""
},
"token": "TEMPTOKEN"
}
| Nick: | |
| Valid (yyyy-mm-dd): | |
| isPrimary: | |
| ChannelId: |
Request
{
"method": "unsDeleteRecordRequest",
"params": {
"nick": ""
},
"token": "TEMPTOKEN"
}
| uNS name: |
Request
{
"method": "unsHistoryName",
"params": {
"name": "test"
},
"token": "TEMPTOKEN"
}
| uNS name: |
Request
{
"method": "unsSearchByPk",
"params": {
"filter": "2323"
},
"token": "TEMPTOKEN"
}
| Public Key: |
Request
{
"method": "unsSearchByNick",
"params": {
"filter": "qwe"
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
],
"resultExtraInfo": {
"elapsed": "9"
}
}
| Filter: |
Request
{
"method": "unsRegisteredNamesByDatetimes",
"params": {
"from": "2019-11-23T10:00:00.001",
"to": "2021-11-23T10:00:00.001"
},
"token": "TEMPTOKEN"
}
Response
{}
| Datetime from: | |
| Datetime to: |
Request
{
"method": "unsUnregisteredNamesByDatetimes",
"params": {
"from": "2019-11-23T10:00:00.001",
"to": "2021-11-23T10:00:00.001"
},
"token": "TEMPTOKEN"
}
Response
{}
| Datetime from: | |
| Datetime to: |
Request
{
"method": "summaryUnsRegisteredNames",
"params": {
"fromDate": "2019-11-23",
"toDate": ""
},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"records": [
],
"summary": {
"registred_during_selected": 0,
"registred_during_year": 0,
"registred_names": 3614,
"registred_users": 154
}
},
"resultExtraInfo": {
"elapsed": "78"
}
}
| date from: | |
| date to: |
Request
{
"method": "getUnsSyncInfo",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"last_record_names_registered": "security-test-not-delete",
"local_blocks": 15583,
"peers_connected": 16,
"state": "Idle",
"total_blocks": 15583
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "unsRegisteredNames",
"params": {},
"token": "TEMPTOKEN"
}
Response
{
"result": [
],
"resultExtraInfo": {
"elapsed": "8"
}
}
Request
{
"method": "getEmailFolder",
"params": {
"folderType": "1",
"filter": ""
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
1178,
1012,
990,
251,
242,
233,
47
],
"resultExtraInfo": {
"elapsed": "0"
}
}
| FolderType: | |
| Filter: |
Request
{
"method": "getEmails",
"params": {
"folderType": "1",
"filter": ""
},
"token": "TEMPTOKEN"
}
Response
{
"result": [
{
"dateTime": "2017-06-14T11:14:31.157Z",
"from": "82348F684E8C3E2F8E0EF3C960D25619F813D7A2ABB049FB79A370D39A987F3D",
"id": 1178,
"size": 50,
"subject": "",
"to": [
"CFF4DB80DCA10BD2317D538FF790A03EDA26274768E5EB04E0FDA51989131F32"
]
},
{
"dateTime": "2016-12-08T16:08:48.617Z",
"from": "FC496FE0D634C0475838DAEBEFA2F841398CDACCCC2E8F030D4ABEC490878715",
"id": 1012,
"size": 139635,
"subject": "",
"to": [
"CFF4DB80DCA10BD2317D538FF790A03EDA26274768E5EB04E0FDA51989131F32"
]
}
}
| FolderType: | |
| Filter: |
Request
{
"method": "getEmailById",
"params": {
"id": "33"
},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"body": "",
"date": null,
"flags": 0,
"from": "",
"id": "",
"subject": "",
"to": [
]
},
"resultExtraInfo": {
"elapsed": "0"
}
}
| Id: |
Request
{
"method": "acceptAttachment",
"params": {
"emailId": "403590",
"fileId": "403595"
},
"token": "TEMPTOKEN"
}
Response
{
"result": false,
"resultExtraInfo": {
"elapsed": "0"
}
}
| Email Id: | |
| File Id: |
Request
{
"method": "abortAttachment",
"params": {
"emailId": "403590",
"fileId": "403595"
},
"token": "TEMPTOKEN"
}
Response
{
"result": false,
"resultExtraInfo": {
"elapsed": "0"
}
}
| Email Id: | |
| File Id: |
Request
{
"method": "acceptFileMessage",
"params": {
"messageId": "403590"
},
"token": "TEMPTOKEN"
}
Response
{
"result": false,
"resultExtraInfo": {
"elapsed": "0"
}
}
| Message Id: |
Request
{
"method": "abortFileMessage",
"params": {
"messageId": "403590"
},
"token": "TEMPTOKEN"
}
Response
{
"result": false,
"resultExtraInfo": {
"elapsed": "0"
}
}
| Message Id: |
Request
{
"method": "deleteEmail",
"params": {
"id": "33"
},
"token": "TEMPTOKEN"
}
| Id: |
Request
{
"method": "sendReplyEmailMessage",
"params": {
"id": "33",
"body": "hi",
"subject": "new subject",
"attachmentFileId": 1
},
"token": "TEMPTOKEN"
}
| Id: | |
| Body: | |
| Subject: | |
| Attachment FileId: |
Request
{
"method": "sendForwardEmailMessage",
"params": {
"id": "33",
"to": "FC4A715DF0C71B4623EBB56876262945D81C48972F2A34060892D17D55C88418",
"body": "11",
"subject": "new subject",
"attachmentFileId": 123
},
"token": "TEMPTOKEN"
}
| Id: | |
| To: | |
| Body: | |
| Subject: | |
| Attachment FileId: |
Request
{
"method": "sendEmailInvitation",
"params": {
"channelid": "33",
"to": "9F0A36BC95EA653E05E39C6B6566AAC5B9B31FB41F15C9F4A0B8CCA6927B814F",
],
"description: "description text,
"comments": "test"
},
"token": "TEMPTOKEN"
}
| Channel Id: | |
| Recipient: | |
| Description: | |
| Commets: |
Request
{
"method": "emptyEmailsTrash",
"token": "TEMPTOKEN"
}
Request
{
"method": "setChannelAsBookmarked",
"params": {
"channelid": "33",
"bookmarked": true
},
"token": "TEMPTOKEN"
}
| Channel Id: | |
| Bookmarked (true or false): |
Request
{
"method": "clearTrayNotifications",
"token": "TEMPTOKEN"
}
Request
{
"method": "getNetworkConnections",
"token": "TEMPTOKEN"
}
Request
{
"method": "enableLogs",
"params": {
"enable": true
},
"token": "TEMPTOKEN"
}
| enable |
Request
{
"method": "getLogs",
"params": {
"countLatestRecords": "10"
},
"token": "TEMPTOKEN"
}
| countLatestRecords |
Request
{
"method": "clearNetHostDatabase",
"token": "TEMPTOKEN"
}
Request
{
"method": "enableProxyMapping",
"params": {
"mappingId": "1"
},
"token": "TEMPTOKEN"
}
| MappingId |
Request
{
"method": "disableProxyMapping",
"params": {
"mappingId": "1"
},
"token": "TEMPTOKEN"
}
| MappingId |
Request
{
"method": "removeProxyMapping",
"params": {
"mappingId": ""
},
"token": "TEMPTOKEN"
}
| MappingId |
Request
{
"method": "getProxyMappings",
"token": "TEMPTOKEN"
}
Request
{
"method": "createProxyMapping",
"params": {
"srcHost": "",
"srcPort": "",
"dstHost": "",
"dstPort": "",
"enabled": ""
},
"token": "TEMPTOKEN"
}
| SrcHost | |
| SrcPort | |
| DstHost | |
| DstPort | |
| Enabled |
Request
{
"method": "lowTrafficMode",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "setLowTrafficMode",
"params": {
"enabled": "false"
},
"token": "TEMPTOKEN"
}
| Enabled |
Request
{
"method": "getWhoIsInfo",
"params": {
"owner": ""
},
"token": "TEMPTOKEN"
}
| Owner: |
Request
{
"method": "requestTreasuryPoSRates",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "getTreasuryPoSRates",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "requestTreasuryTransactionVolumes",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "getTreasuryTransactionVolumes",
"params": { "currency": "CRP"},
"token": "TEMPTOKEN"
}
Response
{
"result": {
"summary": {
"allTimeAmount": "10168160.212781259",
"allTimeTransactionVolume": "19699"
},
"transactions": [
{
"amount": 0,
"date": "2019-12-01",
"volume": 0
},
...
{
"amount": 80.556958762,
"date": "2021-08-13",
"volume": 31
},
{
"amount": 1.06,
"date": "2021-08-14",
"volume": 3
}
]
},
"resultExtraInfo": {
"elapsed": "9"
}
}
| Currency ('CRP' or 'USD'): |
Request
{
"method": "requestTreasuryUUSDSupply",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "getTreasuryUUSDSupply",
"token": "TEMPTOKEN"
}
Response
{
"result": {
"records": [
{
"date": "2021-07-01",
"supply": 0
},
{
"date": "2021-08-08",
"supply": 983.569459
},
{
"date": "2021-08-09",
"supply": 983.436858998
},
{
"date": "2021-08-10",
"supply": 983.360269098
}
],
"totalSupply": "983.36"
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "requestTreasuryCrpSupply",
"params": {},
"token": "TEMPTOKEN"
}
Request
{
"method": "getTreasuryCrpSupply",
"token": "TEMPTOKEN"
}
Response
{
"result": {
"records": [
{
"date": "2021-07-01",
"supply": 0
},
{
"date": "2021-08-08",
"supply": 983.569459
},
{
"date": "2021-08-09",
"supply": 983.436858998
},
{
"date": "2021-08-10",
"supply": 983.360269098
}
],
"totalSupply": "983.36"
},
"resultExtraInfo": {
"elapsed": "0"
}
}
Request
{
"method": "getWebSocketState",
"token": "TEMPTOKEN"
}
Request
{
"method": "setWebSocketState",
"params": {
"enabled": "",
"port": "",
"enablessl": true,
"notifications": "all",
},
"token": "TEMPTOKEN"
}
| Enabled: | |
| Port: | |
| Enable ssl: | |
| Notification list: |
Request
{
"method": "getTransfersFromManager",
"token": "TEMPTOKEN"
}
Request
{
"method": "getFilesFromManager",
"token": "TEMPTOKEN"
}
Request
{
"method": "abortTransfers",
"params": {
"transferId": ""
},
"token": "TEMPTOKEN"
}
| TransferId: |
Request
{
"method": "hideTransfers",
"params": {
"transferId": ""
},
"token": "TEMPTOKEN"
}
| TransferId: |
Request
{
"method": "getFile",
"params": {
"fileId": ""
},
"token": "TEMPTOKEN"
}
| FileId: |
Request
{
"method": "deleteFile",
"params": {
"fileId": ""
},
"token": "TEMPTOKEN"
}
| FileId: |
Request
{
"method": "sendFileByMessage",
"params": {
"to": "",
"fileId": ""
},
"token": "TEMPTOKEN"
}
| To: | |
| FileId: |
Request
{
"method": "requestHistoryByDate",
"params": {
"from": "2016-12-08T16:08:48.617Z",
"to": "2016-12-09T16:08:48.617Z"
},
"token": "TEMPTOKEN"
}
| From: | |
| To: |
Request
{
"method": "requestHistoryByBatch",
"params": {
"batch": "062XGHV2NDFYZ",
"currency": "CRP"
},
"token": "TEMPTOKEN"
}
| Batch: | |
| Currency: |
Request
{
"method": "createSmartToken",
"params": {
"name": "NEW_TOKEN",
"code": "NEWTNK",
"description": "test new token",
"emission": 1
},
"token": "TEMPTOKEN"
}
| Name: | |
| Code: | |
| Description: | |
| Emission: | |
| Param: | |
| Logo: |
Request
{
"method": "requestGetSmartTokenInfo",
"params": {
"code": "NEWTNK"
},
"token": "TEMPTOKEN"
}
| Code: |
Request
{
"method": "uploadFile",
"params": {
"fileDataBase64": "12121",
"fileName": "test.jpg"
},
"token": "TEMPTOKEN"
}
| fileDataBase64: | |
| fileName: |