LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity

regenerated docs

Browse source
This commit is contained in:
Lex Berezhny 2019-04-20 23:56:40 -04:00
parent 71f5061848
commit 1644ffbf22
1 changed files with 176 additions and 242 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

418
docs/api.json
View file

@ -49,10 +49,10 @@
"examples": [ "examples": [
{ {
"title": "Get a file", "title": "Get a file",
"curl": "curl -d'{\"method\": \"get\", \"params\": {\"uri\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"get\", \"params\": {\"uri\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\"}}' http://localhost:5279/",
"lbrynet": "lbrynet get astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b", "lbrynet": "lbrynet get astream#70af4076385dbba0fe0b400056f407202caa057a",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"get\", \"params\": {\"uri\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"get\", \"params\": {\"uri\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"claim_name\": \"astream\",\n \"completed\": false,\n \"download_directory\": \"/tmp/tmprk7omj7u\",\n \"download_path\": \"/tmp/tmprk7omj7u/tmp9rj4qtvp\",\n \"file_name\": \"tmp9rj4qtvp\",\n \"key\": \"a63516247749143e585eee43f327025d\",\n \"metadata\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"vAo0GFRQRfs45GXJS7w9+YWWyG0UHeOkYVl2YvPOms62hyPssxOoHTNXosMvkWLS\"\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86:0\",\n \"points_paid\": 0.0,\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\",\n \"status\": \"running\",\n \"stopped\": false,\n \"stream_hash\": \"fdda172ddbd4dcc4aa530b55810bde2934acfe5087364548b718aa66c10fea076e4d7284b204dc67685ad160fee14053\",\n \"stream_name\": \"tmp9rj4qtvp\",\n \"suggested_file_name\": \"tmp9rj4qtvp\",\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"tx\": null,\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"written_bytes\": 11\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_name\": \"astream\",\n \"completed\": false,\n \"download_directory\": \"/tmp/tmpyqz3c__0\",\n \"download_path\": \"/tmp/tmpyqz3c__0/tmpvewkf00n\",\n \"file_name\": \"tmpvewkf00n\",\n \"key\": \"44dbf905146d75f49382c4010138014f\",\n \"metadata\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768:0\",\n \"points_paid\": 0.0,\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"status\": \"running\",\n \"stopped\": false,\n \"stream_hash\": \"3bcc0eec6f0fa68558ac1fa6f1b0ffef340f97e183c21d875d4c3efe67e55b4342da27fc159823cc7f7546dd22eee020\",\n \"stream_name\": \"tmpvewkf00n\",\n \"suggested_file_name\": \"tmpvewkf00n\",\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"tx\": null,\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"written_bytes\": 11\n }\n}"
} }
] ]
}, },
@ -78,12 +78,6 @@
"description": "path to file to be associated with name.", "description": "path to file to be associated with name.",
"is_required": false "is_required": false
}, },
{
"name": "stream_type",
"type": "str",
"description": "type of stream",
"is_required": false
},
{ {
"name": "fee_currency", "name": "fee_currency",
"type": "string", "type": "string",
@ -180,46 +174,22 @@
"description": "original public release of content, seconds since UNIX epoch", "description": "original public release of content, seconds since UNIX epoch",
"is_required": false "is_required": false
}, },
{
"name": "width",
"type": "int",
"description": "image/video width, automatically calculated from media file",
"is_required": false
},
{
"name": "height",
"type": "int",
"description": "image/video height, automatically calculated from media file",
"is_required": false
},
{ {
"name": "duration", "name": "duration",
"type": "int", "type": "int",
"description": "audio/video duration in seconds, an attempt will be made to calculate this automatically if not provided", "description": "audio/video duration in seconds, automatically calculated",
"is_required": false
},
{
"name": "image_width",
"type": "int",
"description": "image width",
"is_required": false
},
{
"name": "image_height",
"type": "int",
"description": "image height",
"is_required": false
},
{
"name": "video_width",
"type": "int",
"description": "video width",
"is_required": false
},
{
"name": "video_height",
"type": "int",
"description": "video height",
"is_required": false
},
{
"name": "video_duration",
"type": "int",
"description": "video duration in seconds, an attempt will be made to calculate this automatically if not provided",
"is_required": false
},
{
"name": "audio_duration",
"type": "int",
"description": "audio duration in seconds, an attempt will be made to calculate this automatically if not provided",
"is_required": false "is_required": false
}, },
{ {
@ -259,14 +229,14 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Publish a file", "title": "Publish a file",
"curl": "curl -d'{\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpynod_gwc\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpedztjjmr\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet publish a-new-stream --bid=1.0 --file_path=/tmp/tmpynod_gwc", "lbrynet": "lbrynet publish a-new-stream --bid=1.0 --file_path=/tmp/tmpedztjjmr",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpynod_gwc\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_account_id\": [], \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpedztjjmr\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_account_id\": [], \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001ebcc53ba79150a1e2ed395417bdb69f678c91914f52b593310432493d7d2b9fa010000006a47304402207afa628cb1be384f6d1f36a4b6b38b5e79ca64dc2ca8ebacd1f8fbfb9bfcdb38022032650be40827cc4bdf70712e85893a4236c864040875dbfeb8da30242fb7373d01210399d8c19f39ff0a2a3be8f31a69e517c55e52b5f7018684344f7596c94ae777bdffffffff0200e1f505000000007eb50c612d6e65772d73747265616d4c53000a500a309f64657d3bad74b527b56404ecb1885f79b7922d1e40fdf11e593c52a1a39f78d0dde43816a87c83df6f969596579d2d6a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d7576a914c829465558fd5d7cc0cb1d1355d2a18280ad833988acf8b88523000000001976a914f799a9fcabd262287836c976ff6d28a0edc7fe4f88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mgM4MpdJQCQibrqnXdtVxVztFV3AT9iQph\",\n \"amount\": \"6.983769\",\n \"confirmations\": 6,\n \"height\": 209,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"fab9d2d79324431033592bf51419c978f669db7b4195d32e1e0a1579ba53cceb\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mymJtEqGU93RiHZCPjMi8myUS5dZR4ifAb\",\n \"amount\": \"1.0\",\n \"claim_id\": \"5fcd32930a7f2d29534c48c16f3ff02303082875\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"a-new-stream\",\n \"nout\": 0,\n \"permanent_url\": \"a-new-stream#5fcd32930a7f2d29534c48c16f3ff02303082875\",\n \"txid\": \"f3a79cb098780c9d3235a3e69c8c97d3cba2bed2703deadd65d45941ddb123b7\",\n \"type\": \"claim\",\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"9f64657d3bad74b527b56404ecb1885f79b7922d1e40fdf11e593c52a1a39f78d0dde43816a87c83df6f969596579d2d\"\n }\n }\n },\n {\n \"address\": \"n469HCVAZSL2V2ShCR11TYY6fWF8ddJixz\",\n \"amount\": \"5.959662\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"f3a79cb098780c9d3235a3e69c8c97d3cba2bed2703deadd65d45941ddb123b7\"\n }\n ],\n \"total_fee\": \"0.024107\",\n \"total_input\": \"6.983769\",\n \"total_output\": \"6.959662\",\n \"txid\": \"f3a79cb098780c9d3235a3e69c8c97d3cba2bed2703deadd65d45941ddb123b7\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000129c08d88eb5cddb75075e665a0e1f2ab944131f8d5774c0a79e934debe85a9fe010000006a473044022077c8617f755c05548b1f7c97c13142b455d0423d2c6985f28be44cd414e0330702203cc7079a124e3c16589d473c29b5f0a3dabb44cd9732796e77af82967a2524f701210225daefb24c43245f72764829043965642515571f2bb61ab586e01a4e90a60799ffffffff0200e1f50500000000adb50c612d6e65772d73747265616d4c82000a7f0a7d0a20b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9120b746d7065647a746a6a6d72180b22186170706c69636174696f6e2f6f637465742d73747265616d3230197f373eaacede1ec960c5933669a1672b8db43282aca3f986e7f887e22d1842c60eb2847b323c0e4030afeb74a6a0d46d7576a9142786e030eefb89d4dc708873fc514e68b88461d188acf8b88523000000001976a9149809994d06f4164946626b3a6865e24487541db688ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mxsHYdMzW3y6xbSw7ox9w21zVzBe9DjYJS\",\n \"amount\": \"6.983769\",\n \"confirmations\": 6,\n \"height\": 209,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"fea985bede34e9790a4c77d5f8314194abf2e1a065e67550b7dd5ceb888dc029\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mj7xDsDR5s96h1PF55dkx2p44qUDmGPHTd\",\n \"amount\": \"1.0\",\n \"claim_id\": \"0055817871df962cfb2882d101cc5dffd4be90a0\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"a-new-stream\",\n \"nout\": 0,\n \"permanent_url\": \"a-new-stream#0055817871df962cfb2882d101cc5dffd4be90a0\",\n \"sub_type\": \"stream\",\n \"txid\": \"a51655ce27584082c5c63d6e90c2d7387b17a7b30e6dffec46055636bdc0e91b\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpedztjjmr\",\n \"sd_hash\": \"197f373eaacede1ec960c5933669a1672b8db43282aca3f986e7f887e22d1842c60eb2847b323c0e4030afeb74a6a0d4\",\n \"size\": \"11\"\n }\n }\n },\n {\n \"address\": \"muNrW9hPxp3urCwoYpUqNB9L8X5JgrHHRz\",\n \"amount\": \"5.959662\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"a51655ce27584082c5c63d6e90c2d7387b17a7b30e6dffec46055636bdc0e91b\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.024107\",\n \"total_input\": \"6.983769\",\n \"total_output\": \"6.959662\",\n \"txid\": \"a51655ce27584082c5c63d6e90c2d7387b17a7b30e6dffec46055636bdc0e91b\"\n }\n}"
} }
] ]
}, },
@ -285,10 +255,10 @@
"examples": [ "examples": [
{ {
"title": "Resolve a claim", "title": "Resolve a claim",
"curl": "curl -d'{\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"]}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#70af4076385dbba0fe0b400056f407202caa057a\"]}}' http://localhost:5279/",
"lbrynet": "lbrynet resolve astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b", "lbrynet": "lbrynet resolve astream#70af4076385dbba0fe0b400056f407202caa057a",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"]}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#70af4076385dbba0fe0b400056f407202caa057a\"]}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\": {\n \"certificate\": {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 3,\n \"effective_amount\": \"1.0\",\n \"has_signature\": false,\n \"height\": 210,\n \"hex\": \"0012670a583056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4120b4e6577204368616e6e656c\",\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"supports\": [],\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\",\n \"valid_at_height\": 210,\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\",\n \"title\": \"New Channel\"\n }\n }\n },\n \"claim\": {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 1,\n \"effective_amount\": \"1.0\",\n \"has_signature\": true,\n \"height\": 212,\n \"hex\": \"01bd134d2a074754414ce328ba766816a7612f7b7e2c5378c71cf936592d6ab469cd5bdcbb3daddf22900659ace60f2c9aedc9d979717af910cf82c3c6109d59d8870361da5fb952e98a84ee93727ceb94cd0419ef0a500a30bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d26a186170706c69636174696f6e2f6f637465742d73747265616d7202100b\",\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"signature_is_valid\": true,\n \"supports\": [],\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"valid_at_height\": 212,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n },\n \"claims_in_channel\": 0\n }\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"astream#70af4076385dbba0fe0b400056f407202caa057a\": {\n \"certificate\": {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 3,\n \"effective_amount\": \"1.0\",\n \"has_signature\": false,\n \"height\": 210,\n \"hex\": \"00125a0a583056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597420b4e6577204368616e6e656c\",\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"supports\": [],\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\",\n \"valid_at_height\": 210,\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n \"claim\": {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 1,\n \"effective_amount\": \"1.0\",\n \"has_signature\": true,\n \"height\": 212,\n \"hex\": \"01bd7f0813864188e9b2018c68858ea86a3e90aecee46e57b139165fddc382a7f502edc7a07b675130a4435cb15726d189ae5768f31be20e8db061c5fe1ae3b7231e0e8bb2c7100587f018c44aa1d55ba245750ff80a7f0a7d0a20b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9120b746d707665776b6630306e180b22186170706c69636174696f6e2f6f637465742d73747265616d32307b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signature_is_valid\": true,\n \"supports\": [],\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"valid_at_height\": 212,\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n },\n \"claims_in_channel\": 0\n }\n }\n}"
} }
] ]
}, },
@ -310,7 +280,7 @@
"curl": "curl -d'{\"method\": \"status\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"status\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet status", "lbrynet": "lbrynet status",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"status\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"status\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"blob_manager\": {\n \"finished_blobs\": 0\n },\n \"connection_status\": {\n \"code\": \"connected\",\n \"message\": \"No connection problems detected\"\n },\n \"installation_id\": \"25BNK6rBYfBS7pvjEBr77gXTAsDiD4er8B49bYG3fFnJjj3PMAX843pvXqicVRZExc\",\n \"is_running\": true,\n \"skipped_components\": [\n \"dht\",\n \"upnp\",\n \"hash_announcer\",\n \"peer_protocol_server\"\n ],\n \"startup_status\": {\n \"blob_manager\": true,\n \"blockchain_headers\": true,\n \"database\": true,\n \"exchange_rate_manager\": true,\n \"stream_manager\": true,\n \"wallet\": true\n },\n \"stream_manager\": {\n \"managed_files\": 0\n },\n \"wallet\": {\n \"best_blockhash\": \"aa7cefe24262217821957ae3cb0a5610790cfd9ee8bc28ad8eabe5fd34e0a9e7\",\n \"blocks\": 206,\n \"blocks_behind\": 0,\n \"is_encrypted\": false,\n \"is_locked\": false\n }\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"blob_manager\": {\n \"finished_blobs\": 0\n },\n \"connection_status\": {\n \"code\": \"connected\",\n \"message\": \"No connection problems detected\"\n },\n \"installation_id\": \"4uYYdtcGtPeEYMmB6bfFQawQCaR2zSotPASrY8eJr9UwmZQKe6R3me8SMzW1DCzrwc\",\n \"is_running\": true,\n \"skipped_components\": [\n \"dht\",\n \"upnp\",\n \"hash_announcer\",\n \"peer_protocol_server\"\n ],\n \"startup_status\": {\n \"blob_manager\": true,\n \"blockchain_headers\": true,\n \"database\": true,\n \"exchange_rate_manager\": true,\n \"stream_manager\": true,\n \"wallet\": true\n },\n \"stream_manager\": {\n \"managed_files\": 0\n },\n \"wallet\": {\n \"best_blockhash\": \"38b7725637b9b870bc679e7650feb17098574f35a949ba9d378521546a97bf67\",\n \"blocks\": 206,\n \"blocks_behind\": 0,\n \"is_encrypted\": false,\n \"is_locked\": false\n }\n }\n}"
} }
] ]
}, },
@ -332,7 +302,7 @@
"curl": "curl -d'{\"method\": \"version\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"version\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet version", "lbrynet": "lbrynet version",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"version\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"version\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"build\": \"dev\",\n \"desktop\": \"XFCE\",\n \"distro\": {\n \"codename\": \"Illyria\",\n \"id\": \"manjaro\",\n \"like\": \"arch\",\n \"version\": \"18.0.3\",\n \"version_parts\": {\n \"build_number\": \"3\",\n \"major\": \"18\",\n \"minor\": \"0\"\n }\n },\n \"lbrynet_version\": \"0.35.0\",\n \"os_release\": \"4.14.101-1-MANJARO\",\n \"os_system\": \"Linux\",\n \"platform\": \"Linux-4.14.101-1-MANJARO-x86_64-with-arch-Manjaro-Linux\",\n \"processor\": \"\",\n \"python_version\": \"3.7.2\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"build\": \"dev\",\n \"desktop\": \"GNOME\",\n \"distro\": {\n \"codename\": \"xenial\",\n \"id\": \"ubuntu\",\n \"like\": \"debian\",\n \"version\": \"16.04\",\n \"version_parts\": {\n \"build_number\": \"\",\n \"major\": \"16\",\n \"minor\": \"04\"\n }\n },\n \"lbrynet_version\": \"0.36.0rc1\",\n \"os_release\": \"4.4.0-116-generic\",\n \"os_system\": \"Linux\",\n \"platform\": \"Linux-4.4.0-116-generic-x86_64-with-Ubuntu-16.04-xenial\",\n \"processor\": \"x86_64\",\n \"python_version\": \"3.7.2\"\n }\n}"
} }
] ]
} }
@ -380,10 +350,10 @@
"examples": [ "examples": [
{ {
"title": "Add an account from seed", "title": "Add an account from seed",
"curl": "curl -d'{\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\", \"single_key\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"tilt arm tent canal barely same equal amateur year still shoulder know\", \"single_key\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet account add \"new account\" --seed=\"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\"", "lbrynet": "lbrynet account add \"new account\" --seed=\"tilt arm tent canal barely same equal amateur year still shoulder know\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\", \"single_key\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"tilt arm tent canal barely same equal amateur year still shoulder know\", \"single_key\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555357459.061454,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPd7T1DYvyijnrKnQG2FtickT7miYaur4toH3gk5P4U2m3aK2pca6AnLXPH4YmQubKooD6ePy65UEydw4T7VUkzfXx4cY9CZc\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WaUo7Cba89SxtovCBb5dC43u4EatL7sHdmJTNUCeeXNukReeyMpRMYxEfJuBQGoXGZCcJi3LDz4mJ3tdvZ9PQKLVjEVBBha\",\n \"seed\": \"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555818980.6047785,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPet8Vmrybx3H8ahBP4iyrxppNg2iweUr1scP6t5KJqsBBoZ7VodS6MmdPVaD8wu9ex5eSH3dA52gyzCHJmE9BerZznoEmVz5\",\n \"public_key\": \"tpubD6NzVbkrYhZ4YMAHfWeCMSwF9ihKE4AmY8R9xYmF4keQi6dsWU8u2Mo3ygE1uN2tqjYdZACiAsUK3mJ9QB6CTrxdrdrYHKXNAiJdgGGjP4o\",\n \"seed\": \"tilt arm tent canal barely same equal amateur year still shoulder know\"\n }\n}"
} }
] ]
}, },
@ -415,9 +385,9 @@
}, },
{ {
"title": "Get balance for specific account by id", "title": "Get balance for specific account by id",
"curl": "curl -d'{\"method\": \"account_balance\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_balance\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"}}' http://localhost:5279/",
"lbrynet": "lbrynet account balance \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"", "lbrynet": "lbrynet account balance \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_balance\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_balance\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"2.0\"\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"2.0\"\n}"
} }
] ]
@ -446,7 +416,7 @@
"curl": "curl -d'{\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet account create \"generated account\"", "lbrynet": "lbrynet account create \"generated account\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555357458.8862276,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPd7T1DYvyijnrKnQG2FtickT7miYaur4toH3gk5P4U2m3aK2pca6AnLXPH4YmQubKooD6ePy65UEydw4T7VUkzfXx4cY9CZc\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WaUo7Cba89SxtovCBb5dC43u4EatL7sHdmJTNUCeeXNukReeyMpRMYxEfJuBQGoXGZCcJi3LDz4mJ3tdvZ9PQKLVjEVBBha\",\n \"seed\": \"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555818980.469442,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPet8Vmrybx3H8ahBP4iyrxppNg2iweUr1scP6t5KJqsBBoZ7VodS6MmdPVaD8wu9ex5eSH3dA52gyzCHJmE9BerZznoEmVz5\",\n \"public_key\": \"tpubD6NzVbkrYhZ4YMAHfWeCMSwF9ihKE4AmY8R9xYmF4keQi6dsWU8u2Mo3ygE1uN2tqjYdZACiAsUK3mJ9QB6CTrxdrdrYHKXNAiJdgGGjP4o\",\n \"seed\": \"tilt arm tent canal barely same equal amateur year still shoulder know\"\n }\n}"
} }
] ]
}, },
@ -519,28 +489,28 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Transfer 2 LBC from default account to specific account", "title": "Transfer 2 LBC from default account to specific account",
"curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"to_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"amount\": \"2.0\", \"everything\": false, \"broadcast\": true}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"to_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"amount\": \"2.0\", \"everything\": false, \"broadcast\": true}}' http://localhost:5279/",
"lbrynet": "lbrynet account fund --to_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --amount=2.0 --broadcast", "lbrynet": "lbrynet account fund --to_account=\"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\" --amount=2.0 --broadcast",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"to_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"amount\": \"2.0\", \"everything\": false, \"broadcast\": true}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"to_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"amount\": \"2.0\", \"everything\": false, \"broadcast\": true}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001ae5302384c9a27d545699824cf2db3c7d4edb22c639210fb58999f057728852d000000006a47304402206b748ca4229a238cf49556e6dccc481af0b4490df9e27f4c267838521a3cbfc00220009a33f28cbe79d3a8f87eb266511a55cdc1073b75a64ce5d233935cdee832550121038a6e6838df54d57cb49dbb571395feefb1a803f42580faeca59017c5397f0e6bffffffff0200c2eb0b000000001976a914c43684e1794daf1be7e941a2b6fba21cf3e743ce88ac90d7ae2f000000001976a914e95d88e38afe8ef0fd48014a91fc248630addc6b88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mg7RNSr3TxAKMMcrs67MdzxNwmQKjmunXD\",\n \"amount\": \"10.0\",\n \"confirmations\": 6,\n \"height\": 201,\n \"is_change\": false,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"2d852877059f9958fb1092632cb2edd4c7b32dcf24986945d5279a4c380253ae\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"myQS3hn3FKdwiw3KDEWoAeVjnh8UMq9gc4\",\n \"amount\": \"2.0\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"f4fda657ef59851174e801d8dc8d8cd902e36397c8c01a1c419dec8d1e5d4233\"\n },\n {\n \"address\": \"n2nsnf4ANknZXHxu2dcFYRDJgtJfsysd9q\",\n \"amount\": \"7.999876\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"f4fda657ef59851174e801d8dc8d8cd902e36397c8c01a1c419dec8d1e5d4233\"\n }\n ],\n \"total_fee\": \"0.000124\",\n \"total_input\": \"10.0\",\n \"total_output\": \"9.999876\",\n \"txid\": \"f4fda657ef59851174e801d8dc8d8cd902e36397c8c01a1c419dec8d1e5d4233\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001506740365f55bf33bcf18eedd83df9f55b2703c82848c54bd684eaaeb6a4c585010000006b483045022100b47a14eb35fbd28eeb8a06c6ee4c68c940652f36788ae5230737207f7cfe1342022038cf28a6aeb37ff929c5f5308319d46707fff3270f3d998f354889e9af5806e90121039e85c000587444837d66e12e11aa501e27abfcff419ef56e550aef0645108c33ffffffff0200c2eb0b000000001976a91476c53849b1fc46c48c2608a576a870dadbe7ecc688ac90d7ae2f000000001976a9141e004ae78ae66e171f0fe7b1fabc8a2cc8fb0c4e88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mpFErYoPr4vQGkehF4n4j6K3t3Z1Jmde7u\",\n \"amount\": \"10.0\",\n \"confirmations\": 6,\n \"height\": 201,\n \"is_change\": false,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"85c5a4b6aeea84d64bc54828c803275bf5f93dd8ed8ef1bc33bf555f36406750\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mrLxHmSrMJ2sy21YzCCxpJ1xMH6FcD9XYe\",\n \"amount\": \"2.0\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"322e08e35ad4e406c9c6eb2bab850b0869920effc6e2d8c75c3958bb76955d0b\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"miFav91GxdfuvqJBrwVE3xa51Ljnhdh9CQ\",\n \"amount\": \"7.999876\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"322e08e35ad4e406c9c6eb2bab850b0869920effc6e2d8c75c3958bb76955d0b\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000124\",\n \"total_input\": \"10.0\",\n \"total_output\": \"9.999876\",\n \"txid\": \"322e08e35ad4e406c9c6eb2bab850b0869920effc6e2d8c75c3958bb76955d0b\"\n }\n}"
}, },
{ {
"title": "Spread LBC between multiple addresses", "title": "Spread LBC between multiple addresses",
"curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"to_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"from_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"amount\": \"1.5\", \"everything\": false, \"outputs\": 2, \"broadcast\": true}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"to_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"from_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"amount\": \"1.5\", \"everything\": false, \"outputs\": 2, \"broadcast\": true}}' http://localhost:5279/",
"lbrynet": "lbrynet account fund --to_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --from_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --amount=1.5 --outputs=2 --broadcast", "lbrynet": "lbrynet account fund --to_account=\"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\" --from_account=\"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\" --amount=1.5 --outputs=2 --broadcast",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"to_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"from_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"amount\": \"1.5\", \"everything\": false, \"outputs\": 2, \"broadcast\": true}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"to_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"from_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"amount\": \"1.5\", \"everything\": false, \"outputs\": 2, \"broadcast\": true}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000133425d1e8dec9d411c1ac0c89763e302d98c8ddcd801e874118559ef57a6fdf4000000006a47304402204b47f264637f415d33f246cab3a0762607c891afa58c065372db68fe91722e8902204ca419606f94c776fc4e525d3920473e7805268ede391c11b9b3ff201020738d0121039e4e4902c26c72fe47684e0fd829dabdb412451e5548c7734d435b35d7c34219ffffffff03c0687804000000001976a914213af899efa6d2a17f13aea3dbaeb51c6e88973288acc0687804000000001976a914213af899efa6d2a17f13aea3dbaeb51c6e88973288ac6cb9fa02000000001976a9146f30574826fed3881a3e5adce19acc50dad431ec88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"myQS3hn3FKdwiw3KDEWoAeVjnh8UMq9gc4\",\n \"amount\": \"2.0\",\n \"confirmations\": 1,\n \"height\": 207,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"f4fda657ef59851174e801d8dc8d8cd902e36397c8c01a1c419dec8d1e5d4233\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"miYfEmWW4EiLLTWwdHm2CfsmuVeKb3WmEu\",\n \"amount\": \"0.75\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"6633a7efa651556b1d4693be2f4bb64dce2c020edd3fe002e7f8343f5cee0935\"\n },\n {\n \"address\": \"miYfEmWW4EiLLTWwdHm2CfsmuVeKb3WmEu\",\n \"amount\": \"0.75\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"6633a7efa651556b1d4693be2f4bb64dce2c020edd3fe002e7f8343f5cee0935\"\n },\n {\n \"address\": \"mqesD8n83hnyjZb7Vj3LisS2KdKauiPo5B\",\n \"amount\": \"0.499859\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 2,\n \"txid\": \"6633a7efa651556b1d4693be2f4bb64dce2c020edd3fe002e7f8343f5cee0935\"\n }\n ],\n \"total_fee\": \"0.000141\",\n \"total_input\": \"2.0\",\n \"total_output\": \"1.999859\",\n \"txid\": \"6633a7efa651556b1d4693be2f4bb64dce2c020edd3fe002e7f8343f5cee0935\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000010b5d9576bb58395cc7d8e2c6ff0e9269080b85ab2bebc6c906e4d45ae3082e32000000006a473044022027556d2dc9851a23f32388bae939b9dcb3bbbc0eada13a6893c11e2c732a22bb022042cdc0a1bc55f6554b5ab178aa5f8563c97c685b2abed8ab2100b5a6fba2dc170121031a13d4232d833e36e9628ad9d350c4b4ca5dae5be868107acdcee81fcf34f260ffffffff03c0687804000000001976a91439a646471e0dbbda463b75d03990ff788a4d4b7e88acc0687804000000001976a91439a646471e0dbbda463b75d03990ff788a4d4b7e88ac6cb9fa02000000001976a91467a44a1754a495f27ecced12c32e2bb3e2adcb0c88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mrLxHmSrMJ2sy21YzCCxpJ1xMH6FcD9XYe\",\n \"amount\": \"2.0\",\n \"confirmations\": 1,\n \"height\": 207,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"322e08e35ad4e406c9c6eb2bab850b0869920effc6e2d8c75c3958bb76955d0b\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mkmmzwkKApoCne9ffHz3af42qxCANjkSPf\",\n \"amount\": \"0.75\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"f81798f055092b7138445901da64745d04dc0836e899f8288ec079a096aebc59\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"mkmmzwkKApoCne9ffHz3af42qxCANjkSPf\",\n \"amount\": \"0.75\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"f81798f055092b7138445901da64745d04dc0836e899f8288ec079a096aebc59\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"mpxxhqkxd1dUvZc9Lm8ZJRDT8EyakqAuhq\",\n \"amount\": \"0.499859\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 2,\n \"txid\": \"f81798f055092b7138445901da64745d04dc0836e899f8288ec079a096aebc59\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000141\",\n \"total_input\": \"2.0\",\n \"total_output\": \"1.999859\",\n \"txid\": \"f81798f055092b7138445901da64745d04dc0836e899f8288ec079a096aebc59\"\n }\n}"
}, },
{ {
"title": "Transfer all LBC to a specified account", "title": "Transfer all LBC to a specified account",
"curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"from_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"everything\": true, \"broadcast\": true}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_fund\", \"params\": {\"from_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"everything\": true, \"broadcast\": true}}' http://localhost:5279/",
"lbrynet": "lbrynet account fund --from_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --everything --broadcast", "lbrynet": "lbrynet account fund --from_account=\"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\" --everything --broadcast",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"from_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"everything\": true, \"broadcast\": true}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"from_account\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"everything\": true, \"broadcast\": true}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000033509ee5c3f34f8e702e03fdd0e022cce4db64b2fbe93461d6b5551a6efa73366020000006a47304402202e06a289dbf051f6687ac0ddafed1d87efc7bf5c6526e4a70ae2bfc141b908260220764fbefedd905fda39324a75622c682207a770abafd0ffb1611050ea0b21103e0121035b2d12d585351417c0a9b1ec174b46c30715958b48f030bfb3ab4bbb711b29d9ffffffff3509ee5c3f34f8e702e03fdd0e022cce4db64b2fbe93461d6b5551a6efa73366000000006b483045022100ca2f96fad25ac1c346d6cb3135a4956fa463ecceef16ca0dd743f30062a6450c02205a81ef76c1b53d4094c49d4614bbe0638280ad32807d836ae2089c2065f2510f0121024cf42b24c238a1c35a9b328197392bb57f77ea333eebc1170c5f51aa978b9859ffffffff3509ee5c3f34f8e702e03fdd0e022cce4db64b2fbe93461d6b5551a6efa73366010000006a47304402206be7da2b4a6705047d824a776bc366365a67796875c3a6b251364d15490b99bd022029f459b69ea1bffed337dea0673e4d7f830b9fc91de066f19f405021c1a7982a0121024cf42b24c238a1c35a9b328197392bb57f77ea333eebc1170c5f51aa978b9859ffffffff015027eb0b000000001976a914079452d5e2339ad67870bc9190877723996504d488ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mqesD8n83hnyjZb7Vj3LisS2KdKauiPo5B\",\n \"amount\": \"0.499859\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 2,\n \"txid\": \"6633a7efa651556b1d4693be2f4bb64dce2c020edd3fe002e7f8343f5cee0935\"\n },\n {\n \"address\": \"miYfEmWW4EiLLTWwdHm2CfsmuVeKb3WmEu\",\n \"amount\": \"0.75\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"6633a7efa651556b1d4693be2f4bb64dce2c020edd3fe002e7f8343f5cee0935\"\n },\n {\n \"address\": \"miYfEmWW4EiLLTWwdHm2CfsmuVeKb3WmEu\",\n \"amount\": \"0.75\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"6633a7efa651556b1d4693be2f4bb64dce2c020edd3fe002e7f8343f5cee0935\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mgD2i6jDWnZ86XCSs3o2h3M4eo8nTftvfF\",\n \"amount\": \"1.999604\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"a84b9382ce08c90e5ba91afb751b9df3a08c5685367276eb4bcceaeedecfe8cb\"\n }\n ],\n \"total_fee\": \"0.000255\",\n \"total_input\": \"1.999859\",\n \"total_output\": \"1.999604\",\n \"txid\": \"a84b9382ce08c90e5ba91afb751b9df3a08c5685367276eb4bcceaeedecfe8cb\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000359bcae96a079c08e28f899e83608dc045d7464da01594438712b0955f09817f8020000006b483045022100a9a35567e2d349da24b180dd05962eb3de355f35835300b31ebaa56f3858b1fa02205926bfe9e02015c799590553edbc81c7b23ced91d9e0ef69e1d1f1fb40cd08df0121026306f10c42aec2d019852cfe6ff2277cb0bb0876461f677b496c5d3e0bd83c21ffffffff59bcae96a079c08e28f899e83608dc045d7464da01594438712b0955f09817f8000000006b483045022100e5b763984e87a60c37fb6808c16a01de08de210f789ae5c6b872afd9856d892d022020f50ae67eebdb74f839fbbce68874fead14e49f796cd2f49c57ae2b2fbd0241012102fbed94068fd5d14ac6729ece5a5f6605e2f7b8b279c8bbddb8e4ef2f72100e10ffffffff59bcae96a079c08e28f899e83608dc045d7464da01594438712b0955f09817f8010000006a473044022033b2c9b8b99c161518fae0dec1990e312f2902ca1e4124e129eb548f4bbf1969022047f5bc5616790d4af0c2ac5fc3a70c1b786d15dac4c4f9756ecb41e668d814ab012102fbed94068fd5d14ac6729ece5a5f6605e2f7b8b279c8bbddb8e4ef2f72100e10ffffffff015027eb0b000000001976a9147f1b577cd3418bf27b2cf928dea222551f2c221a88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mpxxhqkxd1dUvZc9Lm8ZJRDT8EyakqAuhq\",\n \"amount\": \"0.499859\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 2,\n \"txid\": \"f81798f055092b7138445901da64745d04dc0836e899f8288ec079a096aebc59\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"mkmmzwkKApoCne9ffHz3af42qxCANjkSPf\",\n \"amount\": \"0.75\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"f81798f055092b7138445901da64745d04dc0836e899f8288ec079a096aebc59\",\n \"type\": \"payment\"\n },\n {\n \"address\": \"mkmmzwkKApoCne9ffHz3af42qxCANjkSPf\",\n \"amount\": \"0.75\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"f81798f055092b7138445901da64745d04dc0836e899f8288ec079a096aebc59\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"ms72s9utcQbEPnPommZ8xh1LxhkebmboM8\",\n \"amount\": \"1.999604\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"efa06c71b1bab801e10dcc107e97fb5041cd8d8d51c705c31b9910dc1f211b71\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000255\",\n \"total_input\": \"1.999859\",\n \"total_output\": \"1.999604\",\n \"txid\": \"efa06c71b1bab801e10dcc107e97fb5041cd8d8d51c705c31b9910dc1f211b71\"\n }\n}"
} }
] ]
}, },
@ -580,7 +550,7 @@
"curl": "curl -d'{\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet account list", "lbrynet": "lbrynet account list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"lbc_regtest\": [\n {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"certificates\": 0,\n \"coins\": 10.0,\n \"encrypted\": false,\n \"id\": \"mvALAareXFjguvRMvqcdMaDdWZCce51BNE\",\n \"is_default_account\": true,\n \"name\": \"Account #mvALAareXFjguvRMvqcdMaDdWZCce51BNE\",\n \"public_key\": \"tpubD6NzVbkrYhZ4XGVjUTtbTBufc1n9KXvBGHjP9KADXZfodemtsdZTg4pw7x1oHtN5o7mMSYnqLM6sAbDe8p5xCK9ErjJB7oT3BC8mxSZ8vEL\",\n \"satoshis\": 1000000000\n }\n ]\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"lbc_regtest\": [\n {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"certificates\": 0,\n \"coins\": 10.0,\n \"encrypted\": false,\n \"id\": \"mhuyLCoseuom9LNqgVXbws2fkKAs1vDRuX\",\n \"is_default\": true,\n \"name\": \"Account #mhuyLCoseuom9LNqgVXbws2fkKAs1vDRuX\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WaLcDunS5QyfbMRCiiG1AVv737HvPbXRFm3UrfBWb1JuxKRFUJ88VG12JEbWzNkF1v8mnaYZYbCB7HU9Ut34f7uM74fMZPc\",\n \"satoshis\": 1000000000\n }\n ]\n }\n}"
} }
] ]
}, },
@ -627,10 +597,10 @@
"examples": [ "examples": [
{ {
"title": "Remove an account", "title": "Remove an account",
"curl": "curl -d'{\"method\": \"account_remove\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_remove\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"}}' http://localhost:5279/",
"lbrynet": "lbrynet account remove mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA", "lbrynet": "lbrynet account remove mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_remove\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_remove\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555357458.8862276,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPd7T1DYvyijnrKnQG2FtickT7miYaur4toH3gk5P4U2m3aK2pca6AnLXPH4YmQubKooD6ePy65UEydw4T7VUkzfXx4cY9CZc\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WaUo7Cba89SxtovCBb5dC43u4EatL7sHdmJTNUCeeXNukReeyMpRMYxEfJuBQGoXGZCcJi3LDz4mJ3tdvZ9PQKLVjEVBBha\",\n \"seed\": \"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555818980.469442,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPet8Vmrybx3H8ahBP4iyrxppNg2iweUr1scP6t5KJqsBBoZ7VodS6MmdPVaD8wu9ex5eSH3dA52gyzCHJmE9BerZznoEmVz5\",\n \"public_key\": \"tpubD6NzVbkrYhZ4YMAHfWeCMSwF9ihKE4AmY8R9xYmF4keQi6dsWU8u2Mo3ygE1uN2tqjYdZACiAsUK3mJ9QB6CTrxdrdrYHKXNAiJdgGGjP4o\",\n \"seed\": \"tilt arm tent canal barely same equal amateur year still shoulder know\"\n }\n}"
} }
] ]
}, },
@ -651,7 +621,7 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [] "examples": []
}, },
{ {
@ -705,10 +675,10 @@
"examples": [ "examples": [
{ {
"title": "Modify maximum number of times a change address can be reused", "title": "Modify maximum number of times a change address can be reused",
"curl": "curl -d'{\"method\": \"account_set\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"default\": false, \"change_max_uses\": 10}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_set\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"default\": false, \"change_max_uses\": 10}}' http://localhost:5279/",
"lbrynet": "lbrynet account set mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA --change_max_uses=10", "lbrynet": "lbrynet account set mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c --change_max_uses=10",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_set\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"default\": false, \"change_max_uses\": 10}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_set\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\", \"default\": false, \"change_max_uses\": 10}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 10\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555357459.1615155,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPd7T1DYvyijnrKnQG2FtickT7miYaur4toH3gk5P4U2m3aK2pca6AnLXPH4YmQubKooD6ePy65UEydw4T7VUkzfXx4cY9CZc\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WaUo7Cba89SxtovCBb5dC43u4EatL7sHdmJTNUCeeXNukReeyMpRMYxEfJuBQGoXGZCcJi3LDz4mJ3tdvZ9PQKLVjEVBBha\",\n \"seed\": \"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 10\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555818980.6639612,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPet8Vmrybx3H8ahBP4iyrxppNg2iweUr1scP6t5KJqsBBoZ7VodS6MmdPVaD8wu9ex5eSH3dA52gyzCHJmE9BerZznoEmVz5\",\n \"public_key\": \"tpubD6NzVbkrYhZ4YMAHfWeCMSwF9ihKE4AmY8R9xYmF4keQi6dsWU8u2Mo3ygE1uN2tqjYdZACiAsUK3mJ9QB6CTrxdrdrYHKXNAiJdgGGjP4o\",\n \"seed\": \"tilt arm tent canal barely same equal amateur year still shoulder know\"\n }\n}"
} }
] ]
}, },
@ -752,9 +722,9 @@
"examples": [ "examples": [
{ {
"title": "Check if address is mine", "title": "Check if address is mine",
"curl": "curl -d'{\"method\": \"address_is_mine\", \"params\": {\"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"address_is_mine\", \"params\": {\"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\"}}' http://localhost:5279/",
"lbrynet": "lbrynet address is_mine mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw", "lbrynet": "lbrynet address is_mine mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_is_mine\", \"params\": {\"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_is_mine\", \"params\": {\"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}"
} }
] ]
@ -789,14 +759,14 @@
"curl": "curl -d'{\"method\": \"address_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"address_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet address list", "lbrynet": "lbrynet address list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n \"n2nsnf4ANknZXHxu2dcFYRDJgtJfsysd9q\",\n \"mhBovUp3mtBsdYQWrnQnpwwLL7mcaWSuTP\",\n \"mzY5zNxzAP2aYiNCRnfKe5H83jGbdf63ur\",\n \"mgD2i6jDWnZ86XCSs3o2h3M4eo8nTftvfF\",\n \"mnrzQmQptQkqvXCyYbW9K4rKT3hpFhGrmn\",\n \"n2C1PDnpJbXKYmEUGWcyDXKfetmScRXKhN\",\n \"mg7RNSr3TxAKMMcrs67MdzxNwmQKjmunXD\",\n \"mzCXhmpJCsVE154b9J6q7VZiQnpAbA1QwJ\",\n \"n4Ae4SyqZAVfD1MfQ9RxFndRA4DjUuXqF2\",\n \"mjJaLownqCpcrKyCtXFxma1HybbT1XKVkD\",\n \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"mymJtEqGU93RiHZCPjMi8myUS5dZR4ifAb\",\n \"mwyxViE5mrXMPAVfXfhRCveJxmwygEx62K\",\n \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"n4ioiBGYEUN1EiPcULKNpcn7VUyFdrVtAF\",\n \"mrCk27p8cv1VKohy8QYK8xwKwdpW5wN1Rm\",\n \"mj3Pxy9BH8yHVX79UZjP6pEy24RpWxg7xL\",\n \"miDStxDH4i8xtyLDTAPYkfxH8Fo4PR4kre\",\n \"mhUuHmSvYUhmkRKjKMpjJmWpgLouDYw9Jj\",\n \"msBKWA6Bub5Tcwe3mFUB9rKuAxKsXeVmZX\",\n \"mpoD2Rkg2UEhMePVjKswcBeTiEgtJpHRTJ\",\n \"n2rprnyC4ektLMcDo4Ta3CaL1LQtTYf8cB\",\n \"moko42m6hNZ5EbPvS2m2oqBAjZqRAENiwm\",\n \"mwi9JCui9GmnZxTFVPmGHaX5oMcFYV2oFz\",\n \"mwFP2Za1zNxMC3YcvbkwsTZc57aPL6DqYe\",\n \"mmq8WV8hq5wE1xURqxJ6DB82K8U2otsxCo\",\n \"mg1Tpi5hmRLmW1cA7pqfnTDd3MabTsM9k1\"\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n \"miFav91GxdfuvqJBrwVE3xa51Ljnhdh9CQ\",\n \"ms72s9utcQbEPnPommZ8xh1LxhkebmboM8\",\n \"mu1oM4wC1KAYD9LJMdMXxHdmvagfCVM8yg\",\n \"mijc1SWk3w2w2f8Gtj6QUwT7DzijJRDYhv\",\n \"moqryXTjZNZmfJfDoc6wMZyDz4Cgxux6yr\",\n \"mxsHYdMzW3y6xbSw7ox9w21zVzBe9DjYJS\",\n \"mpFErYoPr4vQGkehF4n4j6K3t3Z1Jmde7u\",\n \"mpMtjiBW6nMfUpovUHtRFLMzU3e1rjbVpY\",\n \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"mfwWJ3WxpZroEig9GkDAnoLGfE9GnDN89t\",\n \"mwoJy1fSQncKmEVAbF5PainTJnYJ7D7Nqc\",\n \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"mnJ28rQkzSEzqq5oLz63JFNXD1Yrg89QMS\",\n \"n2ETGpUd7XuQuRv46XaYzYCvsDd25S7nWT\",\n \"mj7xDsDR5s96h1PF55dkx2p44qUDmGPHTd\",\n \"mrBqoJ6bXSAwYGeK5pwsZ56RB14uAuoV5w\",\n \"n3L6o1D9W8yjTkNEjLVrYxEcEniESBEgMS\",\n \"n4dQD4mzJMBV3f7QedfqhJU9uqcs8Zuf62\",\n \"mzxbaeqnUENP1cH8AKgiw9vo3FJaYGbPaN\",\n \"mo5TpqwNNzPCLoxnjw7qRo5FJmFBUzY43r\",\n \"n2kgkQcsQnJZw2bd2fjEkJgud3vWeibGUg\",\n \"mg1zzkjempX9BjwVghNNesqKxCcqR6prGe\",\n \"n2b3FJP2rqsUYdd6d61ReZvGKxsJ16NzGV\",\n \"mqp4PY2QX23JRrQBCtnyuX3apds1ZATYNA\",\n \"mfpTkn9LMBWdQhzs6ebsoxA6fFJVdtweoc\",\n \"n4GHZV5wPHTLBECP7rsyrMf5yXYPBKuU2x\",\n \"mtmysME18wkZaBKLAXVAnBSHKKMtKTwHcb\"\n ]\n}"
}, },
{ {
"title": "List addresses in specified account", "title": "List addresses in specified account",
"curl": "curl -d'{\"method\": \"address_list\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"address_list\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"}}' http://localhost:5279/",
"lbrynet": "lbrynet address list --account_id=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"", "lbrynet": "lbrynet address list --account_id=\"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_list\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_list\", \"params\": {\"account_id\": \"mvzMHLMTcJy2P9AvukWmNNfPBoviCuv13c\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n \"mj6NW78mFdeL2AGCHXDRx89VHzW8gdEn5U\",\n \"mhUAvJDNed5buva7yKfnZvqEZY1PRKwZin\",\n \"n3pS3u67g6SADP8v52GdUc1RLtHqQVvydp\",\n \"msWwtJiY2xiEVzt6fRb1so9ZZxGmGdUN2m\",\n \"mvbjHroeUHVxAJrjB4aidEVzdqYqDYvUhb\",\n \"mmt3bVAumu2StceZisy2xXDTeSdYyezdtC\",\n \"mzKyJEWfVuif3oxrQA9og3YAgoqM9nv6rr\",\n \"mxZWAt2z2Ltagq4Pip8oVGLbxE7AxJurq5\",\n \"miNCGEj4yjnPLtxxx57NJeFnv1oXrB9xmi\",\n \"mzF1AJ1xNXECABPm5av6oKBYBv2gHJEaGP\",\n \"mg44ameXggwfuQWnDpLLJ5JE5yRWitycSu\",\n \"mzRP4VN9snJtAH7BcXJWATcZ3MfP6e647Y\",\n \"n47wSKsG2gvnrD4DMWMJSDtoMNxoxfHbUo\",\n \"mvxkynZEjcYUq9PTXnHrSV9uecC9iUKcL6\",\n \"mhEks6nfBVDSd38oX9wgBNwjLSztm3Dncz\",\n \"mzN2iufd7ArDQySN2HXVTHFd7ALrjt2yRX\",\n \"n37H5y3Vn8ihE26TdZvucVpS8q3aDJueTD\",\n \"mgipSnUEpnGGTeRA6PauG1SjHExgSUzKbZ\",\n \"mtGNBDd9tjZN4qgtCnYBnsBtY6z2tisbms\",\n \"miUhuBD4A2DiK8ozFvwFoD8rxRq4J3HEif\",\n \"mkxpxVG77CyBNaXYKDQW2ZSbVXGLeyVzFN\",\n \"mjNVYozPqvCbQhvRaDWwfYuoHKnUJPpPRz\",\n \"myQS3hn3FKdwiw3KDEWoAeVjnh8UMq9gc4\",\n \"mv6Z8DAYbFicDJYWRWjkTsKDuFVsqSBSHy\",\n \"mqesD8n83hnyjZb7Vj3LisS2KdKauiPo5B\",\n \"mpRpNJQDBhGWyPUyhndBSaQNsR6nLWLo7R\"\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n \"monTPcFivBM7E4XkCLPKjMhdKtq9LSwKVn\",\n \"n42yAXj8XvkF7yuzqd2qXFjeV3psLZRojf\",\n \"mvcV1zBcq2VxYkjvXHiJVnfqXFCbxAc95Z\",\n \"mnGGgHnfuVpriGY3LADa4dttrborpjv9PE\",\n \"mxHn4LjA2EJUbeqngbmudt3EXrVwZTvpXG\",\n \"mrh4BWFrmsWczh44Ajmx9e4RW3KeWRtzD6\",\n \"mmTTccma1iZUG32EmL6si3AMvpFEgnp9Vj\",\n \"mioYEF1ygrrdEAAxGueygvPekFpvRcYGXS\",\n \"mkarumLDBB9HM97buKgVqEpwCFiLdj9JdC\",\n \"miKKTr9t98JAgQEK31XndsFcSa61vM7aic\",\n \"mpCyi8HBUDsR8FsHRWhbEBp3cmzbHLvUS4\",\n \"mwTY9nRtQ66UGMc8EG5z3f2gHedZk8rtjr\",\n \"mxHPDmRihDCJnPJnQ1HDyGN7aw8UuEpFT4\",\n \"mrKXZRTnMXdJLoT4WmNZeNragNnA7jwrRv\",\n \"n1KkY1Cech1uZr9qhY4Xwv1iLtfFAFEZ5k\",\n \"n4U1ZVAtZtpYivZ7cEQeXyz2DYfusoypPe\",\n \"mtdsfTWEb9ss6qynCjr4hutM6fxcdX5NTU\",\n \"mooJ4j2vwMzBCiscHKNXV9zn4AH22mZcTj\",\n \"moHXKBPc5iHLk2Jd2mRgYrv9ReHC9pVVAY\",\n \"mwaNnv8ArmKuNYCUeErYyavoJSmhkeDAJR\",\n \"mrLxHmSrMJ2sy21YzCCxpJ1xMH6FcD9XYe\",\n \"mxhxQpqmFvt64VQL1LqRuwxVuB2HH8mR2D\",\n \"mmjrPBKV3bFHDEEcu2SWktKSE5eSkuUmyB\",\n \"mxG6Rn8tmEvJhnWqSdr1YyKhQeNwxifhMo\",\n \"mpxxhqkxd1dUvZc9Lm8ZJRDT8EyakqAuhq\",\n \"mkmmzwkKApoCne9ffHz3af42qxCANjkSPf\"\n ]\n}"
} }
] ]
}, },
@ -818,7 +788,7 @@
"curl": "curl -d'{\"method\": \"address_unused\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"address_unused\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet address unused", "lbrynet": "lbrynet address unused",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_unused\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_unused\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\"\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\"\n}"
} }
] ]
} }
@ -868,10 +838,10 @@
"examples": [ "examples": [
{ {
"title": "Delete a blob", "title": "Delete a blob",
"curl": "curl -d'{\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"4f9784f06bc5f2641c0f585683a294c4110ec90313bca1c0516723bbc0eec9139037090044c1daa81ff123ed6c76f3ce\"}}' http://localhost:5279/",
"lbrynet": "lbrynet blob delete bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2", "lbrynet": "lbrynet blob delete 4f9784f06bc5f2641c0f585683a294c4110ec90313bca1c0516723bbc0eec9139037090044c1daa81ff123ed6c76f3ce",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"4f9784f06bc5f2641c0f585683a294c4110ec90313bca1c0516723bbc0eec9139037090044c1daa81ff123ed6c76f3ce\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"Deleted bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"Deleted 4f9784f06bc5f2641c0f585683a294c4110ec90313bca1c0516723bbc0eec9139037090044c1daa81ff123ed6c76f3ce\"\n}"
} }
] ]
}, },
@ -949,7 +919,7 @@
"curl": "curl -d'{\"method\": \"blob_list\", \"params\": {\"needed\": false, \"finished\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"blob_list\", \"params\": {\"needed\": false, \"finished\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet blob list", "lbrynet": "lbrynet blob list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"blob_list\", \"params\": {\"needed\": false, \"finished\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"blob_list\", \"params\": {\"needed\": false, \"finished\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\",\n \"9b3f8db193bb00bca690ad923081e6ad276f336c7f70495e8ed2b3f5f5c5acd8a609b411f12aa880344f10580ae1be37\"\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n \"4f9784f06bc5f2641c0f585683a294c4110ec90313bca1c0516723bbc0eec9139037090044c1daa81ff123ed6c76f3ce\",\n \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\"\n ]\n}"
} }
] ]
}, },
@ -1020,14 +990,14 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Abandon a channel claim", "title": "Abandon a channel claim",
"curl": "curl -d'{\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet channel abandon 7e7b2f61a7166876ba28e34c415447072a4d13bd", "lbrynet": "lbrynet channel abandon ceae903e6aa88e85688c01b2e988418613087fbd",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"preview\": false, \"blocking\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"preview\": false, \"blocking\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001b27e81dc327d0a5be390fd1e74ea9272b304581e0f8ebb2eef6b8eeb9e3bc7c1000000006b483045022100bd547f6adee7a3716b31481c3ab5e47492316213d20127a12510beb890f1f2cb0220262a77d480eae3825c7d4f7e0cabba259955523fb59c9fee41390a35b003c391012102cf6a0ce8142a657428c58a15e6a967b9472772052f1e7c777df78367b78ce422ffffffff0134b7f505000000001976a91412515c1775f8f73056e94e015391547f73d5043d88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": 4,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mhBovUp3mtBsdYQWrnQnpwwLL7mcaWSuTP\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"ad967ea34df5899acefef7e1e1594d52ef4f89f6333a68e0641da6c3d1718ac1\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"ad967ea34df5899acefef7e1e1594d52ef4f89f6333a68e0641da6c3d1718ac1\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000198c0b7f5f36c1f1b84a004d5b0d6ee746945d9406e66840a8d416927e33bd325000000006b483045022100bd808f43469b732afde15f710ee966b2fe30002eeb52779dc0e234f6d587230102207631014884b1e7f6499afb39ba4c08f8881ff4d83a51dc088beb0e40c72bd0b5012103f3f47961721802cc99c2a3953f45dc43468b062ffb70a6f6480b33095172f7adffffffff0134b7f505000000001976a914223eccf965026fa49f3608f3380ef345b766791688ac00000000\",\n \"inputs\": [\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"update\",\n \"confirmations\": 4,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mie2W3WNWFtaDU8Zv4tPdWfv7kdEKAuhjZ\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"957e8a74d5dc16faff74447ef5c1a43c5507053066aacd2c95bd3cd0e69a003a\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"957e8a74d5dc16faff74447ef5c1a43c5507053066aacd2c95bd3cd0e69a003a\"\n }\n}"
} }
] ]
}, },
@ -1065,6 +1035,12 @@
"description": "description of the publication", "description": "description of the publication",
"is_required": false "is_required": false
}, },
{
"name": "featured",
"type": "list",
"description": "claim_ids of featured content in channel",
"is_required": false
},
{ {
"name": "tags", "name": "tags",
"type": "list", "type": "list",
@ -1084,15 +1060,15 @@
"is_required": false "is_required": false
}, },
{ {
"name": "contact_email", "name": "email",
"type": "str", "type": "str",
"description": "email of channel owner", "description": "email of channel owner",
"is_required": false "is_required": false
}, },
{ {
"name": "homepage_url", "name": "website_url",
"type": "str", "type": "str",
"description": "homepage url", "description": "website url",
"is_required": false "is_required": false
}, },
{ {
@ -1126,14 +1102,14 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Create a channel claim", "title": "Create a channel claim",
"curl": "curl -d'{\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"featured\": [], \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet channel create @channel 1.0", "lbrynet": "lbrynet channel create @channel 1.0",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"featured\": [], \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000133425d1e8dec9d411c1ac0c89763e302d98c8ddcd801e874118559ef57a6fdf4010000006b483045022100cc629b679f7c88d5ceb6c11a53aa907db1853752be3a21d32939c262d476bd5402202c809f8a985dd27b6b46365124c4e685e56c4f9629bda70e48550fdb716bf58f012102a5e5ec59d7a1af554fe6bc6352c3850403d97d50b5beebb035e22bcfb7a1d1baffffffff0200e1f5050000000084b508406368616e6e656c4c5d00125a0a583056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa46d7576a914c6af87c7bce7707f4f25ecfc555ca21f52f34d8788acc462a029000000001976a91409190768d1748bf13e71992a98bc339d1c7147e688ac00000000\",\n \"inputs\": [\n {\n \"address\": \"n2nsnf4ANknZXHxu2dcFYRDJgtJfsysd9q\",\n \"amount\": \"7.999876\",\n \"confirmations\": 2,\n \"height\": 207,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"f4fda657ef59851174e801d8dc8d8cd902e36397c8c01a1c419dec8d1e5d4233\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"fab9d2d79324431033592bf51419c978f669db7b4195d32e1e0a1579ba53cceb\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\"\n }\n }\n },\n {\n \"address\": \"mgM4MpdJQCQibrqnXdtVxVztFV3AT9iQph\",\n \"amount\": \"6.983769\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"fab9d2d79324431033592bf51419c978f669db7b4195d32e1e0a1579ba53cceb\"\n }\n ],\n \"total_fee\": \"0.016107\",\n \"total_input\": \"7.999876\",\n \"total_output\": \"7.983769\",\n \"txid\": \"fab9d2d79324431033592bf51419c978f669db7b4195d32e1e0a1579ba53cceb\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000010b5d9576bb58395cc7d8e2c6ff0e9269080b85ab2bebc6c906e4d45ae3082e32010000006a47304402204cfa852c946c52f21a03a96b6d1701f9887f67bdbbbdb07a5c34b26004d9ade202201188b2419a36e7aec5e3c394003ca9f5a5ec3757e5e7091945f2860fbc95a55d0121039b19986f186cb740693b6b9e262f60a6b7036d25c526d5c2108c10aefb9d4f70ffffffff0200e1f5050000000084b508406368616e6e656c4c5d00125a0a583056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c685976d7576a914829737aec8d3e316b804ab384de653cdeb23c82a88acc462a029000000001976a914be5287181fc0c27adc52fbd615dcfb4339f39fa888ac00000000\",\n \"inputs\": [\n {\n \"address\": \"miFav91GxdfuvqJBrwVE3xa51Ljnhdh9CQ\",\n \"amount\": \"7.999876\",\n \"confirmations\": 2,\n \"height\": 207,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"322e08e35ad4e406c9c6eb2bab850b0869920effc6e2d8c75c3958bb76955d0b\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"fea985bede34e9790a4c77d5f8314194abf2e1a065e67550b7dd5ceb888dc029\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\"\n }\n },\n {\n \"address\": \"mxsHYdMzW3y6xbSw7ox9w21zVzBe9DjYJS\",\n \"amount\": \"6.983769\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"fea985bede34e9790a4c77d5f8314194abf2e1a065e67550b7dd5ceb888dc029\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.016107\",\n \"total_input\": \"7.999876\",\n \"total_output\": \"7.983769\",\n \"txid\": \"fea985bede34e9790a4c77d5f8314194abf2e1a065e67550b7dd5ceb888dc029\"\n }\n}"
} }
] ]
}, },
@ -1188,21 +1164,21 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ]\n }",
"examples": [ "examples": [
{ {
"title": "List your channel claims", "title": "List your channel claims",
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet channel list", "lbrynet": "lbrynet channel list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"fab9d2d79324431033592bf51419c978f669db7b4195d32e1e0a1579ba53cceb\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\"\n }\n }\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"fea985bede34e9790a4c77d5f8314194abf2e1a065e67550b7dd5ceb888dc029\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\"\n }\n }\n ]\n}"
}, },
{ {
"title": "Paginate your channel claims", "title": "Paginate your channel claims",
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"lbrynet": "lbrynet channel list --page=1 --page_size=20", "lbrynet": "lbrynet channel list --page=1 --page_size=20",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"fab9d2d79324431033592bf51419c978f669db7b4195d32e1e0a1579ba53cceb\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"fea985bede34e9790a4c77d5f8314194abf2e1a065e67550b7dd5ceb888dc029\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\"\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}"
} }
] ]
}, },
@ -1234,6 +1210,18 @@
"description": "description of the publication", "description": "description of the publication",
"is_required": false "is_required": false
}, },
{
"name": "clear_featured",
"type": "bool",
"description": "clear existing featured content (prior to adding new ones)",
"is_required": false
},
{
"name": "featured",
"type": "list",
"description": "claim_ids of featured content in channel",
"is_required": false
},
{ {
"name": "clear_tags", "name": "clear_tags",
"type": "bool", "type": "bool",
@ -1271,15 +1259,15 @@
"is_required": false "is_required": false
}, },
{ {
"name": "contact_email", "name": "email",
"type": "str", "type": "str",
"description": "email of channel owner", "description": "email of channel owner",
"is_required": false "is_required": false
}, },
{ {
"name": "homepage_url", "name": "website_url",
"type": "str", "type": "str",
"description": "homepage url", "description": "website url",
"is_required": false "is_required": false
}, },
{ {
@ -1319,14 +1307,14 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Update a channel claim", "title": "Update a channel claim",
"curl": "curl -d'{\"method\": \"channel_update\", \"params\": {\"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"title\": \"New Channel\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_update\", \"params\": {\"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"title\": \"New Channel\", \"featured\": [], \"clear_featured\": false, \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet channel update 7e7b2f61a7166876ba28e34c415447072a4d13bd --title=\"New Channel\"", "lbrynet": "lbrynet channel update ceae903e6aa88e85688c01b2e988418613087fbd --title=\"New Channel\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_update\", \"params\": {\"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"title\": \"New Channel\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_update\", \"params\": {\"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"title\": \"New Channel\", \"featured\": [], \"clear_featured\": false, \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000002ebcc53ba79150a1e2ed395417bdb69f678c91914f52b593310432493d7d2b9fa000000006a47304402207df8a18697427cafbf395718e43507b16074aaf312780c26f07415829b79197302204406d1364a480c57e4c27a8b678dd52092289df352eb670d902e156a4e806eeb012102cf6a0ce8142a657428c58a15e6a967b9472772052f1e7c777df78367b78ce422ffffffffcbe8cfdeeeeacc4beb76723685568ca0f39d1b75fb1aa95b0ec908ce82934ba8000000006b4830450221009e888e4de43f4a8b76840deb124eb8a96320b575c4c83644ec17f27164fc49b402203288bf3f8844403c6914b7583a4cf3368b2f3395cc486f1c70c7ec295d39b768012102244373b09142e9731e6b3a3b27f277ff0ecf67fe9084a81b6021f505772d6ec4ffffffff0200e1f50500000000a6b708406368616e6e656c14bd134d2a074754414ce328ba766816a7612f7b7e4c6a0012670a583056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4120b4e6577204368616e6e656c6d6d76a914c6af87c7bce7707f4f25ecfc555ca21f52f34d8788ac6ebeea0b000000001976a914d07cb6844ee0772ef7b2112ba576855a1737b11f88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"fab9d2d79324431033592bf51419c978f669db7b4195d32e1e0a1579ba53cceb\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\",\n \"title\": \"New Channel\"\n }\n }\n },\n {\n \"address\": \"mgD2i6jDWnZ86XCSs3o2h3M4eo8nTftvfF\",\n \"amount\": \"1.999604\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"a84b9382ce08c90e5ba91afb751b9df3a08c5685367276eb4bcceaeedecfe8cb\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\",\n \"title\": \"New Channel\"\n }\n }\n },\n {\n \"address\": \"mzXLFAQ962F5sZTcvKgKmguLzWKCB7Dpe1\",\n \"amount\": \"1.9993355\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\"\n }\n ],\n \"total_fee\": \"0.0002685\",\n \"total_input\": \"2.999604\",\n \"total_output\": \"2.9993355\",\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000229c08d88eb5cddb75075e665a0e1f2ab944131f8d5774c0a79e934debe85a9fe000000006946304302207c910cd2b1bd6a509b864198479426b750f944d1ceedd2daa079fa13e7ccf23e021f5ec72849e60cb1f7d84af6ce5d5ed15a374501ee7ef0c3ef559b1a717098db012103f3f47961721802cc99c2a3953f45dc43468b062ffb70a6f6480b33095172f7adffffffff711b211fdc10991bc305c7518d8dcd4150fb977e10cc0de101b8bab1716ca0ef000000006a47304402201f1f20051a9a472f0df9a07aef60f0de073adca85f04c88d3422ad905b5e4a8d022047792d00f44d2bfab78d2649686734fc0c01dab8903d71c11f4f8d28068a7b15012103a2e364eb583a6a65f7190a30c2098feddea863f26e581fa25a8059002a5d1806ffffffff0200e1f50500000000a6b708406368616e6e656c14bd7f0813864188e9b2018c68858ea86a3e90aece4c6a00125a0a583056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597420b4e6577204368616e6e656c6d6d76a914829737aec8d3e316b804ab384de653cdeb23c82a88ac6ebeea0b000000001976a91471e60a7dff9e287d105f7841bdbf873ab55a05b088ac00000000\",\n \"inputs\": [\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"fea985bede34e9790a4c77d5f8314194abf2e1a065e67550b7dd5ceb888dc029\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\"\n }\n },\n {\n \"address\": \"ms72s9utcQbEPnPommZ8xh1LxhkebmboM8\",\n \"amount\": \"1.999604\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"efa06c71b1bab801e10dcc107e97fb5041cd8d8d51c705c31b9910dc1f211b71\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"update\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n {\n \"address\": \"mquCEFxZWnSiLhjphENiN8se4WTiPQxVHn\",\n \"amount\": \"1.9993355\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.0002685\",\n \"total_input\": \"2.999604\",\n \"total_output\": \"2.9993355\",\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\"\n }\n}"
} }
] ]
} }
@ -1358,21 +1346,21 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ]\n }",
"examples": [ "examples": [
{ {
"title": "List all your claims", "title": "List all your claims",
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"claim_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet claim list", "lbrynet": "lbrynet claim list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"type\": \"update\",\n \"valid_signature\": true,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n },\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": 3,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\",\n \"title\": \"New Channel\"\n }\n }\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_channel_signature_valid\": true,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signing_channel\": {\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"name\": \"@channel\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n \"sub_type\": \"stream\",\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n },\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"update\",\n \"confirmations\": 3,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n }\n ]\n}"
}, },
{ {
"title": "Paginate your claims", "title": "Paginate your claims",
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"lbrynet": "lbrynet claim list --page=1 --page_size=20", "lbrynet": "lbrynet claim list --page=1 --page_size=20",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"type\": \"update\",\n \"valid_signature\": true,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n },\n {\n \"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\",\n \"amount\": \"1.0\",\n \"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"confirmations\": 3,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004070679333d20f6dc2147944f681c4c20a29cb30e43dd3a445edb601b09194bd6a6566b3cc3fbf1847be880dd6a490b0bc1e845d61deb12622b7b99d2c4706fa4\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_channel_signature_valid\": true,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signing_channel\": {\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"name\": \"@channel\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n \"sub_type\": \"stream\",\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n },\n {\n \"address\": \"msRTHmYZQF6Mc6ce62mt3JsA7FiDM6yG5w\",\n \"amount\": \"1.0\",\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"claim_op\": \"update\",\n \"confirmations\": 3,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"sub_type\": \"channel\",\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\",\n \"type\": \"claim\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}"
} }
] ]
}, },
@ -1429,21 +1417,21 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ]\n }",
"examples": [ "examples": [
{ {
"title": "Search for all claims in channel", "title": "Search for all claims in channel",
"curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"channel_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"winning\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"channel_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"winning\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet claim search --channel_id=\"7e7b2f61a7166876ba28e34c415447072a4d13bd\"", "lbrynet": "lbrynet claim search --channel_id=\"ceae903e6aa88e85688c01b2e988418613087fbd\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_search\", \"params\": {\"channel_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"winning\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_search\", \"params\": {\"channel_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"winning\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"absolute_channel_position\": 0,\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 1,\n \"effective_amount\": \"1.0\",\n \"has_signature\": true,\n \"height\": 212,\n \"hex\": \"01bd134d2a074754414ce328ba766816a7612f7b7e2c5378c71cf936592d6ab469cd5bdcbb3daddf22900659ace60f2c9aedc9d979717af910cf82c3c6109d59d8870361da5fb952e98a84ee93727ceb94cd0419ef0a500a30bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d26a186170706c69636174696f6e2f6f637465742d73747265616d7202100b\",\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"signature_is_valid\": true,\n \"supports\": [],\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"valid_at_height\": 212,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 10,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"absolute_channel_position\": 0,\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 1,\n \"effective_amount\": \"1.0\",\n \"has_signature\": true,\n \"height\": 212,\n \"hex\": \"01bd7f0813864188e9b2018c68858ea86a3e90aecee46e57b139165fddc382a7f502edc7a07b675130a4435cb15726d189ae5768f31be20e8db061c5fe1ae3b7231e0e8bb2c7100587f018c44aa1d55ba245750ff80a7f0a7d0a20b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9120b746d707665776b6630306e180b22186170706c69636174696f6e2f6f637465742d73747265616d32307b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signature_is_valid\": true,\n \"supports\": [],\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"valid_at_height\": 212,\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 10,\n \"total_pages\": 1\n }\n}"
}, },
{ {
"title": "Search for claims matching a name", "title": "Search for claims matching a name",
"curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"name\": \"astream\", \"winning\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"name\": \"astream\", \"winning\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet claim search --name=\"astream\"", "lbrynet": "lbrynet claim search --name=\"astream\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_search\", \"params\": {\"name\": \"astream\", \"winning\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_search\", \"params\": {\"name\": \"astream\", \"winning\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 1,\n \"effective_amount\": \"1.0\",\n \"has_signature\": true,\n \"height\": 212,\n \"hex\": \"01bd134d2a074754414ce328ba766816a7612f7b7e2c5378c71cf936592d6ab469cd5bdcbb3daddf22900659ace60f2c9aedc9d979717af910cf82c3c6109d59d8870361da5fb952e98a84ee93727ceb94cd0419ef0a500a30bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d26a186170706c69636174696f6e2f6f637465742d73747265616d7202100b\",\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"signature_is_valid\": true,\n \"supports\": [],\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"valid_at_height\": 212,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 1,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_sequence\": -1,\n \"decoded_claim\": true,\n \"depth\": 1,\n \"effective_amount\": \"1.0\",\n \"has_signature\": true,\n \"height\": 212,\n \"hex\": \"01bd7f0813864188e9b2018c68858ea86a3e90aecee46e57b139165fddc382a7f502edc7a07b675130a4435cb15726d189ae5768f31be20e8db061c5fe1ae3b7231e0e8bb2c7100587f018c44aa1d55ba245750ff80a7f0a7d0a20b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9120b746d707665776b6630306e180b22186170706c69636174696f6e2f6f637465742d73747265616d32307b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"lbry://astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signature_is_valid\": true,\n \"supports\": [],\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"valid_at_height\": 212,\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 1,\n \"total_pages\": 1\n }\n}"
} }
] ]
} }
@ -1590,9 +1578,9 @@
"examples": [ "examples": [
{ {
"title": "Delete a file", "title": "Delete a file",
"curl": "curl -d'{\"method\": \"file_delete\", \"params\": {\"delete_from_download_dir\": false, \"delete_all\": false, \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"file_delete\", \"params\": {\"delete_from_download_dir\": false, \"delete_all\": false, \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\"}}' http://localhost:5279/",
"lbrynet": "lbrynet file delete --claim_id=\"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"", "lbrynet": "lbrynet file delete --claim_id=\"70af4076385dbba0fe0b400056f407202caa057a\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_delete\", \"params\": {\"delete_from_download_dir\": false, \"delete_all\": false, \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_delete\", \"params\": {\"delete_from_download_dir\": false, \"delete_all\": false, \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}"
} }
] ]
@ -1699,14 +1687,14 @@
"curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"reverse\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"reverse\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet file list", "lbrynet": "lbrynet file list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_list\", \"params\": {\"reverse\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_list\", \"params\": {\"reverse\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"download_directory\": \"/tmp\",\n \"download_path\": null,\n \"file_name\": \"tmp9rj4qtvp\",\n \"key\": \"a63516247749143e585eee43f327025d\",\n \"metadata\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"vAo0GFRQRfs45GXJS7w9+YWWyG0UHeOkYVl2YvPOms62hyPssxOoHTNXosMvkWLS\"\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86:0\",\n \"points_paid\": 0.0,\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"fdda172ddbd4dcc4aa530b55810bde2934acfe5087364548b718aa66c10fea076e4d7284b204dc67685ad160fee14053\",\n \"stream_name\": \"tmp9rj4qtvp\",\n \"suggested_file_name\": \"tmp9rj4qtvp\",\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"tx\": null,\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"written_bytes\": null\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"download_directory\": \"/tmp\",\n \"download_path\": null,\n \"file_name\": \"tmpvewkf00n\",\n \"key\": \"44dbf905146d75f49382c4010138014f\",\n \"metadata\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768:0\",\n \"points_paid\": 0.0,\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"3bcc0eec6f0fa68558ac1fa6f1b0ffef340f97e183c21d875d4c3efe67e55b4342da27fc159823cc7f7546dd22eee020\",\n \"stream_name\": \"tmpvewkf00n\",\n \"suggested_file_name\": \"tmpvewkf00n\",\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"tx\": null,\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"written_bytes\": null\n }\n ]\n}"
}, },
{ {
"title": "List files matching a parameter", "title": "List files matching a parameter",
"curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"reverse\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\", \"reverse\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet file list --claim_id=\"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"", "lbrynet": "lbrynet file list --claim_id=\"70af4076385dbba0fe0b400056f407202caa057a\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_list\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"reverse\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_list\", \"params\": {\"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\", \"reverse\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"download_directory\": \"/tmp\",\n \"download_path\": null,\n \"file_name\": \"tmp9rj4qtvp\",\n \"key\": \"a63516247749143e585eee43f327025d\",\n \"metadata\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"vAo0GFRQRfs45GXJS7w9+YWWyG0UHeOkYVl2YvPOms62hyPssxOoHTNXosMvkWLS\"\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86:0\",\n \"points_paid\": 0.0,\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"fdda172ddbd4dcc4aa530b55810bde2934acfe5087364548b718aa66c10fea076e4d7284b204dc67685ad160fee14053\",\n \"stream_name\": \"tmp9rj4qtvp\",\n \"suggested_file_name\": \"tmp9rj4qtvp\",\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"tx\": null,\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"written_bytes\": null\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"blobs_completed\": 1,\n \"blobs_in_stream\": 1,\n \"blobs_remaining\": 0,\n \"channel_claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_name\": \"astream\",\n \"completed\": true,\n \"download_directory\": \"/tmp\",\n \"download_path\": null,\n \"file_name\": \"tmpvewkf00n\",\n \"key\": \"44dbf905146d75f49382c4010138014f\",\n \"metadata\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n },\n \"mime_type\": \"application/octet-stream\",\n \"nout\": 0,\n \"outpoint\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768:0\",\n \"points_paid\": 0.0,\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"status\": \"finished\",\n \"stopped\": true,\n \"stream_hash\": \"3bcc0eec6f0fa68558ac1fa6f1b0ffef340f97e183c21d875d4c3efe67e55b4342da27fc159823cc7f7546dd22eee020\",\n \"stream_name\": \"tmpvewkf00n\",\n \"suggested_file_name\": \"tmpvewkf00n\",\n \"total_bytes\": 16,\n \"total_bytes_lower_bound\": 0,\n \"tx\": null,\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"written_bytes\": null\n }\n ]\n}"
} }
] ]
}, },
@ -1834,7 +1822,7 @@
"curl": "curl -d'{\"method\": \"settings_get\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"settings_get\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet settings get", "lbrynet": "lbrynet settings get",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"settings_get\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"settings_get\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"announce_head_and_sd_only\": true,\n \"api\": \"localhost:5279\",\n \"blob_download_timeout\": 30.0,\n \"blockchain_name\": \"lbrycrd_regtest\",\n \"cache_time\": 150,\n \"comment_server\": \"http://comments.lbry.com:2903/api\",\n \"components_to_skip\": [\n \"dht\",\n \"upnp\",\n \"hash_announcer\",\n \"peer_protocol_server\"\n ],\n \"concurrent_blob_announcers\": 10,\n \"concurrent_reflector_uploads\": 10,\n \"config\": \"/home/jessop/.lbrynet/daemon_settings.yml\",\n \"data_dir\": \"/tmp/tmprk7omj7u\",\n \"download_dir\": \"/tmp/tmprk7omj7u\",\n \"download_timeout\": 30.0,\n \"fixed_peer_delay\": 2.0,\n \"known_dht_nodes\": [],\n \"lbryum_servers\": [\n [\n \"127.0.0.1\",\n 50001\n ]\n ],\n \"max_connections_per_download\": 8,\n \"max_key_fee\": {\n \"amount\": 50.0,\n \"currency\": \"USD\"\n },\n \"network_interface\": \"0.0.0.0\",\n \"node_rpc_timeout\": 5.0,\n \"peer_connect_timeout\": 2.0,\n \"reflect_streams\": true,\n \"reflector_servers\": [\n [\n \"127.0.0.1\",\n 5566\n ]\n ],\n \"s3_headers_depth\": 960,\n \"share_usage_data\": false,\n \"split_buckets_under_index\": 1,\n \"tcp_port\": 3333,\n \"udp_port\": 4444,\n \"use_upnp\": false,\n \"wallet_dir\": \"/tmp/tmprk7omj7u\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"announce_head_and_sd_only\": true,\n \"api\": \"localhost:5279\",\n \"blob_download_timeout\": 30.0,\n \"blockchain_name\": \"lbrycrd_regtest\",\n \"cache_time\": 150,\n \"comment_server\": \"http://comments.lbry.com:2903/api\",\n \"components_to_skip\": [\n \"dht\",\n \"upnp\",\n \"hash_announcer\",\n \"peer_protocol_server\"\n ],\n \"concurrent_blob_announcers\": 10,\n \"concurrent_reflector_uploads\": 10,\n \"config\": \"/home/lex/.local/share/lbry/lbrynet/daemon_settings.yml\",\n \"data_dir\": \"/tmp/tmpyqz3c__0\",\n \"download_dir\": \"/tmp/tmpyqz3c__0\",\n \"download_timeout\": 30.0,\n \"fixed_peer_delay\": 2.0,\n \"known_dht_nodes\": [],\n \"lbryum_servers\": [\n [\n \"127.0.0.1\",\n 50001\n ]\n ],\n \"max_connections_per_download\": 8,\n \"max_key_fee\": {\n \"amount\": 50.0,\n \"currency\": \"USD\"\n },\n \"network_interface\": \"0.0.0.0\",\n \"node_rpc_timeout\": 5.0,\n \"peer_connect_timeout\": 2.0,\n \"reflect_streams\": true,\n \"reflector_servers\": [\n [\n \"127.0.0.1\",\n 5566\n ]\n ],\n \"s3_headers_depth\": 960,\n \"share_usage_data\": false,\n \"split_buckets_under_index\": 1,\n \"tcp_port\": 3333,\n \"udp_port\": 4444,\n \"use_upnp\": false,\n \"wallet_dir\": \"/tmp/tmpyqz3c__0\"\n }\n}"
} }
] ]
}, },
@ -1891,14 +1879,14 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Abandon a stream claim", "title": "Abandon a stream claim",
"curl": "curl -d'{\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet stream abandon 36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b", "lbrynet": "lbrynet stream abandon 70af4076385dbba0fe0b400056f407202caa057a",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"preview\": false, \"blocking\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\", \"preview\": false, \"blocking\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001867f217ce4036393cdef1b14200a4860edc83aa2191320583dbb601dab14d02e000000006a47304402204a9fd64ee2a70e9429a97f27dc496924fd15ec827e3de6bf0871ee581264216b022025355798b6ffd217fa69d93d54bf2de219a8b868c4adf67ea809d6f60688f30f012103edd62441119517bf4625bcea6f9fe683c607d4c78ede2a9f7773cd6a11f68ac6ffffffff0134b7f505000000001976a914c51a3247e139a5e197e3006d3b544d585748794788ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"type\": \"update\",\n \"valid_signature\": null,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"myV8o18V3sEx1TaRanLMetRbphmTBYeQp9\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"f719777d0f7508e3a73614c5227b2eea76b0bb219902829c3a9f0435993cfccc\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"f719777d0f7508e3a73614c5227b2eea76b0bb219902829c3a9f0435993cfccc\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000016877aa08b395faabddcea80576fb9d70322c8c2382e37d1f2c08afbb9a50c94e000000006a47304402202ab777835e8319e29c317ee7803cc1d6fe859dba94be868e0ef2249d9cf8b9c40220376ad929bed3629b6459933a83846d7c6aae0c98dce199ecf21ab527ae66d9580121033023b9e69e50ebabba2589a48ea394643e61b3d41a7d295ac6c798440e24dabaffffffff0134b7f505000000001976a9149ae69038bbfabd1b63f825f306b16041131c1cf888ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signing_channel\": {\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"name\": \"@channel\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n \"sub_type\": \"stream\",\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mudzZRH7knBC6mYc2NRASyutFryXff1bgw\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"b91f535a7815e698c826a636517885d6eb06b1945b11f0984dfcce2b7bccdf68\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"b91f535a7815e698c826a636517885d6eb06b1945b11f0984dfcce2b7bccdf68\"\n }\n}"
} }
] ]
}, },
@ -1944,12 +1932,6 @@
"description": "path to file to be associated with name.", "description": "path to file to be associated with name.",
"is_required": true "is_required": true
}, },
{
"name": "stream_type",
"type": "str",
"description": "type of stream",
"is_required": false
},
{ {
"name": "fee_currency", "name": "fee_currency",
"type": "string", "type": "string",
@ -2028,46 +2010,22 @@
"description": "original public release of content, seconds since UNIX epoch", "description": "original public release of content, seconds since UNIX epoch",
"is_required": false "is_required": false
}, },
{
"name": "width",
"type": "int",
"description": "image/video width, automatically calculated from media file",
"is_required": false
},
{
"name": "height",
"type": "int",
"description": "image/video height, automatically calculated from media file",
"is_required": false
},
{ {
"name": "duration", "name": "duration",
"type": "int", "type": "int",
"description": "audio/video duration in seconds, an attempt will be made to calculate this automatically if not provided", "description": "audio/video duration in seconds, automatically calculated",
"is_required": false
},
{
"name": "image_width",
"type": "int",
"description": "image width",
"is_required": false
},
{
"name": "image_height",
"type": "int",
"description": "image height",
"is_required": false
},
{
"name": "video_width",
"type": "int",
"description": "video width",
"is_required": false
},
{
"name": "video_height",
"type": "int",
"description": "video height",
"is_required": false
},
{
"name": "video_duration",
"type": "int",
"description": "video duration in seconds, an attempt will be made to calculate this automatically if not provided",
"is_required": false
},
{
"name": "audio_duration",
"type": "int",
"description": "audio duration in seconds, an attempt will be made to calculate this automatically if not provided",
"is_required": false "is_required": false
}, },
{ {
@ -2101,14 +2059,14 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Create a stream claim", "title": "Create a stream claim",
"curl": "curl -d'{\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmp9rj4qtvp\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpvewkf00n\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet stream create astream 1.0 /tmp/tmp9rj4qtvp", "lbrynet": "lbrynet stream create astream 1.0 /tmp/tmpvewkf00n",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmp9rj4qtvp\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpvewkf00n\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001b27e81dc327d0a5be390fd1e74ea9272b304581e0f8ebb2eef6b8eeb9e3bc7c1010000006a47304402201d0597656ac425ad86b66042c27f5145853017b95c1fd8975ff336e5ee0f5f8202201ad2d70bda83aaffb182063ad5cc72ab17c3c37c307b1def0f4e18945e91ae910121037b1dedb92e17a3e19292b378d623e61e5da82784df6bf21bfadfd0db696864ddffffffff0200e1f5050000000079b5076173747265616d4c53000a500a30bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d26a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d7576a914cf505c51f04694f549c500d8f5d4eaf9fe108e6888ace256df05000000001976a914a241dbd7f46530494a66f266d6a1da087a1fcafc88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mzXLFAQ962F5sZTcvKgKmguLzWKCB7Dpe1\",\n \"amount\": \"1.9993355\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"c1c73b9eeb8e6bef2ebb8e0f1e5804b37292ea741efd90e35b0a7d32dc817eb2\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"3895a199e1a82625dd6426f47bf4608e81f8d2f47b2b716205e4a688d4e64fb4\",\n \"type\": \"claim\",\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n },\n {\n \"address\": \"mvJtf5Tc17zKsLBshWMYzN18rxmgXaUKcV\",\n \"amount\": \"0.9852285\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"3895a199e1a82625dd6426f47bf4608e81f8d2f47b2b716205e4a688d4e64fb4\"\n }\n ],\n \"total_fee\": \"0.014107\",\n \"total_input\": \"1.9993355\",\n \"total_output\": \"1.9852285\",\n \"txid\": \"3895a199e1a82625dd6426f47bf4608e81f8d2f47b2b716205e4a688d4e64fb4\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000198c0b7f5f36c1f1b84a004d5b0d6ee746945d9406e66840a8d416927e33bd325010000006a473044022058b1ee2d100d11caaf1423b5587d71aac92c9c506e35c2c5e1666f88d0bf04c5022051725983ea6a1b6b2c7920c4e001675fcdeb4f01f81f21ab2eeaee9411aca1a401210285dc7a663ace30d43c22cb210a7508277819b5b5098a193663710a2ce529e369ffffffff0200e1f50500000000a8b5076173747265616d4c82000a7f0a7d0a20b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9120b746d707665776b6630306e180b22186170706c69636174696f6e2f6f637465742d73747265616d32307b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d44446d7576a91430baf6b86733ac357c0002e3d89bdebebd995d4888ace256df05000000001976a914f0604cbcd22a1785b7deaf4f457a788394ebcda688ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mquCEFxZWnSiLhjphENiN8se4WTiPQxVHn\",\n \"amount\": \"1.9993355\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"25d33be32769418d0a84666e40d9456974eed6b0d504a0841b1f6cf3f5b7c098\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"create\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"sub_type\": \"stream\",\n \"txid\": \"c8b7e2bc10db9ecc28a9808e20aa10798159798f6c5db240c016beec02d81639\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n },\n {\n \"address\": \"n3Rwq7n8wygBkQ2ZiHkjjfNYqxRhh6caZh\",\n \"amount\": \"0.9852285\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"c8b7e2bc10db9ecc28a9808e20aa10798159798f6c5db240c016beec02d81639\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.014107\",\n \"total_input\": \"1.9993355\",\n \"total_output\": \"1.9852285\",\n \"txid\": \"c8b7e2bc10db9ecc28a9808e20aa10798159798f6c5db240c016beec02d81639\"\n }\n}"
} }
] ]
}, },
@ -2135,21 +2093,21 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ]\n }",
"examples": [ "examples": [
{ {
"title": "List all your stream claims", "title": "List all your stream claims",
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet stream list", "lbrynet": "lbrynet stream list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"type\": \"update\",\n \"valid_signature\": true,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_channel_signature_valid\": true,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signing_channel\": {\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"name\": \"@channel\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n \"sub_type\": \"stream\",\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n }\n ]\n}"
}, },
{ {
"title": "Paginate your stream claims", "title": "Paginate your stream claims",
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"lbrynet": "lbrynet stream list --page=1 --page_size=20", "lbrynet": "lbrynet stream list --page=1 --page_size=20",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"type\": \"update\",\n \"valid_signature\": true,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"update\",\n \"confirmations\": 1,\n \"height\": 212,\n \"is_change\": false,\n \"is_channel_signature_valid\": true,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signing_channel\": {\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"name\": \"@channel\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n \"sub_type\": \"stream\",\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}"
} }
] ]
}, },
@ -2272,45 +2230,21 @@
"is_required": false "is_required": false
}, },
{ {
"name": "stream_type", "name": "width",
"type": "str", "type": "int",
"description": "type of stream", "description": "image/video width, automatically calculated from media file",
"is_required": false "is_required": false
}, },
{ {
"name": "image_width", "name": "height",
"type": "int", "type": "int",
"description": "image width", "description": "image/video height, automatically calculated from media file",
"is_required": false "is_required": false
}, },
{ {
"name": "image_height", "name": "duration",
"type": "int", "type": "int",
"description": "image height", "description": "audio/video duration in seconds, automatically calculated",
"is_required": false
},
{
"name": "video_width",
"type": "int",
"description": "video width",
"is_required": false
},
{
"name": "video_height",
"type": "int",
"description": "video height",
"is_required": false
},
{
"name": "video_duration",
"type": "int",
"description": "video duration in seconds, an attempt will be made to calculate this automatically if not provided",
"is_required": false
},
{
"name": "audio_duration",
"type": "int",
"description": "audio duration in seconds, an attempt will be made to calculate this automatically if not provided",
"is_required": false "is_required": false
}, },
{ {
@ -2350,14 +2284,14 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [ "examples": [
{ {
"title": "Update a stream claim to add channel", "title": "Update a stream claim to add channel",
"curl": "curl -d'{\"method\": \"stream_update\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_update\", \"params\": {\"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet stream update 36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b --channel_id=\"7e7b2f61a7166876ba28e34c415447072a4d13bd\"", "lbrynet": "lbrynet stream update 70af4076385dbba0fe0b400056f407202caa057a --channel_id=\"ceae903e6aa88e85688c01b2e988418613087fbd\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_update\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_update\", \"params\": {\"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000002b44fe6d488a6e40562712b7bf4d2f8818e60f47bf42664dd2526a8e199a19538000000006a47304402201a6fbf1ffd059d7cd780a7c7cd1fd2b309fd28fb2fb78717d5b7c0b989dfee44022038e72d17f266d511e180c114eb2e1c72c40afb98e27d780529c62dd4e2c5d4a7012103edd62441119517bf4625bcea6f9fe683c607d4c78ede2a9f7773cd6a11f68ac6ffffffffb44fe6d488a6e40562712b7bf4d2f8818e60f47bf42664dd2526a8e199a19538010000006b483045022100bcfab703a5722b4338c4923eb9efa83c08452d5a0f7fbaabff8d5691e8c7d3d402207ac0df2bdb82a14033ca81ee2bff82b2ffcd1f5236d2488d24b78078b3aea447012103a3768fe9c47ce659b68d336ee15e9040f9e3c8fd6e4cc4c78d0838770ef7fe30ffffffff0200e1f50500000000e2b7076173747265616d148bfca7e0dff1e8ca33cce6a744fbeea8f89bb6364ca701bd134d2a074754414ce328ba766816a7612f7b7e2c5378c71cf936592d6ab469cd5bdcbb3daddf22900659ace60f2c9aedc9d979717af910cf82c3c6109d59d8870361da5fb952e98a84ee93727ceb94cd0419ef0a500a30bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d26a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d6d76a914cf505c51f04694f549c500d8f5d4eaf9fe108e6888ac48e2de05000000001976a914cc5c3545cc78258f0fbe399a46f926c3ef6f7ded88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": 1,\n \"height\": 211,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"3895a199e1a82625dd6426f47bf4608e81f8d2f47b2b716205e4a688d4e64fb4\",\n \"type\": \"claim\",\n \"valid_signature\": null,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n },\n {\n \"address\": \"mvJtf5Tc17zKsLBshWMYzN18rxmgXaUKcV\",\n \"amount\": \"0.9852285\",\n \"confirmations\": 1,\n \"height\": 211,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"3895a199e1a82625dd6426f47bf4608e81f8d2f47b2b716205e4a688d4e64fb4\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mzR8SKLohWezpBS1mmHFcPaP9RG7HgX26U\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\",\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\",\n \"type\": \"update\",\n \"valid_signature\": true,\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n }\n }\n },\n {\n \"address\": \"mz9WbvDL4oqAicPkVjqTz26sPfASZr9Nis\",\n \"amount\": \"0.98493\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\"\n }\n ],\n \"total_fee\": \"0.0002985\",\n \"total_input\": \"1.9852285\",\n \"total_output\": \"1.98493\",\n \"txid\": \"2ed014ab1d60bb3d58201319a23ac8ed60480a20141befcd936303e47c217f86\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000023916d802ecbe16c040b25d6c8f7959817910aa208e80a928cc9edb10bce2b7c8000000006b483045022100dd0c490a2b9755080769d64321f6f0bd5864ff14921e2eb407622f1a4a163c9902203ce3357bae87abdf9d48ae23d74dfc3b7957858b37995cff22a13db7d75365320121033023b9e69e50ebabba2589a48ea394643e61b3d41a7d295ac6c798440e24dabaffffffff3916d802ecbe16c040b25d6c8f7959817910aa208e80a928cc9edb10bce2b7c8010000006a4730440220078b9bd6ca696d3a48677d038b4c2d72f6a1c3b23f5ad4958438b12af809a5eb0220034e92c4792f8a7b5156bb9b6980125d141fb21497bfc47deb825f835f61997a01210279bbfa7774c5b9265c803ded514edf2f3490f5e3a0585eedac45824a2129d5e2ffffffff0200e1f50500000000fd1101b7076173747265616d147a05aa2c2007f45600400bfea0bb5d387640af704cd601bd7f0813864188e9b2018c68858ea86a3e90aecee46e57b139165fddc382a7f502edc7a07b675130a4435cb15726d189ae5768f31be20e8db061c5fe1ae3b7231e0e8bb2c7100587f018c44aa1d55ba245750ff80a7f0a7d0a20b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9120b746d707665776b6630306e180b22186170706c69636174696f6e2f6f637465742d73747265616d32307b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d44446d6d76a91430baf6b86733ac357c0002e3d89bdebebd995d4888acb6d8de05000000001976a914940e3a889c5ea9b11d5f92392170dc9373a2451888ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"create\",\n \"confirmations\": 1,\n \"height\": 211,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"sub_type\": \"stream\",\n \"txid\": \"c8b7e2bc10db9ecc28a9808e20aa10798159798f6c5db240c016beec02d81639\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n },\n {\n \"address\": \"n3Rwq7n8wygBkQ2ZiHkjjfNYqxRhh6caZh\",\n \"amount\": \"0.9852285\",\n \"confirmations\": 1,\n \"height\": 211,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"c8b7e2bc10db9ecc28a9808e20aa10798159798f6c5db240c016beec02d81639\",\n \"type\": \"payment\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mjxchjMXksemtLUiU3qaAQtccgp5qWsSQg\",\n \"amount\": \"1.0\",\n \"claim_id\": \"70af4076385dbba0fe0b400056f407202caa057a\",\n \"claim_op\": \"update\",\n \"confirmations\": -2,\n \"height\": -2,\n \"is_channel_signature_valid\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#70af4076385dbba0fe0b400056f407202caa057a\",\n \"signing_channel\": {\n \"claim_id\": \"ceae903e6aa88e85688c01b2e988418613087fbd\",\n \"name\": \"@channel\",\n \"value\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004149439c425b82c67b8af11571dd3120ababd91d5210eb5c37c29419b3f889eed658b84cb582a763979c5f46c8375ddc3881c0cb5e36692fb16468fd479c68597\",\n \"title\": \"New Channel\"\n }\n },\n \"sub_type\": \"stream\",\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"type\": \"claim\",\n \"value\": {\n \"source\": {\n \"hash\": \"b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9\",\n \"media_type\": \"application/octet-stream\",\n \"name\": \"tmpvewkf00n\",\n \"sd_hash\": \"7b3245d4259cac05058bd89442db3b8575b968407b33232f8d7617292232fee2829ee020caf921da63d018754c6d4444\",\n \"size\": \"11\"\n }\n }\n },\n {\n \"address\": \"mu1oM4wC1KAYD9LJMdMXxHdmvagfCVM8yg\",\n \"amount\": \"0.9849055\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\",\n \"type\": \"payment\"\n }\n ],\n \"total_fee\": \"0.000323\",\n \"total_input\": \"1.9852285\",\n \"total_output\": \"1.9849055\",\n \"txid\": \"4ec9509abbaf082c1f7de382238c2c32709dfb7605a8ceddabfa95b308aa7768\"\n }\n}"
} }
] ]
} }
@ -2413,7 +2347,7 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [] "examples": []
}, },
{ {
@ -2451,7 +2385,7 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [] "examples": []
}, },
{ {
@ -2477,7 +2411,7 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ]\n }",
"examples": [] "examples": []
} }
] ]
@ -2553,7 +2487,7 @@
"curl": "curl -d'{\"method\": \"transaction_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"transaction_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet transaction list", "lbrynet": "lbrynet transaction list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"transaction_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"transaction_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"abandon_info\": [],\n \"claim_info\": [],\n \"confirmations\": 1,\n \"date\": \"2019-04-15 15:44\",\n \"fee\": \"-0.000124\",\n \"support_info\": [],\n \"timestamp\": 1555357492,\n \"txid\": \"f4fda657ef59851174e801d8dc8d8cd902e36397c8c01a1c419dec8d1e5d4233\",\n \"update_info\": [],\n \"value\": \"-2.0\"\n },\n {\n \"abandon_info\": [],\n \"claim_info\": [],\n \"confirmations\": 7,\n \"date\": \"2019-04-15 15:44\",\n \"fee\": \"0.0\",\n \"support_info\": [],\n \"timestamp\": 1555357491,\n \"txid\": \"2d852877059f9958fb1092632cb2edd4c7b32dcf24986945d5279a4c380253ae\",\n \"update_info\": [],\n \"value\": \"10.0\"\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"abandon_info\": [],\n \"claim_info\": [],\n \"confirmations\": 1,\n \"date\": \"2019-04-20 23:56\",\n \"fee\": \"-0.000124\",\n \"support_info\": [],\n \"timestamp\": 1555819013,\n \"txid\": \"322e08e35ad4e406c9c6eb2bab850b0869920effc6e2d8c75c3958bb76955d0b\",\n \"update_info\": [],\n \"value\": \"-2.0\"\n },\n {\n \"abandon_info\": [],\n \"claim_info\": [],\n \"confirmations\": 7,\n \"date\": \"2019-04-20 23:56\",\n \"fee\": \"0.0\",\n \"support_info\": [],\n \"timestamp\": 1555819012,\n \"txid\": \"85c5a4b6aeea84d64bc54828c803275bf5f93dd8ed8ef1bc33bf555f36406750\",\n \"update_info\": [],\n \"value\": \"10.0\"\n }\n ]\n}"
} }
] ]
}, },
@ -2568,7 +2502,7 @@
"is_required": true "is_required": true
} }
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }",
"examples": [] "examples": []
} }
] ]
@ -2599,7 +2533,7 @@
"is_required": false "is_required": false
} }
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"nout\": \"position in the transaction\",\n \"height\": \"block where transaction was recorded\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\",\n \"is_change\": \"payment to change address, only available when it can be determined\",\n \"is_mine\": \"payment to one of your accounts, only available when it can be determined\",\n \"type\": \"one of 'claim', 'support' or 'payment'\",\n \"claim_op\": \"when type is 'claim', this determines if it is 'create' or 'update'\",\n \"name\": \"when type is 'claim' or 'support', this is the claim name\",\n \"claim_id\": \"when type is 'claim' or 'support', this is the claim id\",\n \"permanent_url\": \"when type is 'claim' or 'support', this is the long permanent claim URL\",\n \"value\": \"when type is 'claim', this is the claim metadata\",\n \"sub_type\": \"when type is 'claim', this determines if it is 'channel' or 'stream' claim\",\n \"signing_channel\": \"for signed claims only, metadata of signing channel\",\n \"is_channel_signature_valid\": \"for signed claims only, whether signature is valid\"\n }\n ]\n }",
"examples": [] "examples": []
}, },
{ {