Madiator2011/lbry-sdk
1
0
Fork 0
forked from LBRYCommunity/lbry-sdk
Code Pull requests Activity

put generated commands in groups

Browse source
This commit is contained in:
Lex Berezhny 2019-04-11 15:35:24 -04:00
parent a63442f843
commit 0200756218
2 changed files with 2375 additions and 2235 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

809
docs/api.json
View file

@ -1,4 +1,314 @@
[ {
"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": []
},
{
"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/tmp58em_rnh\", \"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/tmp58em_rnh",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmp58em_rnh\", \"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\": \"010000000173ed5c2414baa4f2f2d3aedce18312510420743f74386aab5e64520804ce50c9010000006b483045022100cda21b501d2763e15742f9a1a266d43555d3ec3c2e000a81760b6faa810d5aa2022042402eff5fe09731d49a32905a2c210f50e5450f97d3a0f47677a60b7df13074012102de62a927d0db6b118b874300cc12e72c28e381143aa22c7a6e79bf5b5d9a8eedffffffff0200e1f505000000007eb50c612d6e65772d73747265616d4c53000a500a308a0ac8cf32786fc0016c71b307a49bde617905f55cad910c5d813b82726b4b59aa135d86c242827da58ffbf6d239c49b6a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d7576a91425e53459905ec458fa65a09f7e93ca79ea39805288ac60666529000000001976a9142eb2307ae86fb3d2149c0f28fc344455170d048388ac00000000\",\n \"inputs\": [\n {\n \"address\": \"n1W7vfUACax5LnKA8quJqFG6xZpFkYuX3K\",\n \"amount\": \"7.969219\",\n \"confirmations\": 3,\n \"height\": 210,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"miyKsZNnX6gNboZqma7NAEsPGLLGejnoTv\",\n \"amount\": \"1.0\",\n \"claim_id\": \"680ac85335e6d8512f47a141be3e0be721ad781f\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"a-new-stream\",\n \"nout\": 0,\n \"permanent_url\": \"a-new-stream#680ac85335e6d8512f47a141be3e0be721ad781f\",\n \"txid\": \"460bba52d2420a8a89bc1f7d950b27dc560ee89365d71ef72fd085b75ba33a70\",\n \"type\": \"claim\",\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"8a0ac8cf32786fc0016c71b307a49bde617905f55cad910c5d813b82726b4b59aa135d86c242827da58ffbf6d239c49b\"\n }\n }\n },\n {\n \"address\": \"mjmrqh9kxNgk6vqKm1QHNuNN42JS7AHeQX\",\n \"amount\": \"6.945112\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"460bba52d2420a8a89bc1f7d950b27dc560ee89365d71ef72fd085b75ba33a70\"\n }\n ],\n \"total_fee\": \"0.024107\",\n \"total_input\": \"7.969219\",\n \"total_output\": \"7.945112\",\n \"txid\": \"460bba52d2420a8a89bc1f7d950b27dc560ee89365d71ef72fd085b75ba33a70\"\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": []
},
{
"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": []
},
{
"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": []
}
]
},
"account": {
"doc": "Create, modify and inspect wallet accounts.",
"commands": [
{ {
"name": "account_add", "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.", "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.",
@ -38,10 +348,10 @@
"examples": [ "examples": [
{ {
"title": "Add an account from seed.", "title": "Add an account from seed.",
"curl": "curl -d'{\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"genuine case gate always artwork taxi garden hurdle shed detect proud east\", \"single_key\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"trophy memory bachelor car credit various cart sleep success evolve marine float\", \"single_key\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet account add \"new account\" --seed=\"genuine case gate always artwork taxi garden hurdle shed detect proud east\"", "lbrynet": "lbrynet account add \"new account\" --seed=\"trophy memory bachelor car credit various cart sleep success evolve marine float\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"genuine case gate always artwork taxi garden hurdle shed detect proud east\", \"single_key\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_add\", \"params\": {\"account_name\": \"new account\", \"seed\": \"trophy memory bachelor car credit various cart sleep success evolve marine float\", \"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\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1554578686.081968,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeWRzJjSXgb4TP7QdWM5pkwry7bcDcjkameXUw4AWmfLh3ibCLPxQmvxaHcXsCjQNjrQDrvCyt5XmJitAVMmAVtn4zL1E5kR\",\n \"public_key\": \"tpubD6NzVbkrYhZ4XyTnCP785ziZx8vZfgGjLFTkQ7eX31Yyc8nFZSz6x9xZDqo4PjSxeFUYWqnEAswz7KjMvFZmdrgGWFLvf6eByVkMWH4hwjc\",\n \"seed\": \"genuine case gate always artwork taxi garden hurdle shed detect proud east\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555011096.6462603,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeb9X2FHnAwvxx9vP9YXjaPgVbUYEGSmemVbK5B2g2ZRjsG4ywci8GYArdD63j5ZZu3KCYW5C3FrTtsLqRVehXF4MhAPDNGK\",\n \"public_key\": \"tpubD6NzVbkrYhZ4Y4BJutxNaMb5XBSKJsie9hHGszaXgia3byr5hZrGD43c3SRT3MhHaW7Ynx56NcmePMUGYRZzWYJKfe4JNRkpF7DvY98fZc9\",\n \"seed\": \"trophy memory bachelor car credit various cart sleep success evolve marine float\"\n }\n}"
} }
] ]
}, },
@ -89,7 +399,7 @@
"curl": "curl -d'{\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet account create \"generated account\"", "lbrynet": "lbrynet account create \"generated account\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_create\", \"params\": {\"account_name\": \"generated account\", \"single_key\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1554578685.924084,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeWRzJjSXgb4TP7QdWM5pkwry7bcDcjkameXUw4AWmfLh3ibCLPxQmvxaHcXsCjQNjrQDrvCyt5XmJitAVMmAVtn4zL1E5kR\",\n \"public_key\": \"tpubD6NzVbkrYhZ4XyTnCP785ziZx8vZfgGjLFTkQ7eX31Yyc8nFZSz6x9xZDqo4PjSxeFUYWqnEAswz7KjMvFZmdrgGWFLvf6eByVkMWH4hwjc\",\n \"seed\": \"genuine case gate always artwork taxi garden hurdle shed detect proud east\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555011096.475507,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeb9X2FHnAwvxx9vP9YXjaPgVbUYEGSmemVbK5B2g2ZRjsG4ywci8GYArdD63j5ZZu3KCYW5C3FrTtsLqRVehXF4MhAPDNGK\",\n \"public_key\": \"tpubD6NzVbkrYhZ4Y4BJutxNaMb5XBSKJsie9hHGszaXgia3byr5hZrGD43c3SRT3MhHaW7Ynx56NcmePMUGYRZzWYJKfe4JNRkpF7DvY98fZc9\",\n \"seed\": \"trophy memory bachelor car credit various cart sleep success evolve marine float\"\n }\n}"
} }
] ]
}, },
@ -201,7 +511,7 @@
"curl": "curl -d'{\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet account list", "lbrynet": "lbrynet account list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_list\", \"params\": {\"include_claims\": false, \"show_seed\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"lbc_regtest\": [\n {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"certificates\": 0,\n \"coins\": 10.0,\n \"encrypted\": false,\n \"id\": \"n3UZZjeevho2mMnnsXkZerQAYtBqwXjSbw\",\n \"is_default\": true,\n \"name\": \"Account #n3UZZjeevho2mMnnsXkZerQAYtBqwXjSbw\",\n \"public_key\": \"tpubD6NzVbkrYhZ4WpBr62Lh2vWJyfbZ3HWSxySHpLuQzHcVmQ4r76xMENjZnQhc6JEagf4gHzbXD6Y5nBVbhzQnQ4VfZPZYQramFkmciky9FJm\",\n \"satoshis\": 1000000000\n }\n ]\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"lbc_regtest\": [\n {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"certificates\": 0,\n \"coins\": 10.0,\n \"encrypted\": false,\n \"id\": \"mvjX3tyidVu3CgUtiAGxy71UEtzZ7YFpX6\",\n \"is_default\": true,\n \"name\": \"Account #mvjX3tyidVu3CgUtiAGxy71UEtzZ7YFpX6\",\n \"public_key\": \"tpubD6NzVbkrYhZ4YgXfgGVzU4sx4LtcfQ1X5pZECeZKVr5DvisjWkYQzvR1zwkYspUx1C8yKXhNNFvHV9jfsJkvQhjBpcgarYAdnWZMf6fvW4N\",\n \"satoshis\": 1000000000\n }\n ]\n }\n}"
} }
] ]
}, },
@ -248,10 +558,10 @@
"examples": [ "examples": [
{ {
"title": "Remove an account.", "title": "Remove an account.",
"curl": "curl -d'{\"method\": \"account_remove\", \"params\": {\"account_id\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\"}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_remove\", \"params\": {\"account_id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\"}}' http://localhost:5279/",
"lbrynet": "lbrynet account remove mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ", "lbrynet": "lbrynet account remove moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_remove\", \"params\": {\"account_id\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\"}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_remove\", \"params\": {\"account_id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\"}}).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\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1554578685.924084,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeWRzJjSXgb4TP7QdWM5pkwry7bcDcjkameXUw4AWmfLh3ibCLPxQmvxaHcXsCjQNjrQDrvCyt5XmJitAVMmAVtn4zL1E5kR\",\n \"public_key\": \"tpubD6NzVbkrYhZ4XyTnCP785ziZx8vZfgGjLFTkQ7eX31Yyc8nFZSz6x9xZDqo4PjSxeFUYWqnEAswz7KjMvFZmdrgGWFLvf6eByVkMWH4hwjc\",\n \"seed\": \"genuine case gate always artwork taxi garden hurdle shed detect proud east\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 1\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555011096.475507,\n \"name\": \"generated account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeb9X2FHnAwvxx9vP9YXjaPgVbUYEGSmemVbK5B2g2ZRjsG4ywci8GYArdD63j5ZZu3KCYW5C3FrTtsLqRVehXF4MhAPDNGK\",\n \"public_key\": \"tpubD6NzVbkrYhZ4Y4BJutxNaMb5XBSKJsie9hHGszaXgia3byr5hZrGD43c3SRT3MhHaW7Ynx56NcmePMUGYRZzWYJKfe4JNRkpF7DvY98fZc9\",\n \"seed\": \"trophy memory bachelor car credit various cart sleep success evolve marine float\"\n }\n}"
} }
] ]
}, },
@ -326,10 +636,10 @@
"examples": [ "examples": [
{ {
"title": "Modify maximum number of times a change address can be reused.", "title": "Modify maximum number of times a change address can be reused.",
"curl": "curl -d'{\"method\": \"account_set\", \"params\": {\"account_id\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\", \"default\": false, \"change_max_uses\": 10}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"account_set\", \"params\": {\"account_id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\", \"default\": false, \"change_max_uses\": 10}}' http://localhost:5279/",
"lbrynet": "lbrynet account set mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ --change_max_uses=10", "lbrynet": "lbrynet account set moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh --change_max_uses=10",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_set\", \"params\": {\"account_id\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\", \"default\": false, \"change_max_uses\": 10}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"account_set\", \"params\": {\"account_id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\", \"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\": \"mt2Eqt55iczBA95pVQdy65ze9ozYToSVGZ\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1554578686.1519668,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeWRzJjSXgb4TP7QdWM5pkwry7bcDcjkameXUw4AWmfLh3ibCLPxQmvxaHcXsCjQNjrQDrvCyt5XmJitAVMmAVtn4zL1E5kR\",\n \"public_key\": \"tpubD6NzVbkrYhZ4XyTnCP785ziZx8vZfgGjLFTkQ7eX31Yyc8nFZSz6x9xZDqo4PjSxeFUYWqnEAswz7KjMvFZmdrgGWFLvf6eByVkMWH4hwjc\",\n \"seed\": \"genuine case gate always artwork taxi garden hurdle shed detect proud east\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"address_generator\": {\n \"change\": {\n \"gap\": 6,\n \"maximum_uses_per_address\": 10\n },\n \"name\": \"deterministic-chain\",\n \"receiving\": {\n \"gap\": 20,\n \"maximum_uses_per_address\": 1\n }\n },\n \"encrypted\": false,\n \"id\": \"moJ5trHnfdqzgBJbDx3feLn2Cv1MExZTdh\",\n \"is_default\": false,\n \"ledger\": \"lbc_regtest\",\n \"modified_on\": 1555011096.6999621,\n \"name\": \"new account\",\n \"private_key\": \"tprv8ZgxMBicQKsPeb9X2FHnAwvxx9vP9YXjaPgVbUYEGSmemVbK5B2g2ZRjsG4ywci8GYArdD63j5ZZu3KCYW5C3FrTtsLqRVehXF4MhAPDNGK\",\n \"public_key\": \"tpubD6NzVbkrYhZ4Y4BJutxNaMb5XBSKJsie9hHGszaXgia3byr5hZrGD43c3SRT3MhHaW7Ynx56NcmePMUGYRZzWYJKfe4JNRkpF7DvY98fZc9\",\n \"seed\": \"trophy memory bachelor car credit various cart sleep success evolve marine float\"\n }\n}"
} }
] ]
}, },
@ -346,7 +656,12 @@
], ],
"returns": "(bool) true if account is unlocked, otherwise false", "returns": "(bool) true if account is unlocked, otherwise false",
"examples": [] "examples": []
}
]
}, },
"address": {
"doc": "List, generate and verify addresses.",
"commands": [
{ {
"name": "address_is_mine", "name": "address_is_mine",
"description": "Checks if an address is associated with the current wallet.", "description": "Checks if an address is associated with the current wallet.",
@ -406,7 +721,12 @@
], ],
"returns": " \"an address in base58\"", "returns": " \"an address in base58\"",
"examples": [] "examples": []
}
]
}, },
"blob": {
"doc": "Blob management.",
"commands": [
{ {
"name": "blob_announce", "name": "blob_announce",
"description": "Announce blobs to the DHT", "description": "Announce blobs to the DHT",
@ -537,27 +857,12 @@
"arguments": [], "arguments": [],
"returns": "(bool) true if successful", "returns": "(bool) true if successful",
"examples": [] "examples": []
},
{
"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": []
}, },
"channel": {
"doc": "Create, update, abandon and list your channel claims.",
"commands": [
{ {
"name": "channel_abandon", "name": "channel_abandon",
"description": "Abandon one of my channel claims.", "description": "Abandon one of my channel claims.",
@ -603,10 +908,10 @@
"examples": [ "examples": [
{ {
"title": "Abandon a channel claim.", "title": "Abandon a channel claim.",
"curl": "curl -d'{\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet channel abandon 4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca", "lbrynet": "lbrynet channel abandon 02c88be784f7c59f1aea7a228a7eba11145a3597",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\", \"preview\": false, \"blocking\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_abandon\", \"params\": {\"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\", \"preview\": false, \"blocking\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001580c84ee9be8da1151ea7ee8af0c031f5b8dd4eee8bd9fa6dc3b8779cdccf183000000006b483045022100bcc0ad41eee030496499b36b13af239bfe05515f01b39ddd32e9e643fbbe4ea002202e9a702aa9b31e62deb4f67caaab02f40f8e7d01910269003a792cefbd95902a01210329e2491076fee9936796ed96e0c0b1f66f5a9a8055cebdfac3bbc35036069f2effffffff0134b7f505000000001976a914f7ce87cdb10655286266c59bc3ca142fcc7c55e188ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": 4,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"n47EcRe3PKjzBGxgRq9ixtMBomhCzCBKaR\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"9758b74391f5b739d3e76372acc0eaba7daba669290246c920106fa2019c0abe\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"9758b74391f5b739d3e76372acc0eaba7daba669290246c920106fa2019c0abe\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001029e7c6ec2a0293012786faaf0cfb34cfeace45d9b236b94e80b44ce6ff708f1000000006a47304402200d2c27198b82fccfe90c2b9ef0a35939251bcc713e73ca96a48e17219f78811602203c65a7ae7b32a76b40b1f50d901f9ad2435bc6829cd71a23d2b7b0124d71c0c20121023d9d7aaad5179974fa540116980ebd3a44dca6b9217bdef52756f96a538ba10dffffffff0134b7f505000000001976a91481fa1571050b7ff98cc8428be31852a3559c99b588ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": 4,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"msND3vYzt4YymqsBf9BnkLABrYhug2mqAs\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"060094cf7066c1c3a366bf46e3d917853dcceb6ecde5d664b59c62178cfe70cb\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"060094cf7066c1c3a366bf46e3d917853dcceb6ecde5d664b59c62178cfe70cb\"\n }\n}"
} }
] ]
}, },
@ -712,7 +1017,7 @@
"curl": "curl -d'{\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet channel create @channel 1.0", "lbrynet": "lbrynet channel create @channel 1.0",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_create\", \"params\": {\"name\": \"@channel\", \"bid\": \"1.0\", \"tags\": [], \"languages\": [], \"locations\": [], \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000011745d6605014dfed1bfbfadc83a6b7d64afd5a4799c6786ea46ea201f29384ec000000006b483045022100eb417b5bb035ae79b0acb786d81f4e00b0ebe130f63756c8d9e2a33ff85fceeb02206c9e8f6877de0803da1141d9a5fd4cefed997dcdb53f0659f57843863fee0dfb012103225b54913ee6c9b8c32c012b836412d7b8fe8bfcb1ee64bb0ad6d41fed377874ffffffff0200e1f5050000000084b508406368616e6e656c4c5d00125a0a583056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa06d7576a914bae97ac3fa178afbe668e45a2e663e112ba3531488ac34558c35000000001976a9142351e1e4e0d07d20acdc1effc923f492bb572aac88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"n2YHMk1Do5azQTjLhkXaHMQBTKj534o8j2\",\n \"amount\": \"10.0\",\n \"confirmations\": 6,\n \"height\": 201,\n \"is_change\": false,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"ec8493f201a26ea46e78c699475afd4ad6b7a683dcfafb1beddf145060d64517\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"85175f2cda9d4d8e9566d376d49e09612cc293042f5af0e4e24b0c79b0328303\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\"\n }\n }\n },\n {\n \"address\": \"miji34FcSCGLnovtK7FHezB19f1wG9PmGy\",\n \"amount\": \"8.983893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"85175f2cda9d4d8e9566d376d49e09612cc293042f5af0e4e24b0c79b0328303\"\n }\n ],\n \"total_fee\": \"0.016107\",\n \"total_input\": \"10.0\",\n \"total_output\": \"9.983893\",\n \"txid\": \"85175f2cda9d4d8e9566d376d49e09612cc293042f5af0e4e24b0c79b0328303\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"01000000010b61013a100e4555547517f46c0e467da6ce94851c712056ecd729e1cc18576a000000006a4730440220681a4afee2a358d082b2aead2d9dc85e4dd818b8dee92ecba3cbc33eb58b9d06022018282e301e51a93fa6a016ae2575eb227b71e5565c8a80f3e6adade7891cdf84012103c4299ce539d3226e01ee0447d75846ff4be74542975d4d2bbd871dfb6ae9a489ffffffff0200e1f5050000000084b508406368616e6e656c4c5d00125a0a583056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a66d7576a91412ec8de4feb1f1b86129b9ec83d4e3b10773053188ac34558c35000000001976a914f5352fe26daeed6ee9e2083f35b4a99a2a9b497388ac00000000\",\n \"inputs\": [\n {\n \"address\": \"n3HSkygWsGB1ofzt9iqD9gqgeaWNtwCRUq\",\n \"amount\": \"10.0\",\n \"confirmations\": 6,\n \"height\": 201,\n \"is_change\": false,\n \"is_mine\": true,\n \"nout\": 0,\n \"txid\": \"6a5718cce129d7ec5620711c8594cea67d460e6cf417755455450e103a01610b\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f1171f8d410f3f8b08025b0ca73cddf4c4fa8cd608c5d0ded46ba1e31db1b0bc\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\"\n }\n }\n },\n {\n \"address\": \"n3sVZZ3vRZfdyWsHTN8mZtrBWbG8yp49Mh\",\n \"amount\": \"8.983893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"f1171f8d410f3f8b08025b0ca73cddf4c4fa8cd608c5d0ded46ba1e31db1b0bc\"\n }\n ],\n \"total_fee\": \"0.016107\",\n \"total_input\": \"10.0\",\n \"total_output\": \"9.983893\",\n \"txid\": \"f1171f8d410f3f8b08025b0ca73cddf4c4fa8cd608c5d0ded46ba1e31db1b0bc\"\n }\n}"
} }
] ]
}, },
@ -774,14 +1079,14 @@
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet channel list", "lbrynet": "lbrynet channel list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\",\n \"title\": \"New Channel\"\n }\n }\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\",\n \"title\": \"New Channel\"\n }\n }\n }\n ]\n}"
}, },
{ {
"title": "Paginate your channel claims.", "title": "Paginate your channel claims.",
"curl": "curl -d'{\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"lbrynet": "lbrynet channel list --page=1 --page_size=20", "lbrynet": "lbrynet channel list --page=1 --page_size=20",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}"
} }
] ]
}, },
@ -902,13 +1207,18 @@
"examples": [ "examples": [
{ {
"title": "Update a channel claim.", "title": "Update a channel claim.",
"curl": "curl -d'{\"method\": \"channel_update\", \"params\": {\"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\", \"title\": \"New Channel\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"channel_update\", \"params\": {\"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\", \"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 4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca --title=\"New Channel\"", "lbrynet": "lbrynet channel update 02c88be784f7c59f1aea7a228a7eba11145a3597 --title=\"New Channel\"",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_update\", \"params\": {\"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\", \"title\": \"New Channel\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"new_signing_key\": false, \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"channel_update\", \"params\": {\"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\", \"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\": \"0100000002038332b0790c4be2e4f05a2f0493c22c61099ed476d366958e4d9dda2c5f1785000000006a4730440220138d6a363f747f5b0c681a2a0f3c2b4fb58127abe7f565689a20dd075d78765e022033b007af8690c35709f8fe52fb5c276b49375a67ca997da64856187cd2e9ad3801210329e2491076fee9936796ed96e0c0b1f66f5a9a8055cebdfac3bbc35036069f2effffffff038332b0790c4be2e4f05a2f0493c22c61099ed476d366958e4d9dda2c5f1785010000006b483045022100d095c03ff65fe9ab282553a54a46d7b3051b0050deb74bec731c0ac5df42ad4002207385ec2d2a21a54de7163f069e7a481a3de4038bbb0987a1e2b4fd6f394db63901210252322d9463992edfb8174afbe65d3796e99f85a2717a1d48c5da7472b7f8d840ffffffff0200e1f50500000000a6b708406368616e6e656c14ca24697d111bbff340674d5dbdbfd6f2a8ee164a4c6a0012670a583056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0120b4e6577204368616e6e656c6d6d76a914bae97ac3fa178afbe668e45a2e663e112ba3531488ac52ec8b35000000001976a9141a26538f62e38b72d64de7a85c294d49b6db613988ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": 1,\n \"height\": 207,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"85175f2cda9d4d8e9566d376d49e09612cc293042f5af0e4e24b0c79b0328303\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\",\n \"title\": \"New Channel\"\n }\n }\n },\n {\n \"address\": \"miji34FcSCGLnovtK7FHezB19f1wG9PmGy\",\n \"amount\": \"8.983893\",\n \"confirmations\": 1,\n \"height\": 207,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"85175f2cda9d4d8e9566d376d49e09612cc293042f5af0e4e24b0c79b0328303\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\",\n \"title\": \"New Channel\"\n }\n }\n },\n {\n \"address\": \"mhuDn1MuVGvtrntW8bJo9UWoKJySqvp755\",\n \"amount\": \"8.9836245\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\"\n }\n ],\n \"total_fee\": \"0.0002685\",\n \"total_input\": \"9.983893\",\n \"total_output\": \"9.9836245\",\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000002bcb0b11de3a16bd4ded0c508d68cfac4f4dd3ca70c5b02088b3f0f418d1f17f1000000006a47304402206ac83eff342bbc440561adf21a21de346df24ea6589c95c7b10c369d73ba50b202204183f7903d7e3fdf85261b8450ed54483cb1d9bdf80149c8a3ec353f0883d58b0121023d9d7aaad5179974fa540116980ebd3a44dca6b9217bdef52756f96a538ba10dffffffffbcb0b11de3a16bd4ded0c508d68cfac4f4dd3ca70c5b02088b3f0f418d1f17f1010000006b4830450221008546450b1f09de0c1182ec9711a402cb717ff704417a12d32d6a69543299dc30022043e831c9f6d15fd296d67f9993e496e99b90161d92fa06621e08b601e7b030d40121038226ace3450f2a7643f346fb528737c889025ab52b9475b77356882bf6be71c3ffffffff0200e1f50500000000a6b708406368616e6e656c1497355a1411ba7e8a227aea1a9fc5f784e78bc8024c6a0012670a583056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6120b4e6577204368616e6e656c6d6d76a91412ec8de4feb1f1b86129b9ec83d4e3b10773053188ac52ec8b35000000001976a91405b8f68ca9f2014ce3174a350942a0dcec3f409088ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": 1,\n \"height\": 207,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f1171f8d410f3f8b08025b0ca73cddf4c4fa8cd608c5d0ded46ba1e31db1b0bc\",\n \"type\": \"claim\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\",\n \"title\": \"New Channel\"\n }\n }\n },\n {\n \"address\": \"n3sVZZ3vRZfdyWsHTN8mZtrBWbG8yp49Mh\",\n \"amount\": \"8.983893\",\n \"confirmations\": 1,\n \"height\": 207,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"f1171f8d410f3f8b08025b0ca73cddf4c4fa8cd608c5d0ded46ba1e31db1b0bc\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\",\n \"title\": \"New Channel\"\n }\n }\n },\n {\n \"address\": \"mg3DFURFBatuLXANZUcwu7xrr3abYEThVd\",\n \"amount\": \"8.9836245\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\"\n }\n ],\n \"total_fee\": \"0.0002685\",\n \"total_input\": \"9.983893\",\n \"total_output\": \"9.9836245\",\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\"\n }\n}"
}
]
} }
] ]
}, },
"claim": {
"doc": "List and search all types of claims.",
"commands": [
{ {
"name": "claim_list", "name": "claim_list",
"description": "List my stream and channel claims.", "description": "List my stream and channel claims.",
@ -939,14 +1249,14 @@
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"claim_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet claim list", "lbrynet": "lbrynet claim list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\",\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\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n },\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\",\n \"title\": \"New Channel\"\n }\n }\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\",\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\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n },\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\",\n \"title\": \"New Channel\"\n }\n }\n }\n ]\n}"
}, },
{ {
"title": "Paginate your claims.", "title": "Paginate your claims.",
"curl": "curl -d'{\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"lbrynet": "lbrynet claim list --page=1 --page_size=20", "lbrynet": "lbrynet claim list --page=1 --page_size=20",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"claim_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\",\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\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n },\n {\n \"address\": \"mxZFgBHkn6RJZiWqq6UQ8USJp6BSVHYeBf\",\n \"amount\": \"1.0\",\n \"claim_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\",\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a03420004885fa84952f41c19546a2f3f1a1a7cda0148c5bed6710e688c526f60692f3749753855f8d035ebb2a215df1a34982391f1987b7ad21e26132050ae791bb4aaa0\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\",\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\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n },\n {\n \"address\": \"mhF1qax8PUjYskk4EAQMFwoBR6skzHRdaC\",\n \"amount\": \"1.0\",\n \"claim_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"confirmations\": 3,\n \"height\": 208,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"@channel\",\n \"nout\": 0,\n \"permanent_url\": \"@channel#02c88be784f7c59f1aea7a228a7eba11145a3597\",\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\",\n \"type\": \"update\",\n \"value\": {\n \"channel\": {\n \"public_key\": \"3056301006072a8648ce3d020106052b8104000a034200044e4ed47db0706c29d3d7bf38488a15d9f764892608746342cd90b1ded09890912498220b93c0ac3cf174b8f86dacad9c637f4b7132bebe8577b708168d1c76a6\",\n \"title\": \"New Channel\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}"
} }
] ]
}, },
@ -1005,7 +1315,69 @@
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"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": [] "examples": []
}
]
}, },
"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", "name": "file_delete",
"description": "Delete a LBRY file", "description": "Delete a LBRY file",
@ -1259,33 +1631,12 @@
], ],
"returns": "(str) Confirmation message", "returns": "(str) Confirmation message",
"examples": [] "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": "(dict) Dictionary containing information about the stream\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': (int) file 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 'status': (str) downloader status,\n 'claim_id': (str) claim id,\n 'outpoint': (str) claim outpoint string,\n 'txid': (str) claim txid,\n 'nout': (int) claim nout,\n 'metadata': (dict) claim metadata,\n 'channel_claim_id': (str) None if claim is not signed\n 'channel_name': (str) None if claim is not signed\n 'claim_name': (str) claim name\n }",
"examples": []
}, },
"peer": {
"doc": "DHT / Blob Exchange peer commands.",
"commands": [
{ {
"name": "peer_list", "name": "peer_list",
"description": "Get peers for blob hash", "description": "Get peers for blob hash",
@ -1312,242 +1663,12 @@
"arguments": [], "arguments": [],
"returns": "(str) pong, or {'error': <error message>} if an error is encountered", "returns": "(str) pong, or {'error': <error message>} if an error is encountered",
"examples": [] "examples": []
},
{
"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/tmpqaqmfma7\", \"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/tmpqaqmfma7",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"publish\", \"params\": {\"name\": \"a-new-stream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpqaqmfma7\", \"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\": \"0100000001ab9e30b7ea08d9f163ef5455eca8ba59dc563788bf4a0fe4f23b38f683be890a010000006b483045022100efbf985a6cfa258d49ab657ea79b7e4685e1676a29012ee1fd990e8ea88835c50220766d0281301bfd21ce3d4ac8ca12864741d8855fa602eb779ad50e0d1ce8cda4012103fdec70ea82c7cefd3c6d4fe9753f389da3fa4c97bedd6edf1d84ae45fc1c18bcffffffff0200e1f505000000007eb50c612d6e65772d73747265616d4c53000a500a307b38925d55d2886f0ab5544cf79fc303f2849133d89743cd5519afce7e96d9c98301edbcc67dc7fc761402d62b5946986a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d7576a9142c1c1ca4bfd5901dbefeb0bff8a4ff5a25e8482988ac60666529000000001976a914cd9549eaa2ef51559108ac9d5cfaf934796f940588ac00000000\",\n \"inputs\": [\n {\n \"address\": \"n2mXrUnikFTVYwAqQHKWFG4XjVMgGLqfM3\",\n \"amount\": \"7.969219\",\n \"confirmations\": 3,\n \"height\": 210,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mjYBhk3Av25ewuBy4mLFzABP5paicSbt2g\",\n \"amount\": \"1.0\",\n \"claim_id\": \"2dfb6c2602b790b9cc25d30b7e264fc1d5f5d081\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"a-new-stream\",\n \"nout\": 0,\n \"permanent_url\": \"a-new-stream#2dfb6c2602b790b9cc25d30b7e264fc1d5f5d081\",\n \"txid\": \"14a821ce9071d0e854214e0c41b3639520184881152faf62db3595ad80bc48e5\",\n \"type\": \"claim\",\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"7b38925d55d2886f0ab5544cf79fc303f2849133d89743cd5519afce7e96d9c98301edbcc67dc7fc761402d62b594698\"\n }\n }\n },\n {\n \"address\": \"mzFyf9DgTUvLJ7qEEYdvF5cDWkc8s5jg5q\",\n \"amount\": \"6.945112\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"14a821ce9071d0e854214e0c41b3639520184881152faf62db3595ad80bc48e5\"\n }\n ],\n \"total_fee\": \"0.024107\",\n \"total_input\": \"7.969219\",\n \"total_output\": \"7.945112\",\n \"txid\": \"14a821ce9071d0e854214e0c41b3639520184881152faf62db3595ad80bc48e5\"\n }\n}"
} }
] ]
}, },
{ "settings": {
"name": "resolve", "doc": "Settings management.",
"description": "Get the claim that a URL refers to.", "commands": [
"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": []
},
{
"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": "settings_get", "name": "settings_get",
"description": "Get daemon settings", "description": "Get daemon settings",
@ -1561,21 +1682,12 @@
"arguments": [], "arguments": [],
"returns": "(dict) Updated dictionary of daemon settings", "returns": "(dict) Updated dictionary of daemon settings",
"examples": [] "examples": []
}
]
}, },
{ "stream": {
"name": "status", "doc": "Create, update, abandon, list and inspect your stream claims.",
"description": "Get daemon status", "commands": [
"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": []
},
{
"name": "stop",
"description": "Stop lbrynet API server.",
"arguments": [],
"returns": "(string) Shutdown message",
"examples": []
},
{ {
"name": "stream_abandon", "name": "stream_abandon",
"description": "Abandon one of my stream claims.", "description": "Abandon one of my stream claims.",
@ -1621,10 +1733,10 @@
"examples": [ "examples": [
{ {
"title": "Abandon a stream claim.", "title": "Abandon a stream claim.",
"curl": "curl -d'{\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\", \"preview\": false, \"blocking\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet stream abandon 23d67f3b1fdb3c7eb1649db09f02165a2be5440f", "lbrynet": "lbrynet stream abandon 3b05b027fca4f83fafe64e150b8d76f5e69955dc",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\", \"preview\": false, \"blocking\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_abandon\", \"params\": {\"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\", \"preview\": false, \"blocking\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001ab9e30b7ea08d9f163ef5455eca8ba59dc563788bf4a0fe4f23b38f683be890a000000006a473044022060fb7367dab92a28368ea677a2f9b91ac2f1af1c43efc0c9c51891c3673c01a502200950a5b4e178ea4f4591158d2cff984ee021c92ff6f1533503aaf656ad2c5537012103bd2ca037d6553e04cc11b075727d519aabb63156e3cfe408fccaed0613ccb236ffffffff0134b7f505000000001976a914388a6a8dcd7a1ecfe1b3401a410c9c539fbbee2f88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\",\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\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mkfux8BAHKFVnDhDEi4FJCwafb2r7B1qbp\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"cdfa39b01b02fced4ccd160862b96f4b760b060e56e7be67b48b7c2fadeb9cbb\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"cdfa39b01b02fced4ccd160862b96f4b760b060e56e7be67b48b7c2fadeb9cbb\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"010000000173ed5c2414baa4f2f2d3aedce18312510420743f74386aab5e64520804ce50c9000000006a47304402207b3a1a0f1af9dcc7ed8bfa3c0c4299da25ed9784e0e7923c3852676174310d10022047ac02343aa687a28b50aa04a1ff9109dc7fa3527b76c9b6d1f8042b46a4ed0101210288d5b9ec46bede072ef6364a9dddc6bab167b24e68a56357d50966d89330e7f7ffffffff0134b7f505000000001976a9144743fdd1201e8a0ff0303d2a11a7b3beabece34188ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\",\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\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mn1miobtmBGjh8afpv5r22STUoXb2YCo4k\",\n \"amount\": \"0.999893\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 0,\n \"txid\": \"ae42773bc4c5195f137785dd50dd9e7429e2e84ed33fe95e6aec0eb55ea70730\"\n }\n ],\n \"total_fee\": \"0.000107\",\n \"total_input\": \"1.0\",\n \"total_output\": \"0.999893\",\n \"txid\": \"ae42773bc4c5195f137785dd50dd9e7429e2e84ed33fe95e6aec0eb55ea70730\"\n }\n}"
} }
] ]
}, },
@ -1831,10 +1943,10 @@
"examples": [ "examples": [
{ {
"title": "Create a stream claim.", "title": "Create a stream claim.",
"curl": "curl -d'{\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpn86l47l_\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpn4xw2e9u\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet stream create astream 1.0 /tmp/tmpn86l47l_", "lbrynet": "lbrynet stream create astream 1.0 /tmp/tmpn4xw2e9u",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpn86l47l_\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_create\", \"params\": {\"name\": \"astream\", \"bid\": \"1.0\", \"file_path\": \"/tmp/tmpn4xw2e9u\", \"tags\": [], \"languages\": [], \"locations\": [], \"channel_account_id\": [], \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001580c84ee9be8da1151ea7ee8af0c031f5b8dd4eee8bd9fa6dc3b8779cdccf183010000006b483045022100d190acebaafb852ce0d31a8f6984e783b279af3950daabe869bd49ee8d91891e02201d4a26eeef99ef66fdbfed51ad5779d10819aefded8c85032585024e7e52e9420121029bb8b59dd4a55236bb6d88c764eecb3f02aec6c53f17a7c26e3dc5cc14e92ff4ffffffff0200e1f5050000000079b5076173747265616d4c53000a500a3070914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b76a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d7576a9140ebb098fff5ea0d6b33d5dc92fe2397db2a53a7c88acc684802f000000001976a914d4f7c80a9d2a4e92abcf37c3d4faa55bb48056c488ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mhuDn1MuVGvtrntW8bJo9UWoKJySqvp755\",\n \"amount\": \"8.9836245\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"83f1cccd79873bdca69fbde8eed48d5b1f030cafe87eea5111dae89bee840c58\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"05b9cead0bcbae7d485c7c13e8dea561bd7d48e89eefe133df4ad39016f8b9f6\",\n \"type\": \"claim\",\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n },\n {\n \"address\": \"mzw2NsnSHKHobtBR12T7XcUsJAFZ48mVmp\",\n \"amount\": \"7.9695175\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"05b9cead0bcbae7d485c7c13e8dea561bd7d48e89eefe133df4ad39016f8b9f6\"\n }\n ],\n \"total_fee\": \"0.014107\",\n \"total_input\": \"8.9836245\",\n \"total_output\": \"8.9695175\",\n \"txid\": \"05b9cead0bcbae7d485c7c13e8dea561bd7d48e89eefe133df4ad39016f8b9f6\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000001029e7c6ec2a0293012786faaf0cfb34cfeace45d9b236b94e80b44ce6ff708f1010000006a47304402204781bd711a53a5ad3fd645782a95170ea9cb4c2f22df5a595d05026272ef2c8e02207c07a41d564f04d937fe30dce7b04fbc660514e55f88c75a142cb6ca5e16d77f0121035297dbc46cac1b14decd40841287da38b3ad262c513e595d6f45f4310c033943ffffffff0200e1f5050000000079b5076173747265616d4c53000a500a30f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd6716a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d7576a914382e9b4e0d28915bfc8d4cd5f43f4ac1d3b99ef788acc684802f000000001976a9144427d5d5ad070365ae993e0b93d118119ba1460d88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mg3DFURFBatuLXANZUcwu7xrr3abYEThVd\",\n \"amount\": \"8.9836245\",\n \"confirmations\": 1,\n \"height\": 208,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"f108f76fce440be8946b239b5de4acfe4cb3cff0aa6f78123029a0c26e7c9e02\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"f5b8f304f4760fda1eef3a6b361c84bdb437c45a6e9e03791b52eb6b34d814db\",\n \"type\": \"claim\",\n \"value\": {\n \"stream\": {\n \"file\": {\n \"size\": \"11\"\n },\n \"media_type\": \"application/octet-stream\",\n \"sd_hash\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n },\n {\n \"address\": \"mmjKxuLDA93onA2VHNEjA5apmQDc3ndX9D\",\n \"amount\": \"7.9695175\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"f5b8f304f4760fda1eef3a6b361c84bdb437c45a6e9e03791b52eb6b34d814db\"\n }\n ],\n \"total_fee\": \"0.014107\",\n \"total_input\": \"8.9836245\",\n \"total_output\": \"8.9695175\",\n \"txid\": \"f5b8f304f4760fda1eef3a6b361c84bdb437c45a6e9e03791b52eb6b34d814db\"\n }\n}"
} }
] ]
}, },
@ -1868,14 +1980,14 @@
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_list\", \"params\": {}}' http://localhost:5279/",
"lbrynet": "lbrynet stream list", "lbrynet": "lbrynet stream list",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\",\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\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n }\n ]\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\",\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\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n }\n ]\n}"
}, },
{ {
"title": "Paginate your stream claims.", "title": "Paginate your stream claims.",
"curl": "curl -d'{\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}' http://localhost:5279/",
"lbrynet": "lbrynet stream list --page=1 --page_size=20", "lbrynet": "lbrynet stream list --page=1 --page_size=20",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_list\", \"params\": {\"page\": 1, \"page_size\": 20}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\",\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\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"items\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": 1,\n \"height\": 210,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\",\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\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total_pages\": 1\n }\n}"
} }
] ]
}, },
@ -2080,13 +2192,18 @@
"examples": [ "examples": [
{ {
"title": "Update a stream claim to add channel.", "title": "Update a stream claim to add channel.",
"curl": "curl -d'{\"method\": \"stream_update\", \"params\": {\"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/", "curl": "curl -d'{\"method\": \"stream_update\", \"params\": {\"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}' http://localhost:5279/",
"lbrynet": "lbrynet stream update 23d67f3b1fdb3c7eb1649db09f02165a2be5440f --channel_id=4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca", "lbrynet": "lbrynet stream update 3b05b027fca4f83fafe64e150b8d76f5e69955dc --channel_id=02c88be784f7c59f1aea7a228a7eba11145a3597",
"python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_update\", \"params\": {\"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"4a16eea8f2d6bfbd5d4d6740f3bf1b117d6924ca\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}).json()", "python": "requests.post(\"http://localhost:5279\", json={\"method\": \"stream_update\", \"params\": {\"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\", \"tags\": [], \"clear_tags\": false, \"languages\": [], \"clear_languages\": false, \"locations\": [], \"clear_locations\": false, \"channel_id\": \"02c88be784f7c59f1aea7a228a7eba11145a3597\", \"clear_channel\": false, \"channel_account_id\": [], \"preview\": false}}).json()",
"output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000002f6b9f81690d34adf33e1ef9ee8487dbd61a5dee8137c5c487daecb0badceb905000000006b483045022100f051be0f3058a6923f0cd9da14adb5b8cd5761f4b961a3292628d7bc6ff68371022001a803a9531d22376e10c93c582a2f0f236556c50af523a721fe5cb868a59826012103bd2ca037d6553e04cc11b075727d519aabb63156e3cfe408fccaed0613ccb236fffffffff6b9f81690d34adf33e1ef9ee8487dbd61a5dee8137c5c487daecb0badceb905010000006b483045022100f44e5ea01a7c54bc462f7ea8d019a1a32d6b73bc17d3a67642a98edf3daa74e70220036cfc4ac4246dbe7afe955243d074884a7ea29e2bc0da464cea097669102f59012102253ff2c542f3585d423ca1758f580f2bca35c925d8ef73665bb643f53451070affffffff0200e1f50500000000e2b7076173747265616d140f44e52b5a16029fb09d64b17e3cdb1f3b7fd6234ca701ca24697d111bbff340674d5dbdbfd6f2a8ee164a26f9a3b767809abe05a29ce68cc3a085b8df42dcf4b5ced981ccac6377182a2df51ae32887babf97e58f6d796070b122f7b752172a6c8e3e97d011ef6b221fce0a500a3070914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b76a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d6d76a9140ebb098fff5ea0d6b33d5dc92fe2397db2a53a7c88ac2c10802f000000001976a914e91c7a8709926eaff7a6ff018dfd1582482e778288ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"05b9cead0bcbae7d485c7c13e8dea561bd7d48e89eefe133df4ad39016f8b9f6\",\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\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n },\n {\n \"address\": \"mzw2NsnSHKHobtBR12T7XcUsJAFZ48mVmp\",\n \"amount\": \"7.9695175\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"05b9cead0bcbae7d485c7c13e8dea561bd7d48e89eefe133df4ad39016f8b9f6\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mgrqpKg8jCxAGeruF1q9MdyvL9aCCGD1Bh\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#23d67f3b1fdb3c7eb1649db09f02165a2be5440f\",\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\",\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\": \"70914f894d32659607844c2ebb7c19f239c9e9e34a760bb910febc85f2f9d49db825954f74ed76de07f929aaf10f00b7\"\n }\n }\n },\n {\n \"address\": \"n2mXrUnikFTVYwAqQHKWFG4XjVMgGLqfM3\",\n \"amount\": \"7.969219\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\"\n }\n ],\n \"total_fee\": \"0.0002985\",\n \"total_input\": \"8.9695175\",\n \"total_output\": \"8.969219\",\n \"txid\": \"0a89be83f6383bf2e40f4abf883756dc59baa8ec5554ef63f1d908eab7309eab\"\n }\n}" "output": "{\n \"jsonrpc\": \"2.0\",\n \"result\": {\n \"height\": -2,\n \"hex\": \"0100000002db14d8346beb521b79039e6e5ac437b4bd841c366b3aef1eda0f76f404f3b8f5000000006a47304402204d63af22d8fc5b5c2b706d7257194b51bd3833f6cc42b7d7691ff3398fa3537002206275c10b0406b0b597293a9e651b145ad28d51e9e735cad8f40cc455480156ac01210288d5b9ec46bede072ef6364a9dddc6bab167b24e68a56357d50966d89330e7f7ffffffffdb14d8346beb521b79039e6e5ac437b4bd841c366b3aef1eda0f76f404f3b8f5010000006b483045022100e83e2b45b4067d25c1ed2cc2206c1bba051f8971ceac0bf2fb10d223573f0e8f022065eb238ebf9e9d4a94a335541a11b91d06a85173da0ba9e0a1f5cf107877885b012102fc806dddcd18695e6c71be8c65a799b51faa6071810c7d74609f03477642bd18ffffffff0200e1f50500000000e2b7076173747265616d14dc5599e6f5768d0b154ee6af3ff8a4fc27b0053b4ca70197355a1411ba7e8a227aea1a9fc5f784e78bc8029e6e068a58cae1dba378e818bd4bd004a2003f502fa1e9050c2f1ac6e55490814905eb71ad22f2f061be17c0f26e90689553840c9320991455c4a97366666f5d0a500a30f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd6716a186170706c69636174696f6e2f6f637465742d73747265616d7202100b6d6d76a914382e9b4e0d28915bfc8d4cd5f43f4ac1d3b99ef788ac2c10802f000000001976a914db3a23b267bd1d62a3ebe0eec54b972aaeee25fb88ac00000000\",\n \"inputs\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": false,\n \"is_mine\": true,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"f5b8f304f4760fda1eef3a6b361c84bdb437c45a6e9e03791b52eb6b34d814db\",\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\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n },\n {\n \"address\": \"mmjKxuLDA93onA2VHNEjA5apmQDc3ndX9D\",\n \"amount\": \"7.9695175\",\n \"confirmations\": 1,\n \"height\": 209,\n \"is_change\": true,\n \"is_mine\": true,\n \"nout\": 1,\n \"txid\": \"f5b8f304f4760fda1eef3a6b361c84bdb437c45a6e9e03791b52eb6b34d814db\"\n }\n ],\n \"outputs\": [\n {\n \"address\": \"mke1y5psaRqMuD8PmeiEb6StMDg3fABdh4\",\n \"amount\": \"1.0\",\n \"channel_name\": \"@channel\",\n \"claim_id\": \"3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"confirmations\": -2,\n \"height\": -2,\n \"name\": \"astream\",\n \"nout\": 0,\n \"permanent_url\": \"astream#3b05b027fca4f83fafe64e150b8d76f5e69955dc\",\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\",\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\": \"f82cd34187ec14c747054a079f32ab4f3f359e13c13db733bfbb84f34016edad5a439069920b9994f9637ee60c9bd671\"\n }\n }\n },\n {\n \"address\": \"n1W7vfUACax5LnKA8quJqFG6xZpFkYuX3K\",\n \"amount\": \"7.969219\",\n \"confirmations\": -2,\n \"height\": -2,\n \"nout\": 1,\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\"\n }\n ],\n \"total_fee\": \"0.0002985\",\n \"total_input\": \"8.9695175\",\n \"total_output\": \"8.969219\",\n \"txid\": \"c950ce040852645eab6a38743f742004511283e1dcaed3f2f2a4ba14245ced73\"\n }\n}"
}
]
} }
] ]
}, },
"support": {
"doc": "Create, list and abandon all types of supports.",
"commands": [
{ {
"name": "support_abandon", "name": "support_abandon",
"description": "Abandon supports, including tips, of a specific claim, optionally\nkeeping some amount as supports.", "description": "Abandon supports, including tips, of a specific claim, optionally\nkeeping some amount as supports.",
@ -2200,7 +2317,12 @@
], ],
"returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ]\n }", "returns": " {\n \"page\": \"Page number of the current items.\",\n \"page_size\": \"Number of items to show on a page.\",\n \"total_pages\": \"Total number of pages.\",\n \"items\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"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": [] "examples": []
}
]
}, },
"sync": {
"doc": "Wallet synchronization.",
"commands": [
{ {
"name": "sync_apply", "name": "sync_apply",
"description": "Apply incoming synchronization data, if provided, and then produce a sync hash and\nan encrypted wallet.", "description": "Apply incoming synchronization data, if provided, and then produce a sync hash and\nan encrypted wallet.",
@ -2233,7 +2355,12 @@
"arguments": [], "arguments": [],
"returns": "(str) sha256 hash of wallet", "returns": "(str) sha256 hash of wallet",
"examples": [] "examples": []
}
]
}, },
"transaction": {
"doc": "Transaction management.",
"commands": [
{ {
"name": "transaction_list", "name": "transaction_list",
"description": "List transactions belonging to wallet", "description": "List transactions belonging to wallet",
@ -2273,7 +2400,12 @@
], ],
"returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"outputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"nout\": \"position in the transaction\",\n \"amount\": \"value of the txo as a decimal\",\n \"address\": \"address of who can spend the txo\",\n \"confirmations\": \"number of confirmed blocks\"\n }\n ],\n \"total_input\": \"sum of inputs as a decimal\",\n \"total_output\": \"sum of outputs, sans fee, as a decimal\",\n \"total_fee\": \"fee amount\",\n \"hex\": \"entire transaction encoded in hex\"\n }", "returns": " {\n \"txid\": \"hash of transaction in hex\",\n \"height\": \"block where transaction was recorded\",\n \"inputs\": [\n {\n \"txid\": \"hash of transaction in hex\",\n \"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": [] "examples": []
}
]
}, },
"utxo": {
"doc": "Unspent transaction management.",
"commands": [
{ {
"name": "utxo_list", "name": "utxo_list",
"description": "List unspent transaction outputs", "description": "List unspent transaction outputs",
@ -2313,12 +2445,7 @@
], ],
"returns": "None", "returns": "None",
"examples": [] "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": []
} }
] ]
}
}

19
scripts/generate_json_api.py
View file

@ -265,9 +265,22 @@ def get_api(name, examples):
def write_api(f): def write_api(f):
examples = get_examples() examples = get_examples()
apis = [] api_definitions = Daemon.get_api_definitions()
for method_name in sorted(Daemon.callable_methods.keys()): apis = {
apis.append(get_api( 'main': {
'doc': 'Ungrouped commands.',
'commands': []
}
}
for group_name, group_doc in api_definitions['groups'].items():
apis[group_name] = {
'doc': group_doc,
'commands': []
}
for method_name, command in api_definitions['commands'].items():
if 'replaced_by' in command:
continue
apis[command['group'] or 'main']['commands'].append(get_api(
method_name, method_name,
examples.get(method_name, []) examples.get(method_name, [])
)) ))