Madiator2011/lbry-sdk
1
0
Fork 0
forked from LBRYCommunity/lbry-sdk
Code Pull requests Activity
lbry-sdk/docs/api.json
jessop 7f5deaf6c8 adds api examples to docs
2019-04-16 14:18:23 -04:00

2621 lines
No EOL
216 KiB
JSON
Raw Blame History

{
"main": {
"doc": "Ungrouped commands.",
"commands": [
{
"name": "block_show",
"description": "Get contents of a block",
"arguments": [
{
"name": "blockhash",
"type": "str",
"description": "hash of the block to look up",
"is_required": true
},
{
"name": "height",
"type": "int",
"description": "height of the block to look up",
"is_required": true
}
],
"returns": "(dict) Requested block",
"examples": []
},
{
"name": "get",
"description": "Download stream from a LBRY name.",
"arguments": [
{
"name": "uri",
"type": "str",
"description": "uri of the content to download",
"is_required": false
},
{
"name": "file_name",
"type": "str",
"description": "specified name for the downloaded file",
"is_required": false
},
{
"name": "timeout",
"type": "int",
"description": "download timeout in number of seconds",
"is_required": false
}
],
"returns": " {\n \"completed\": \"(bool) true if download is completed\",\n \"file_name\": \"(str) name of file\",\n \"download_directory\": \"(str) download directory\",\n \"points_paid\": \"(float) credit paid to download file\",\n \"stopped\": \"(bool) true if download is stopped\",\n \"stream_hash\": \"(str) stream hash of file\",\n \"stream_name\": \"(str) stream name\",\n \"suggested_file_name\": \"(str) suggested file name\",\n \"sd_hash\": \"(str) sd hash of file\",\n \"download_path\": \"(str) download path of file\",\n \"mime_type\": \"(str) mime type of file\",\n \"key\": \"(str) key attached to file\",\n \"total_bytes_lower_bound\": \"(int) lower bound file size in bytes\",\n \"total_bytes\": \"(int) file upper bound size in bytes\",\n \"written_bytes\": \"(int) written size in bytes\",\n \"blobs_completed\": \"(int) number of fully downloaded blobs\",\n \"blobs_in_stream\": \"(int) total blobs on stream\",\n \"blobs_remaining\": \"(int) total blobs remaining to download\",\n \"status\": \"(str) downloader status\",\n \"claim_id\": \"(str) None if claim is not found else the claim id\",\n \"txid\": \"(str) None if claim is not found else the transaction id\",\n \"nout\": \"(int) None if claim is not found else the transaction output index\",\n \"outpoint\": \"(str) None if claim is not found else the tx and output\",\n \"metadata\": \"(dict) None if claim is not found else the claim metadata\",\n \"channel_claim_id\": \"(str) None if claim is not found or not signed\",\n \"channel_name\": \"(str) None if claim is not found or not signed\",\n \"claim_name\": \"(str) None if claim is not found else the claim name\"\n }",
"examples": [
{
"title": "Get a file",
"curl": "curl -d'{\"method\": \"get\", \"params\": {\"uri\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"}}' http://localhost:5279/",
"lbrynet": "lbrynet get astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"get\", \"params\": {\"uri\": \"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"}}).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}"
}
]
},
{
"name": "publish",
"description": "Create or update a stream claim at a given name (use 'stream create/update' for more control).",
"arguments": [
{
"name": "name",
"type": "str",
"description": "name of the content (can only consist of a-z A-Z 0-9 and -(dash))",
"is_required": true
},
{
"name": "bid",
"type": "decimal",
"description": "amount to back the claim",
"is_required": false
},
{
"name": "file_path",
"type": "str",
"description": "path to file to be associated with name.",
"is_required": false
},
{
"name": "stream_type",
"type": "str",
"description": "type of stream",
"is_required": false
},
{
"name": "fee_currency",
"type": "string",
"description": "specify fee currency",
"is_required": false
},
{
"name": "fee_amount",
"type": "decimal",
"description": "content download fee",
"is_required": false
},
{
"name": "fee_address",
"type": "str",
"description": "address where to send fee payments, will use value from --claim_address if not provided",
"is_required": false
},
{
"name": "title",
"type": "str",
"description": "title of the publication",
"is_required": false
},
{
"name": "description",
"type": "str",
"description": "description of the publication",
"is_required": false
},
{
"name": "author",
"type": "str",
"description": "author of the publication. The usage for this field is not the same as for channels. The author field is used to credit an author who is not the publisher and is not represented by the channel. For example, a pdf file of 'The Odyssey' has an author of 'Homer' but may by published to a channel such as '@classics', or to no channel at all",
"is_required": false
},
{
"name": "clear_tags",
"type": "bool",
"description": "clear existing tags (prior to adding new ones)",
"is_required": false
},
{
"name": "tags",
"type": "list",
"description": "add content tags",
"is_required": false
},
{
"name": "clear_languages",
"type": "bool",
"description": "clear existing languages (prior to adding new ones)",
"is_required": false
},
{
"name": "languages",
"type": "list",
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
"is_required": false
},
{
"name": "clear_locations",
"type": "bool",
"description": "clear existing locations (prior to adding new ones)",
"is_required": false
},
{
"name": "locations",
"type": "list",
"description": "locations relevant to the stream, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
"is_required": false
},
{
"name": "license",
"type": "str",
"description": "publication license",
"is_required": false
},
{
"name": "license_url",
"type": "str",
"description": "publication license url",
"is_required": false
},
{
"name": "thumbnail_url",
"type": "str",
"description": "thumbnail url",
"is_required": false
},
{
"name": "release_time",
"type": "int",
"description": "original public release of content, seconds since UNIX epoch",
"is_required": false
},
{
"name": "duration",
"type": "int",
"description": "audio/video duration in seconds, an attempt will be made to calculate this automatically if not provided",
"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
},
{
"name": "channel_id",
"type": "str",
"description": "claim id of the publisher channel",
"is_required": false
},
{
"name": "channel_name",
"type": "str",
"description": "name of publisher channel",
"is_required": false
},
{
"name": "channel_account_id",
"type": "str",
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "account to use for funding the transaction",
"is_required": false
},
{
"name": "claim_address",
"type": "str",
"description": "address where the claim is sent to, if not specified it will be determined automatically from the account",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"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 }",
"examples": [
{
"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/",
"lbrynet": "lbrynet publish a-new-stream --bid=1.0 --file_path=/tmp/tmpynod_gwc",
"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()",
"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}"
}
]
},
{
"name": "resolve",
"description": "Get the claim that a URL refers to.",
"arguments": [
{
"name": "urls",
"type": "str, list",
"description": "one or more urls to resolve",
"is_required": false
}
],
"returns": "Dictionary of results, keyed by url\n '<url>': {\n If a resolution error occurs:\n 'error': Error message\n\n If the url resolves to a channel or a claim in a channel:\n 'certificate': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number (or -1 if unknown),\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'depth': (int) claim depth,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the certificate claim,\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}],\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n\n If the url resolves to a channel:\n 'claims_in_channel': (int) number of claims in the channel,\n\n If the url resolves to a claim:\n 'claim': {\n 'address': (str) claim address,\n 'amount': (float) claim amount,\n 'effective_amount': (float) claim amount including supports,\n 'claim_id': (str) claim id,\n 'claim_sequence': (int) claim sequence number (or -1 if unknown),\n 'decoded_claim': (bool) whether or not the claim value was decoded,\n 'height': (int) claim height,\n 'depth': (int) claim depth,\n 'has_signature': (bool) included if decoded_claim\n 'name': (str) claim name,\n 'permanent_url': (str) permanent url of the claim,\n 'channel_name': (str) channel name if claim is in a channel\n 'supports: (list) list of supports [{'txid': (str) txid,\n 'nout': (int) nout,\n 'amount': (float) amount}]\n 'txid': (str) claim txid,\n 'nout': (str) claim nout,\n 'signature_is_valid': (bool), included if has_signature,\n 'value': ClaimDict if decoded, otherwise hex string\n }\n }",
"examples": [
{
"title": "Resolve a claim",
"curl": "curl -d'{\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"]}}' http://localhost:5279/",
"lbrynet": "lbrynet resolve astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"resolve\", \"params\": {\"urls\": [\"astream#36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"]}}).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}"
}
]
},
{
"name": "routing_table_get",
"description": "Get DHT routing information",
"arguments": [],
"returns": "(dict) dictionary containing routing and peer information\n {\n \"buckets\": {\n <bucket index>: [\n {\n \"address\": (str) peer address,\n \"udp_port\": (int) peer udp port,\n \"tcp_port\": (int) peer tcp port,\n \"node_id\": (str) peer node id,\n }\n ]\n },\n \"node_id\": (str) the local dht node id\n }",
"examples": []
},
{
"name": "status",
"description": "Get daemon status",
"arguments": [],
"returns": "(dict) lbrynet-daemon status\n {\n 'installation_id': (str) installation id - base58,\n 'is_running': (bool),\n 'skipped_components': (list) [names of skipped components (str)],\n 'startup_status': { Does not include components which have been skipped\n 'blob_manager': (bool),\n 'blockchain_headers': (bool),\n 'database': (bool),\n 'dht': (bool),\n 'exchange_rate_manager': (bool),\n 'hash_announcer': (bool),\n 'peer_protocol_server': (bool),\n 'stream_manager': (bool),\n 'upnp': (bool),\n 'wallet': (bool),\n },\n 'connection_status': {\n 'code': (str) connection status code,\n 'message': (str) connection status message\n },\n 'blockchain_headers': {\n 'downloading_headers': (bool),\n 'download_progress': (float) 0-100.0\n },\n 'wallet': {\n 'blocks': (int) local blockchain height,\n 'blocks_behind': (int) remote_height - local_height,\n 'best_blockhash': (str) block hash of most recent block,\n 'is_encrypted': (bool),\n 'is_locked': (bool),\n },\n 'dht': {\n 'node_id': (str) lbry dht node id - hex encoded,\n 'peers_in_routing_table': (int) the number of peers in the routing table,\n },\n 'blob_manager': {\n 'finished_blobs': (int) number of finished blobs in the blob manager,\n },\n 'hash_announcer': {\n 'announce_queue_size': (int) number of blobs currently queued to be announced\n },\n 'stream_manager': {\n 'managed_files': (int) count of files in the stream manager,\n },\n 'upnp': {\n 'aioupnp_version': (str),\n 'redirects': {\n <TCP | UDP>: (int) external_port,\n },\n 'gateway': (str) manufacturer and model,\n 'dht_redirect_set': (bool),\n 'peer_redirect_set': (bool),\n 'external_ip': (str) external ip address,\n }\n }",
"examples": [
{
"title": "Get status",
"curl": "curl -d'{\"method\": \"status\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet status",
"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}"
}
]
},
{
"name": "stop",
"description": "Stop lbrynet API server.",
"arguments": [],
"returns": "(string) Shutdown message",
"examples": []
},
{
"name": "version",
"description": "Get lbrynet API server version information",
"arguments": [],
"returns": "(dict) Dictionary of lbry version information\n {\n 'build': (str) build type (e.g. \"dev\", \"rc\", \"release\"),\n 'ip': (str) remote ip, if available,\n 'lbrynet_version': (str) lbrynet_version,\n 'lbryum_version': (str) lbryum_version,\n 'lbryschema_version': (str) lbryschema_version,\n 'os_release': (str) os release string\n 'os_system': (str) os name\n 'platform': (str) platform string\n 'processor': (str) processor type,\n 'python_version': (str) python version,\n }",
"examples": [
{
"title": "Get version",
"curl": "curl -d'{\"method\": \"version\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet version",
"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}"
}
]
}
]
},
"account": {
"doc": "Create, modify and inspect wallet accounts.",
"commands": [
{
"name": "account_add",
"description": "Add a previously created account from a seed, private key or public key (read-only).\nSpecify --single_key for single address or vanity address accounts.",
"arguments": [
{
"name": "account_name",
"type": "str",
"description": "name of the account to add",
"is_required": true
},
{
"name": "seed",
"type": "str",
"description": "seed to generate new account from",
"is_required": false
},
{
"name": "private_key",
"type": "str",
"description": "private key for new account",
"is_required": false
},
{
"name": "public_key",
"type": "str",
"description": "public key for new account",
"is_required": false
},
{
"name": "single_key",
"type": "bool",
"description": "create single key account, default is multi-key",
"is_required": false
}
],
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
"examples": [
{
"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/",
"lbrynet": "lbrynet account add \"new account\" --seed=\"library luxury maximum chicken hotel decrease oil ginger multiply cloud pony meadow\"",
"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()",
"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}"
}
]
},
{
"name": "account_balance",
"description": "Return the balance of an account",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "If provided only the balance for this account will be given. Otherwise default account.",
"is_required": false
},
{
"name": "confirmations",
"type": "int",
"description": "Only include transactions with this many confirmed blocks.",
"is_required": false
}
],
"returns": "(decimal) amount of lbry credits in wallet",
"examples": [
{
"title": "Get default account balance",
"curl": "curl -d'{\"method\": \"account_balance\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet account balance",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_balance\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"7.999876\"\n}"
},
{
"title": "Get balance for specific account by id",
"curl": "curl -d'{\"method\": \"account_balance\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}' http://localhost:5279/",
"lbrynet": "lbrynet account balance \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_balance\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"2.0\"\n}"
}
]
},
{
"name": "account_create",
"description": "Create a new account. Specify --single_key if you want to use\nthe same address for all transactions (not recommended).",
"arguments": [
{
"name": "account_name",
"type": "str",
"description": "name of the account to create",
"is_required": true
},
{
"name": "single_key",
"type": "bool",
"description": "create single key account, default is multi-key",
"is_required": false
}
],
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
"examples": [
{
"title": "Create an account",
"curl": "curl -d'{\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}' http://localhost:5279/",
"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()",
"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}"
}
]
},
{
"name": "account_decrypt",
"description": "Decrypt an encrypted account, this will remove the wallet password. The account must be unlocked to decrypt it",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id for the account to decrypt",
"is_required": false
}
],
"returns": "(bool) true if wallet is decrypted, otherwise false",
"examples": []
},
{
"name": "account_encrypt",
"description": "Encrypt an unencrypted account with a password",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id for the account to encrypt",
"is_required": false
}
],
"returns": "(bool) true if wallet is decrypted, otherwise false",
"examples": []
},
{
"name": "account_fund",
"description": "Transfer some amount (or --everything) to an account from another\naccount (can be the same account). Amounts are interpreted as LBC.\nYou can also spread the transfer across a number of --outputs (cannot\nbe used together with --everything).",
"arguments": [
{
"name": "to_account",
"type": "str",
"description": "send to this account",
"is_required": false
},
{
"name": "from_account",
"type": "str",
"description": "spend from this account",
"is_required": false
},
{
"name": "amount",
"type": "str",
"description": "the amount to transfer lbc",
"is_required": true
},
{
"name": "everything",
"type": "bool",
"description": "transfer everything (excluding claims), default: false.",
"is_required": false
},
{
"name": "outputs",
"type": "int",
"description": "split payment across many outputs, default: 1.",
"is_required": false
},
{
"name": "broadcast",
"type": "bool",
"description": "actually broadcast the transaction, default: 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 }",
"examples": [
{
"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/",
"lbrynet": "lbrynet account fund --to_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --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()",
"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}"
},
{
"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/",
"lbrynet": "lbrynet account fund --to_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --from_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --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()",
"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}"
},
{
"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/",
"lbrynet": "lbrynet account fund --from_account=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\" --everything --broadcast",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_fund\", \"params\": {\"from_account\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\", \"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}"
}
]
},
{
"name": "account_list",
"description": "List details of all of the accounts or a specific account.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "If provided only the balance for this account will be given",
"is_required": false
},
{
"name": "confirmations",
"type": "int",
"description": "required confirmations (default: 0)",
"is_required": false
},
{
"name": "include_claims",
"type": "bool",
"description": "include claims, requires than a LBC account is specified (default: false)",
"is_required": false
},
{
"name": "show_seed",
"type": "bool",
"description": "show the seed for the account",
"is_required": false
}
],
"returns": " [\n {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }\n ]",
"examples": [
{
"title": "List your accounts",
"curl": "curl -d'{\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet account list",
"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}"
}
]
},
{
"name": "account_lock",
"description": "Lock an unlocked account",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id for the account to lock",
"is_required": false
}
],
"returns": "(bool) true if account is locked, otherwise false",
"examples": []
},
{
"name": "account_max_address_gap",
"description": "Finds ranges of consecutive addresses that are unused and returns the length\nof the longest such range: for change and receiving address chains. This is\nuseful to figure out ideal values to set for 'receiving_gap' and 'change_gap'\naccount settings.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "account for which to get max gaps",
"is_required": true
}
],
"returns": "(map) maximum gap for change and receiving addresses",
"examples": []
},
{
"name": "account_remove",
"description": "Remove an existing account.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to remove",
"is_required": true
}
],
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
"examples": [
{
"title": "Remove an account",
"curl": "curl -d'{\"method\": \"account_remove\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}' http://localhost:5279/",
"lbrynet": "lbrynet account remove mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_remove\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}).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}"
}
]
},
{
"name": "account_send",
"description": "Send the same number of credits to multiple addresses.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "account to fund the transaction",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"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 }",
"examples": []
},
{
"name": "account_set",
"description": "Change various settings on an account.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to change",
"is_required": true
},
{
"name": "default",
"type": "bool",
"description": "make this account the default",
"is_required": false
},
{
"name": "new_name",
"type": "str",
"description": "new name for the account",
"is_required": false
},
{
"name": "receiving_gap",
"type": "int",
"description": "set the gap for receiving addresses",
"is_required": false
},
{
"name": "receiving_max_uses",
"type": "int",
"description": "set the maximum number of times to use a receiving address",
"is_required": false
},
{
"name": "change_gap",
"type": "int",
"description": "set the gap for change addresses",
"is_required": false
},
{
"name": "change_max_uses",
"type": "int",
"description": "set the maximum number of times to use a change address",
"is_required": false
}
],
"returns": " {\n \"id\": \"account_id\",\n \"is_default\": \"this account is used by default\",\n \"ledger\": \"name of crypto currency and network\",\n \"name\": \"optional account name\",\n \"seed\": \"human friendly words from which account can be recreated\",\n \"encrypted\": \"if account is encrypted\",\n \"private_key\": \"extended private key\",\n \"public_key\": \"extended public key\",\n \"address_generator\": \"settings for generating addresses\",\n \"modified_on\": \"date of last modification to account settings\"\n }",
"examples": [
{
"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/",
"lbrynet": "lbrynet account set mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA --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()",
"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}"
}
]
},
{
"name": "account_unlock",
"description": "Unlock an encrypted account",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id for the account to unlock",
"is_required": false
}
],
"returns": "(bool) true if account is unlocked, otherwise false",
"examples": []
}
]
},
"address": {
"doc": "List, generate and verify addresses.",
"commands": [
{
"name": "address_is_mine",
"description": "Checks if an address is associated with the current wallet.",
"arguments": [
{
"name": "address",
"type": "str",
"description": "address to check",
"is_required": true
},
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
}
],
"returns": "(bool) true, if address is associated with current wallet",
"examples": [
{
"title": "Check if address is mine",
"curl": "curl -d'{\"method\": \"address_is_mine\", \"params\": {\"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\"}}' http://localhost:5279/",
"lbrynet": "lbrynet address is_mine mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_is_mine\", \"params\": {\"address\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}"
}
]
},
{
"name": "address_list",
"description": "List account addresses",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"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 \"an address in base58\"\n ]\n }",
"examples": [
{
"title": "List addresses in default account",
"curl": "curl -d'{\"method\": \"address_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet address list",
"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}"
},
{
"title": "List addresses in specified account",
"curl": "curl -d'{\"method\": \"address_list\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}' http://localhost:5279/",
"lbrynet": "lbrynet address list --account_id=\"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_list\", \"params\": {\"account_id\": \"mt8dVnQtoRFs7JWP6AxadYaUuM1EBbD6xA\"}}).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}"
}
]
},
{
"name": "address_unused",
"description": "Return an address containing no balance, will create\na new address if there is none.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
}
],
"returns": " \"an address in base58\"",
"examples": [
{
"title": "Get an unused address",
"curl": "curl -d'{\"method\": \"address_unused\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet address unused",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"address_unused\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"mydWN6ruHWfNrfFquH24LKS5kbfR8knLiw\"\n}"
}
]
}
]
},
"blob": {
"doc": "Blob management.",
"commands": [
{
"name": "blob_announce",
"description": "Announce blobs to the DHT",
"arguments": [
{
"name": "blob_hash",
"type": "str",
"description": "announce a blob, specified by blob_hash",
"is_required": false
},
{
"name": "stream_hash",
"type": "str",
"description": "announce all blobs associated with stream_hash",
"is_required": false
},
{
"name": "sd_hash",
"type": "str",
"description": "announce all blobs associated with sd_hash and the sd_hash itself",
"is_required": false
}
],
"returns": "(bool) true if successful",
"examples": []
},
{
"name": "blob_delete",
"description": "Delete a blob",
"arguments": [
{
"name": "blob_hash",
"type": "str",
"description": "blob hash of the blob to delete",
"is_required": true
}
],
"returns": "(str) Success/fail message",
"examples": [
{
"title": "Delete a blob",
"curl": "curl -d'{\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"}}' http://localhost:5279/",
"lbrynet": "lbrynet blob delete bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"blob_delete\", \"params\": {\"blob_hash\": \"bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": \"Deleted bc0a3418545045fb38e465c94bbc3df98596c86d141de3a461597662f3ce9aceb68723ecb313a81d3357a2c32f9162d2\"\n}"
}
]
},
{
"name": "blob_get",
"description": "Download and return a blob",
"arguments": [
{
"name": "blob_hash",
"type": "str",
"description": "blob hash of the blob to get",
"is_required": true
},
{
"name": "timeout",
"type": "int",
"description": "timeout in number of seconds",
"is_required": false
}
],
"returns": "(str) Success/Fail message or (dict) decoded data",
"examples": []
},
{
"name": "blob_list",
"description": "Returns blob hashes. If not given filters, returns all blobs known by the blob manager",
"arguments": [
{
"name": "needed",
"type": "bool",
"description": "only return needed blobs",
"is_required": false
},
{
"name": "finished",
"type": "bool",
"description": "only return finished blobs",
"is_required": false
},
{
"name": "uri",
"type": "str",
"description": "filter blobs by stream in a uri",
"is_required": false
},
{
"name": "stream_hash",
"type": "str",
"description": "filter blobs by stream hash",
"is_required": false
},
{
"name": "sd_hash",
"type": "str",
"description": "filter blobs by sd hash",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "results page size",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page of results to return",
"is_required": false
}
],
"returns": "(list) List of blob hashes",
"examples": [
{
"title": "List your local blobs",
"curl": "curl -d'{\"method\": \"blob_list\", \"params\": {\"needed\": false, \"finished\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet blob list",
"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}"
}
]
},
{
"name": "blob_reflect",
"description": "Reflects specified blobs",
"arguments": [
{
"name": "reflector_server",
"type": "str",
"description": "reflector address",
"is_required": false
}
],
"returns": "(list) reflected blob hashes",
"examples": []
},
{
"name": "blob_reflect_all",
"description": "Reflects all saved blobs",
"arguments": [],
"returns": "(bool) true if successful",
"examples": []
}
]
},
"channel": {
"doc": "Create, update, abandon and list your channel claims.",
"commands": [
{
"name": "channel_abandon",
"description": "Abandon one of my channel claims.",
"arguments": [
{
"name": "claim_id",
"type": "str",
"description": "claim_id of the claim to abandon",
"is_required": false
},
{
"name": "txid",
"type": "str",
"description": "txid of the claim to abandon",
"is_required": false
},
{
"name": "nout",
"type": "int",
"description": "nout of the claim to abandon",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"is_required": false
},
{
"name": "blocking",
"type": "bool",
"description": "wait until abandon is in mempool",
"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 }",
"examples": [
{
"title": "Abandon a channel claim",
"curl": "curl -d'{\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet channel abandon 7e7b2f61a7166876ba28e34c415447072a4d13bd",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"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}"
}
]
},
{
"name": "channel_create",
"description": "Create a new channel by generating a channel private key and establishing an '@' prefixed claim.",
"arguments": [
{
"name": "name",
"type": "str",
"description": "name of the channel prefixed with '@'",
"is_required": true
},
{
"name": "allow_duplicate_name",
"type": "bool",
"description": "create new channel even if one already exists with given name. default: false.",
"is_required": false
},
{
"name": "bid",
"type": "decimal",
"description": "amount to back the claim",
"is_required": true
},
{
"name": "title",
"type": "str",
"description": "title of the publication",
"is_required": false
},
{
"name": "description",
"type": "str",
"description": "description of the publication",
"is_required": false
},
{
"name": "tags",
"type": "list",
"description": "content tags",
"is_required": false
},
{
"name": "languages",
"type": "list",
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
"is_required": false
},
{
"name": "locations",
"type": "list",
"description": "locations of the channel, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
"is_required": false
},
{
"name": "contact_email",
"type": "str",
"description": "email of channel owner",
"is_required": false
},
{
"name": "homepage_url",
"type": "str",
"description": "homepage url",
"is_required": false
},
{
"name": "thumbnail_url",
"type": "str",
"description": "thumbnail url",
"is_required": false
},
{
"name": "cover_url",
"type": "str",
"description": "url of cover image",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "id of the account to store channel",
"is_required": false
},
{
"name": "claim_address",
"type": "str",
"description": "address where the channel is sent to, if not specified it will be determined automatically from the account",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"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 }",
"examples": [
{
"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/",
"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()",
"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}"
}
]
},
{
"name": "channel_export",
"description": "Export serialized channel signing information for a given certificate claim id",
"arguments": [
{
"name": "claim_id",
"type": "str",
"description": "Claim ID to export information about",
"is_required": true
}
],
"returns": "(str) Serialized certificate information",
"examples": []
},
{
"name": "channel_import",
"description": "Import serialized channel signing information (to allow signing new claims to the channel)",
"arguments": [
{
"name": "serialized_certificate_info",
"type": "str",
"description": "certificate info",
"is_required": true
}
],
"returns": "(dict) Result dictionary",
"examples": []
},
{
"name": "channel_list",
"description": "List my channel claims.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"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 }",
"examples": [
{
"title": "List your channel claims",
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet channel list",
"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}"
},
{
"title": "Paginate your channel claims",
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"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()",
"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}"
}
]
},
{
"name": "channel_update",
"description": "Update an existing channel claim.",
"arguments": [
{
"name": "claim_id",
"type": "str",
"description": "claim_id of the channel to update",
"is_required": true
},
{
"name": "bid",
"type": "decimal",
"description": "amount to back the claim",
"is_required": false
},
{
"name": "title",
"type": "str",
"description": "title of the publication",
"is_required": false
},
{
"name": "description",
"type": "str",
"description": "description of the publication",
"is_required": false
},
{
"name": "clear_tags",
"type": "bool",
"description": "clear existing tags (prior to adding new ones)",
"is_required": false
},
{
"name": "tags",
"type": "list",
"description": "add content tags",
"is_required": false
},
{
"name": "clear_languages",
"type": "bool",
"description": "clear existing languages (prior to adding new ones)",
"is_required": false
},
{
"name": "languages",
"type": "list",
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
"is_required": false
},
{
"name": "clear_locations",
"type": "bool",
"description": "clear existing locations (prior to adding new ones)",
"is_required": false
},
{
"name": "locations",
"type": "list",
"description": "locations of the channel, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
"is_required": false
},
{
"name": "contact_email",
"type": "str",
"description": "email of channel owner",
"is_required": false
},
{
"name": "homepage_url",
"type": "str",
"description": "homepage url",
"is_required": false
},
{
"name": "thumbnail_url",
"type": "str",
"description": "thumbnail url",
"is_required": false
},
{
"name": "cover_url",
"type": "str",
"description": "url of cover image",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "id of the account to store channel",
"is_required": false
},
{
"name": "claim_address",
"type": "str",
"description": "address where the channel is sent",
"is_required": false
},
{
"name": "new_signing_key",
"type": "bool",
"description": "generate a new signing key, will invalidate all previous publishes",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"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 }",
"examples": [
{
"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/",
"lbrynet": "lbrynet channel update 7e7b2f61a7166876ba28e34c415447072a4d13bd --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()",
"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}"
}
]
}
]
},
"claim": {
"doc": "List and search all types of claims.",
"commands": [
{
"name": "claim_list",
"description": "List my stream and channel claims.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to query",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"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 }",
"examples": [
{
"title": "List all your claims",
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet claim list",
"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}"
},
{
"title": "Paginate your claims",
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"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()",
"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}"
}
]
},
{
"name": "claim_search",
"description": "Search for stream and channel claims on the blockchain.\n\nUse --channel_id=<channel_id> to list all stream claims in a channel.",
"arguments": [
{
"name": "name",
"type": "str",
"description": "find claims with this name",
"is_required": false
},
{
"name": "claim_id",
"type": "str",
"description": "find a claim with this claim_id",
"is_required": false
},
{
"name": "txid",
"type": "str",
"description": "find a claim with this txid:nout",
"is_required": false
},
{
"name": "nout",
"type": "str",
"description": "find a claim with this txid:nout",
"is_required": false
},
{
"name": "channel_id",
"type": "str",
"description": "limit search to specific channel claim id (returns stream claims)",
"is_required": false
},
{
"name": "winning",
"type": "bool",
"description": "limit to winning claims",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"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 }",
"examples": [
{
"title": "Search for all claims in channel",
"curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"channel_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"winning\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet claim search --channel_id=\"7e7b2f61a7166876ba28e34c415447072a4d13bd\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_search\", \"params\": {\"channel_id\": \"7e7b2f61a7166876ba28e34c415447072a4d13bd\", \"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}"
},
{
"title": "Search for claims matching a name",
"curl": "curl -d'{\"method\": \"claim_search\", \"params\": {\"name\": \"astream\", \"winning\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet claim search --name=\"astream\"",
"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}"
}
]
}
]
},
"comment": {
"doc": "Create and list comments.",
"commands": [
{
"name": "comment_create",
"description": "Create and associate a comment with a claim using your channel identity.",
"arguments": [
{
"name": "parent_comment_id",
"type": "int",
"description": "The ID of a comment to make a response to",
"is_required": false
}
],
"returns": "(dict) Comment object if successfully made",
"examples": []
},
{
"name": "comment_list",
"description": "List comments associated with a claim.",
"arguments": [
{
"name": "flat",
"type": "bool",
"description": "Flag to indicate whether or not you want the replies to be flattened along with the rest of the comments attached to the claim. Off by default",
"is_required": false
},
{
"name": "parent_comment_id",
"type": "int",
"description": "The ID of an existing comment to list replies from",
"is_required": false
},
{
"name": "max_replies_shown",
"type": "int",
"description": "For every comment that we pull replies from, only retrieve up to this amount. Note: This is not the same as page size.",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "The page you'd like to see in the comment list. The first page is 1, second page is 2, and so on.",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "The amount of comments that you'd like to retrieve in one request",
"is_required": false
}
],
"returns": "(dict) Dict containing the following schema:\n {\n \"page\": (int) The page of comments as provided when limiting response to page_size.\n \"page_size\": (int) Number of comments in the given page. -1 if page_size wasn't used\n \"comments\": (list) Contains all the comments (as dicts) as provided by the specified parameters\n }",
"examples": []
}
]
},
"file": {
"doc": "File management.",
"commands": [
{
"name": "file_delete",
"description": "Delete a LBRY file",
"arguments": [
{
"name": "delete_from_download_dir",
"type": "bool",
"description": "delete file from download directory, instead of just deleting blobs",
"is_required": false
},
{
"name": "delete_all",
"type": "bool",
"description": "if there are multiple matching files, allow the deletion of multiple files. Otherwise do not delete anything.",
"is_required": false
},
{
"name": "sd_hash",
"type": "str",
"description": "delete by file sd hash",
"is_required": false
},
{
"name": "file_name",
"type": "str",
"description": "delete by file name in downloads folder",
"is_required": false
},
{
"name": "stream_hash",
"type": "str",
"description": "delete by file stream hash",
"is_required": false
},
{
"name": "rowid",
"type": "int",
"description": "delete by file row id",
"is_required": false
},
{
"name": "claim_id",
"type": "str",
"description": "delete by file claim id",
"is_required": false
},
{
"name": "txid",
"type": "str",
"description": "delete by file claim txid",
"is_required": false
},
{
"name": "nout",
"type": "int",
"description": "delete by file claim nout",
"is_required": false
},
{
"name": "claim_name",
"type": "str",
"description": "delete by file claim name",
"is_required": false
},
{
"name": "channel_claim_id",
"type": "str",
"description": "delete by file channel claim id",
"is_required": false
},
{
"name": "channel_name",
"type": "str",
"description": "delete by file channel claim name",
"is_required": false
}
],
"returns": "(bool) true if deletion was successful",
"examples": [
{
"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/",
"lbrynet": "lbrynet file delete --claim_id=\"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_delete\", \"params\": {\"delete_from_download_dir\": false, \"delete_all\": false, \"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": true\n}"
}
]
},
{
"name": "file_list",
"description": "List files limited by optional filters",
"arguments": [
{
"name": "sd_hash",
"type": "str",
"description": "get file with matching sd hash",
"is_required": false
},
{
"name": "file_name",
"type": "str",
"description": "get file with matching file name in the downloads folder",
"is_required": false
},
{
"name": "stream_hash",
"type": "str",
"description": "get file with matching stream hash",
"is_required": false
},
{
"name": "rowid",
"type": "int",
"description": "get file with matching row id",
"is_required": false
},
{
"name": "claim_id",
"type": "str",
"description": "get file with matching claim id",
"is_required": false
},
{
"name": "outpoint",
"type": "str",
"description": "get file with matching claim outpoint",
"is_required": false
},
{
"name": "txid",
"type": "str",
"description": "get file with matching claim txid",
"is_required": false
},
{
"name": "nout",
"type": "int",
"description": "get file with matching claim nout",
"is_required": false
},
{
"name": "channel_claim_id",
"type": "str",
"description": "get file with matching channel claim id",
"is_required": false
},
{
"name": "channel_name",
"type": "str",
"description": "get file with matching channel name",
"is_required": false
},
{
"name": "claim_name",
"type": "str",
"description": "get file with matching claim name",
"is_required": false
},
{
"name": "blobs_in_stream<blobs_in_stream>",
"type": "int",
"description": "get file with matching blobs in stream",
"is_required": false
},
{
"name": "blobs_remaining",
"type": "int",
"description": "amount of remaining blobs to download",
"is_required": false
},
{
"name": "sort",
"type": "str",
"description": "field to sort by (one of the above filter fields)",
"is_required": false
},
{
"name": "comparison",
"type": "str",
"description": "logical comparision, (eq | ne | g | ge | l | le)",
"is_required": false
}
],
"returns": " [\n {\n \"completed\": \"(bool) true if download is completed\",\n \"file_name\": \"(str) name of file\",\n \"download_directory\": \"(str) download directory\",\n \"points_paid\": \"(float) credit paid to download file\",\n \"stopped\": \"(bool) true if download is stopped\",\n \"stream_hash\": \"(str) stream hash of file\",\n \"stream_name\": \"(str) stream name\",\n \"suggested_file_name\": \"(str) suggested file name\",\n \"sd_hash\": \"(str) sd hash of file\",\n \"download_path\": \"(str) download path of file\",\n \"mime_type\": \"(str) mime type of file\",\n \"key\": \"(str) key attached to file\",\n \"total_bytes_lower_bound\": \"(int) lower bound file size in bytes\",\n \"total_bytes\": \"(int) file upper bound size in bytes\",\n \"written_bytes\": \"(int) written size in bytes\",\n \"blobs_completed\": \"(int) number of fully downloaded blobs\",\n \"blobs_in_stream\": \"(int) total blobs on stream\",\n \"blobs_remaining\": \"(int) total blobs remaining to download\",\n \"status\": \"(str) downloader status\",\n \"claim_id\": \"(str) None if claim is not found else the claim id\",\n \"txid\": \"(str) None if claim is not found else the transaction id\",\n \"nout\": \"(int) None if claim is not found else the transaction output index\",\n \"outpoint\": \"(str) None if claim is not found else the tx and output\",\n \"metadata\": \"(dict) None if claim is not found else the claim metadata\",\n \"channel_claim_id\": \"(str) None if claim is not found or not signed\",\n \"channel_name\": \"(str) None if claim is not found or not signed\",\n \"claim_name\": \"(str) None if claim is not found else the claim name\"\n }\n ]",
"examples": [
{
"title": "List local files",
"curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"reverse\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet file list",
"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}"
},
{
"title": "List files matching a parameter",
"curl": "curl -d'{\"method\": \"file_list\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"reverse\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet file list --claim_id=\"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"file_list\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"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}"
}
]
},
{
"name": "file_reflect",
"description": "Reflect all the blobs in a file matching the filter criteria",
"arguments": [
{
"name": "sd_hash",
"type": "str",
"description": "get file with matching sd hash",
"is_required": false
},
{
"name": "file_name",
"type": "str",
"description": "get file with matching file name in the downloads folder",
"is_required": false
},
{
"name": "stream_hash",
"type": "str",
"description": "get file with matching stream hash",
"is_required": false
},
{
"name": "rowid",
"type": "int",
"description": "get file with matching row id",
"is_required": false
},
{
"name": "reflector",
"type": "str",
"description": "reflector server, ip address or url by default choose a server from the config",
"is_required": false
}
],
"returns": "(list) list of blobs reflected",
"examples": []
},
{
"name": "file_set_status",
"description": "Start or stop downloading a file",
"arguments": [
{
"name": "status",
"type": "str",
"description": "one of \"start\" or \"stop\"",
"is_required": true
},
{
"name": "sd_hash",
"type": "str",
"description": "set status of file with matching sd hash",
"is_required": false
},
{
"name": "file_name",
"type": "str",
"description": "set status of file with matching file name in the downloads folder",
"is_required": false
},
{
"name": "stream_hash",
"type": "str",
"description": "set status of file with matching stream hash",
"is_required": false
},
{
"name": "rowid",
"type": "int",
"description": "set status of file with matching row id",
"is_required": false
}
],
"returns": "(str) Confirmation message",
"examples": []
}
]
},
"peer": {
"doc": "DHT / Blob Exchange peer commands.",
"commands": [
{
"name": "peer_list",
"description": "Get peers for blob hash",
"arguments": [
{
"name": "blob_hash",
"type": "str",
"description": "find available peers for this blob hash",
"is_required": true
},
{
"name": "search_bottom_out_limit",
"type": "int",
"description": "the number of search probes in a row that don't find any new peers before giving up and returning",
"is_required": false
}
],
"returns": "(list) List of contact dictionaries {'address': <peer ip>, 'udp_port': <dht port>, 'tcp_port': <peer port>,\n 'node_id': <peer node id>}",
"examples": []
},
{
"name": "peer_ping",
"description": "Send a kademlia ping to the specified peer. If address and port are provided the peer is directly pinged,\nif not provided the peer is located first.",
"arguments": [],
"returns": "(str) pong, or {'error': <error message>} if an error is encountered",
"examples": []
}
]
},
"settings": {
"doc": "Settings management.",
"commands": [
{
"name": "settings_get",
"description": "Get daemon settings",
"arguments": [],
"returns": "(dict) Dictionary of daemon settings\n See ADJUSTABLE_SETTINGS in lbrynet/conf.py for full list of settings",
"examples": [
{
"title": "Get settings",
"curl": "curl -d'{\"method\": \"settings_get\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet settings get",
"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}"
}
]
},
{
"name": "settings_set",
"description": "Set daemon settings",
"arguments": [],
"returns": "(dict) Updated dictionary of daemon settings",
"examples": []
}
]
},
"stream": {
"doc": "Create, update, abandon, list and inspect your stream claims.",
"commands": [
{
"name": "stream_abandon",
"description": "Abandon one of my stream claims.",
"arguments": [
{
"name": "claim_id",
"type": "str",
"description": "claim_id of the claim to abandon",
"is_required": false
},
{
"name": "txid",
"type": "str",
"description": "txid of the claim to abandon",
"is_required": false
},
{
"name": "nout",
"type": "int",
"description": "nout of the claim to abandon",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"is_required": false
},
{
"name": "blocking",
"type": "bool",
"description": "wait until abandon is in mempool",
"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 }",
"examples": [
{
"title": "Abandon a stream claim",
"curl": "curl -d'{\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet stream abandon 36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b\", \"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}"
}
]
},
{
"name": "stream_cost_estimate",
"description": "Get estimated cost for a lbry stream",
"arguments": [
{
"name": "uri",
"type": "str",
"description": "uri to use",
"is_required": true
}
],
"returns": "(float) Estimated cost in lbry credits, returns None if uri is not\n resolvable",
"examples": []
},
{
"name": "stream_create",
"description": "Make a new stream claim and announce the associated file to lbrynet.",
"arguments": [
{
"name": "name",
"type": "str",
"description": "name of the content (can only consist of a-z A-Z 0-9 and -(dash))",
"is_required": true
},
{
"name": "allow_duplicate_name",
"type": "bool",
"description": "create new claim even if one already exists with given name. default: false.",
"is_required": false
},
{
"name": "bid",
"type": "decimal",
"description": "amount to back the claim",
"is_required": true
},
{
"name": "file_path",
"type": "str",
"description": "path to file to be associated with name.",
"is_required": true
},
{
"name": "stream_type",
"type": "str",
"description": "type of stream",
"is_required": false
},
{
"name": "fee_currency",
"type": "string",
"description": "specify fee currency",
"is_required": false
},
{
"name": "fee_amount",
"type": "decimal",
"description": "content download fee",
"is_required": false
},
{
"name": "fee_address",
"type": "str",
"description": "address where to send fee payments, will use value from --claim_address if not provided",
"is_required": false
},
{
"name": "title",
"type": "str",
"description": "title of the publication",
"is_required": false
},
{
"name": "description",
"type": "str",
"description": "description of the publication",
"is_required": false
},
{
"name": "author",
"type": "str",
"description": "author of the publication. The usage for this field is not the same as for channels. The author field is used to credit an author who is not the publisher and is not represented by the channel. For example, a pdf file of 'The Odyssey' has an author of 'Homer' but may by published to a channel such as '@classics', or to no channel at all",
"is_required": false
},
{
"name": "tags",
"type": "list",
"description": "add content tags",
"is_required": false
},
{
"name": "languages",
"type": "list",
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
"is_required": false
},
{
"name": "locations",
"type": "list",
"description": "locations relevant to the stream, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
"is_required": false
},
{
"name": "license",
"type": "str",
"description": "publication license",
"is_required": false
},
{
"name": "license_url",
"type": "str",
"description": "publication license url",
"is_required": false
},
{
"name": "thumbnail_url",
"type": "str",
"description": "thumbnail url",
"is_required": false
},
{
"name": "release_time",
"type": "int",
"description": "original public release of content, seconds since UNIX epoch",
"is_required": false
},
{
"name": "duration",
"type": "int",
"description": "audio/video duration in seconds, an attempt will be made to calculate this automatically if not provided",
"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
},
{
"name": "channel_id",
"type": "str",
"description": "claim id of the publisher channel",
"is_required": false
},
{
"name": "channel_account_id",
"type": "str",
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "account to use for funding the transaction",
"is_required": false
},
{
"name": "claim_address",
"type": "str",
"description": "address where the claim is sent to, if not specified it will be determined automatically from the account",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"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 }",
"examples": [
{
"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/",
"lbrynet": "lbrynet stream create astream 1.0 /tmp/tmp9rj4qtvp",
"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()",
"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}"
}
]
},
{
"name": "stream_list",
"description": "List my stream claims.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to query",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"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 }",
"examples": [
{
"title": "List all your stream claims",
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet stream list",
"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}"
},
{
"title": "Paginate your stream claims",
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"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()",
"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}"
}
]
},
{
"name": "stream_update",
"description": "Update an existing stream claim and if a new file is provided announce it to lbrynet.",
"arguments": [
{
"name": "claim_id",
"type": "str",
"description": "id of the stream claim to update",
"is_required": true
},
{
"name": "bid",
"type": "decimal",
"description": "amount to back the claim",
"is_required": false
},
{
"name": "file_path",
"type": "str",
"description": "path to file to be associated with name.",
"is_required": false
},
{
"name": "fee_currency",
"type": "string",
"description": "specify fee currency",
"is_required": false
},
{
"name": "fee_amount",
"type": "decimal",
"description": "content download fee",
"is_required": false
},
{
"name": "fee_address",
"type": "str",
"description": "address where to send fee payments, will use value from --claim_address if not provided",
"is_required": false
},
{
"name": "title",
"type": "str",
"description": "title of the publication",
"is_required": false
},
{
"name": "description",
"type": "str",
"description": "description of the publication",
"is_required": false
},
{
"name": "author",
"type": "str",
"description": "author of the publication. The usage for this field is not the same as for channels. The author field is used to credit an author who is not the publisher and is not represented by the channel. For example, a pdf file of 'The Odyssey' has an author of 'Homer' but may by published to a channel such as '@classics', or to no channel at all",
"is_required": false
},
{
"name": "clear_tags",
"type": "bool",
"description": "clear existing tags (prior to adding new ones)",
"is_required": false
},
{
"name": "tags",
"type": "list",
"description": "add content tags",
"is_required": false
},
{
"name": "clear_languages",
"type": "bool",
"description": "clear existing languages (prior to adding new ones)",
"is_required": false
},
{
"name": "languages",
"type": "list",
"description": "languages used by the channel, using RFC 5646 format, eg: for English `--languages=en` for Spanish (Spain) `--languages=es-ES` for Spanish (Mexican) `--languages=es-MX` for Chinese (Simplified) `--languages=zh-Hans` for Chinese (Traditional) `--languages=zh-Hant`",
"is_required": false
},
{
"name": "clear_locations",
"type": "bool",
"description": "clear existing locations (prior to adding new ones)",
"is_required": false
},
{
"name": "locations",
"type": "list",
"description": "locations relevant to the stream, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... \"locations\": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: \"COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE\" making sure to include colon for blank values, for example to provide only the city: ... --locations=\"::Manchester\" with all values set: ... --locations=\"US:NH:Manchester:03101:42.990605:-71.460989\" optionally, you can just pass the \"LATITUDE:LONGITUDE\": ... --locations=\"42.990605:-71.460989\" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations=\"{'country': 'US', 'state': 'NH'}\"",
"is_required": false
},
{
"name": "license",
"type": "str",
"description": "publication license",
"is_required": false
},
{
"name": "license_url",
"type": "str",
"description": "publication license url",
"is_required": false
},
{
"name": "thumbnail_url",
"type": "str",
"description": "thumbnail url",
"is_required": false
},
{
"name": "release_time",
"type": "int",
"description": "original public release of content, seconds since UNIX epoch",
"is_required": false
},
{
"name": "stream_type",
"type": "str",
"description": "type of stream",
"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
},
{
"name": "channel_id",
"type": "str",
"description": "claim id of the publisher channel",
"is_required": false
},
{
"name": "clear_channel",
"type": "bool",
"description": "remove channel signature",
"is_required": false
},
{
"name": "channel_account_id",
"type": "str",
"description": "one or more account ids for accounts to look in for channel certificates, defaults to all accounts.",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "account to use for funding the transaction",
"is_required": false
},
{
"name": "claim_address",
"type": "str",
"description": "address where the claim is sent to, if not specified it will be determined automatically from the account",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"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 }",
"examples": [
{
"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/",
"lbrynet": "lbrynet stream update 36b69bf8a8eefb44a7e6cc33cae8f1dfe0a7fc8b --channel_id=\"7e7b2f61a7166876ba28e34c415447072a4d13bd\"",
"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()",
"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}"
}
]
}
]
},
"support": {
"doc": "Create, list and abandon all types of supports.",
"commands": [
{
"name": "support_abandon",
"description": "Abandon supports, including tips, of a specific claim, optionally\nkeeping some amount as supports.",
"arguments": [
{
"name": "claim_id",
"type": "str",
"description": "claim_id of the claim to abandon",
"is_required": false
},
{
"name": "txid",
"type": "str",
"description": "txid of the claim to abandon",
"is_required": false
},
{
"name": "nout",
"type": "int",
"description": "nout of the claim to abandon",
"is_required": false
},
{
"name": "keep",
"type": "decimal",
"description": "amount of lbc to keep as support",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"is_required": false
},
{
"name": "blocking",
"type": "bool",
"description": "wait until abandon is in mempool",
"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 }",
"examples": []
},
{
"name": "support_create",
"description": "Create a support or a tip for name claim.",
"arguments": [
{
"name": "claim_id",
"type": "str",
"description": "claim_id of the claim to support",
"is_required": true
},
{
"name": "amount",
"type": "decimal",
"description": "amount of support",
"is_required": true
},
{
"name": "tip",
"type": "bool",
"description": "send support to claim owner, default: false.",
"is_required": false
},
{
"name": "account_id",
"type": "str",
"description": "id of the account to use",
"is_required": false
},
{
"name": "preview",
"type": "bool",
"description": "do not broadcast the transaction",
"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 }",
"examples": []
},
{
"name": "support_list",
"description": "List supports and tips in my control.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to query",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"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 }",
"examples": []
}
]
},
"sync": {
"doc": "Wallet synchronization.",
"commands": [
{
"name": "sync_apply",
"description": "Apply incoming synchronization data, if provided, and then produce a sync hash and\nan encrypted wallet.",
"arguments": [
{
"name": "password",
"type": "str",
"description": "password to decrypt incoming and encrypt outgoing data",
"is_required": false
},
{
"name": "data",
"type": "str",
"description": "incoming sync data, if any",
"is_required": false
},
{
"name": "encrypt-password",
"type": "str",
"description": "password to encrypt outgoing data if different from the decrypt password, used during password changes",
"is_required": false
}
],
"returns": "(map) sync hash and data",
"examples": []
},
{
"name": "sync_hash",
"description": "Deterministic hash of the wallet.",
"arguments": [],
"returns": "(str) sha256 hash of wallet",
"examples": []
}
]
},
"transaction": {
"doc": "Transaction management.",
"commands": [
{
"name": "transaction_list",
"description": "List transactions belonging to wallet",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to query",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"is_required": false
}
],
"returns": "(list) List of transactions\n\n {\n \"claim_info\": (list) claim info if in txn [{\n \"address\": (str) address of claim,\n \"balance_delta\": (float) bid amount,\n \"amount\": (float) claim amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"nout\": (int) nout\n }],\n \"abandon_info\": (list) abandon info if in txn [{\n \"address\": (str) address of abandoned claim,\n \"balance_delta\": (float) returned amount,\n \"amount\": (float) claim amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"nout\": (int) nout\n }],\n \"confirmations\": (int) number of confirmations for the txn,\n \"date\": (str) date and time of txn,\n \"fee\": (float) txn fee,\n \"support_info\": (list) support info if in txn [{\n \"address\": (str) address of support,\n \"balance_delta\": (float) support amount,\n \"amount\": (float) support amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"is_tip\": (bool),\n \"nout\": (int) nout\n }],\n \"timestamp\": (int) timestamp,\n \"txid\": (str) txn id,\n \"update_info\": (list) update info if in txn [{\n \"address\": (str) address of claim,\n \"balance_delta\": (float) credited/debited\n \"amount\": (float) absolute amount,\n \"claim_id\": (str) claim id,\n \"claim_name\": (str) claim name,\n \"nout\": (int) nout\n }],\n \"value\": (float) value of txn\n }",
"examples": [
{
"title": "List your transactions",
"curl": "curl -d'{\"method\": \"transaction_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet transaction list",
"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}"
}
]
},
{
"name": "transaction_show",
"description": "Get a decoded transaction from a txid",
"arguments": [
{
"name": "txid",
"type": "str",
"description": "txid of the transaction",
"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 }",
"examples": []
}
]
},
"utxo": {
"doc": "Unspent transaction management.",
"commands": [
{
"name": "utxo_list",
"description": "List unspent transaction outputs",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to query",
"is_required": false
},
{
"name": "page",
"type": "int",
"description": "page to return during paginating",
"is_required": false
},
{
"name": "page_size",
"type": "int",
"description": "number of items on page during pagination",
"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 }",
"examples": []
},
{
"name": "utxo_release",
"description": "When spending a UTXO it is locally locked to prevent double spends;\noccasionally this can result in a UTXO being locked which ultimately\ndid not get spent (failed to broadcast, spend transaction was not\naccepted by blockchain node, etc). This command releases the lock\non all UTXOs in your account.",
"arguments": [
{
"name": "account_id",
"type": "str",
"description": "id of the account to query",
"is_required": false
}
],
"returns": "None",
"examples": []
}
]
}
}
View git blame Copy permalink