lbry-sdk master

Methods and signatures provided by the lbry-sdk daemon are documented below. To build, download, or run the daemon, see the project README.

ffmpeg_find

Get ffmpeg installation information

Arguments

Returns

(dict) Dictionary of ffmpeg information
{
    'available': (bool) found ffmpeg,
    'which': (str) path to ffmpeg,
    'analyze_audio_volume': (bool) should ffmpeg analyze audio
}

get

Download stream from a LBRY name.

Arguments

• uri
  optionalstr
  uri of the content to download
• file_name
  optionalstr
  specified name for the downloaded file, overrides the stream file name
• download_directory
  optionalstr
  full path to the directory to download into
• timeout
  optionalint
  download timeout in number of seconds
• save_file
  optionalbool
  save the file to the downloads directory
• wallet_id
  optionalstr
  wallet to check for claim purchase receipts

Returns

{
    "streaming_url": "(str) url to stream the file using range requests",
    "completed": "(bool) true if download is completed",
    "file_name": "(str) name of file",
    "download_directory": "(str) download directory",
    "points_paid": "(float) credit paid to download file",
    "stopped": "(bool) true if download is stopped",
    "stream_hash": "(str) stream hash of file",
    "stream_name": "(str) stream name",
    "suggested_file_name": "(str) suggested file name",
    "sd_hash": "(str) sd hash of file",
    "download_path": "(str) download path of file",
    "mime_type": "(str) mime type of file",
    "key": "(str) key attached to file",
    "total_bytes_lower_bound": "(int) lower bound file size in bytes",
    "total_bytes": "(int) file upper bound size in bytes",
    "written_bytes": "(int) written size in bytes",
    "blobs_completed": "(int) number of fully downloaded blobs",
    "blobs_in_stream": "(int) total blobs on stream",
    "blobs_remaining": "(int) total blobs remaining to download",
    "status": "(str) downloader status",
    "claim_id": "(str) None if claim is not found else the claim id",
    "txid": "(str) None if claim is not found else the transaction id",
    "nout": "(int) None if claim is not found else the transaction output index",
    "outpoint": "(str) None if claim is not found else the tx and output",
    "metadata": "(dict) None if claim is not found else the claim metadata",
    "channel_claim_id": "(str) None if claim is not found or not signed",
    "channel_name": "(str) None if claim is not found or not signed",
    "claim_name": "(str) None if claim is not found else the claim name",
    "reflector_progress": "(int) reflector upload progress, 0 to 100",
    "uploading_to_reflector": "(bool) set to True when currently uploading to reflector"
}

publish

Create or replace a stream claim at a given name (use 'stream create/update' for more control).

Arguments

• name
  str
  name of the content (can only consist of a-z A-Z 0-9 and -(dash))
• bid
  optionaldecimal
  amount to back the claim
• file_path
  optionalstr
  path to file to be associated with name.
• file_name
  optionalstr
  name of file to be associated with stream.
• file_hash
  optionalstr
  hash of file to be associated with stream.
• validate_file
  optionalbool
  validate that the video container and encodings match common web browser support or that optimization succeeds if specified. FFmpeg is required
• optimize_file
  optionalbool
  transcode the video & audio if necessary to ensure common web browser support. FFmpeg is required
• fee_currency
  optionalstring
  specify fee currency
• fee_amount
  optionaldecimal
  content download fee
• fee_address
  optionalstr
  address where to send fee payments, will use value from --claim_address if not provided
• title
  optionalstr
  title of the publication
• description
  optionalstr
  description of the publication
• author
  optionalstr
  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
• tags
  optionallist
  add content tags
• languages
  optionallist
  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`
• locations
  optionallist
  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'}"
• license
  optionalstr
  publication license
• license_url
  optionalstr
  publication license url
• thumbnail_url
  optionalstr
  thumbnail url
• release_time
  optionalint
  original public release of content, seconds since UNIX epoch
• width
  optionalint
  image/video width, automatically calculated from media file
• height
  optionalint
  image/video height, automatically calculated from media file
• duration
  optionalint
  audio/video duration in seconds, automatically calculated
• sd_hash
  optionalstr
  sd_hash of stream
• channel_id
  optionalstr
  claim id of the publisher channel
• channel_name
  optionalstr
  name of publisher channel
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• account_id
  optionalstr
  account to use for holding the transaction
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the claim is sent to, if not specified it will be determined automatically from the account
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

resolve

Get the claim that a URL refers to.

Arguments

• urls
  optionalstr, list
  one or more urls to resolve
• wallet_id
  optionalstr
  wallet to check for claim purchase receipts
• new_sdk_server
  optionalstr
  URL of the new SDK server (EXPERIMENTAL)
• include_purchase_receipt
  optionalbool
  lookup and include a receipt if this wallet has purchased the claim being resolved
• include_is_my_output
  optionalbool
  lookup and include a boolean indicating if claim being resolved is yours
• include_sent_supports
  optionalbool
  lookup and sum the total amount of supports you've made to this claim
• include_sent_tips
  optionalbool
  lookup and sum the total amount of tips you've made to this claim (only makes sense when claim is not yours)
• include_received_tips
  optionalbool
  lookup and sum the total amount of tips you've received to this claim (only makes sense when claim is yours)

Returns

Dictionary of results, keyed by url
'': {
        If a resolution error occurs:
        'error': Error message

        If the url resolves to a channel or a claim in a channel:
        'certificate': {
            'address': (str) claim address,
            'amount': (float) claim amount,
            'effective_amount': (float) claim amount including supports,
            'claim_id': (str) claim id,
            'claim_sequence': (int) claim sequence number (or -1 if unknown),
            'decoded_claim': (bool) whether or not the claim value was decoded,
            'height': (int) claim height,
            'confirmations': (int) claim depth,
            'timestamp': (int) timestamp of the block that included this claim tx,
            'has_signature': (bool) included if decoded_claim
            'name': (str) claim name,
            'permanent_url': (str) permanent url of the certificate claim,
            'supports: (list) list of supports [{'txid': (str) txid,
                                                 'nout': (int) nout,
                                                 'amount': (float) amount}],
            'txid': (str) claim txid,
            'nout': (str) claim nout,
            'signature_is_valid': (bool), included if has_signature,
            'value': ClaimDict if decoded, otherwise hex string
        }

        If the url resolves to a channel:
        'claims_in_channel': (int) number of claims in the channel,

        If the url resolves to a claim:
        'claim': {
            'address': (str) claim address,
            'amount': (float) claim amount,
            'effective_amount': (float) claim amount including supports,
            'claim_id': (str) claim id,
            'claim_sequence': (int) claim sequence number (or -1 if unknown),
            'decoded_claim': (bool) whether or not the claim value was decoded,
            'height': (int) claim height,
            'depth': (int) claim depth,
            'has_signature': (bool) included if decoded_claim
            'name': (str) claim name,
            'permanent_url': (str) permanent url of the claim,
            'channel_name': (str) channel name if claim is in a channel
            'supports: (list) list of supports [{'txid': (str) txid,
                                                 'nout': (int) nout,
                                                 'amount': (float) amount}]
            'txid': (str) claim txid,
            'nout': (str) claim nout,
            'signature_is_valid': (bool), included if has_signature,
            'value': ClaimDict if decoded, otherwise hex string
        }
}

routing_table_get

Get DHT routing information

Arguments

Returns

(dict) dictionary containing routing and peer information
{
    "buckets": {
        : [
            {
                "address": (str) peer address,
                "udp_port": (int) peer udp port,
                "tcp_port": (int) peer tcp port,
                "node_id": (str) peer node id,
            }
        ]
    },
    "node_id": (str) the local dht node id
    "prefix_neighbors_count": (int) the amount of peers sharing the same byte prefix of the local node id
}

status

Get daemon status

Arguments

Returns

(dict) lbrynet-daemon status
{
    'installation_id': (str) installation id - base58,
    'is_running': (bool),
    'skipped_components': (list) [names of skipped components (str)],
    'startup_status': { Does not include components which have been skipped
        'blob_manager': (bool),
        'blockchain_headers': (bool),
        'database': (bool),
        'dht': (bool),
        'exchange_rate_manager': (bool),
        'hash_announcer': (bool),
        'peer_protocol_server': (bool),
        'file_manager': (bool),
        'libtorrent_component': (bool),
        'upnp': (bool),
        'wallet': (bool),
    },
    'connection_status': {
        'code': (str) connection status code,
        'message': (str) connection status message
    },
    'blockchain_headers': {
        'downloading_headers': (bool),
        'download_progress': (float) 0-100.0
    },
    'wallet': {
        'connected': (str) host and port of the connected spv server,
        'blocks': (int) local blockchain height,
        'blocks_behind': (int) remote_height - local_height,
        'best_blockhash': (str) block hash of most recent block,
        'is_encrypted': (bool),
        'is_locked': (bool),
        'connected_servers': (list) [
            {
                'host': (str) server hostname,
                'port': (int) server port,
                'latency': (int) milliseconds
            }
        ],
    },
    'libtorrent_component': {
        'running': (bool) libtorrent was detected and started successfully,
    },
    'dht': {
        'node_id': (str) lbry dht node id - hex encoded,
        'peers_in_routing_table': (int) the number of peers in the routing table,
    },
    'blob_manager': {
        'finished_blobs': (int) number of finished blobs in the blob manager,
        'connections': {
            'incoming_bps': {
                : (int) bytes per second received,
            },
            'outgoing_bps': {
                : (int) bytes per second sent,
            },
            'total_outgoing_mps': (float) megabytes per second sent,
            'total_incoming_mps': (float) megabytes per second received,
            'max_outgoing_mbs': (float) maximum bandwidth (megabytes per second) sent, since the
                                daemon was started
            'max_incoming_mbs': (float) maximum bandwidth (megabytes per second) received, since the
                                daemon was started
            'total_sent' : (int) total number of bytes sent since the daemon was started
            'total_received' : (int) total number of bytes received since the daemon was started
        }
    },
    'hash_announcer': {
        'announce_queue_size': (int) number of blobs currently queued to be announced
    },
    'file_manager': {
        'managed_files': (int) count of files in the stream manager,
    },
    'upnp': {
        'aioupnp_version': (str),
        'redirects': {
            : (int) external_port,
        },
        'gateway': (str) manufacturer and model,
        'dht_redirect_set': (bool),
        'peer_redirect_set': (bool),
        'external_ip': (str) external ip address,
    }
}

stop

Stop lbrynet API server.

Arguments

Returns

(string) Shutdown message

version

Get lbrynet API server version information

Arguments

Returns

(dict) Dictionary of lbry version information
{
    'processor': (str) processor type,
    'python_version': (str) python version,
    'platform': (str) platform string,
    'os_release': (str) os release string,
    'os_system': (str) os name,
    'version': (str) lbrynet version,
    'build': (str) "dev" | "qa" | "rc" | "release",
}

account_add

Add a previously created account from a seed, private key or public key (read-only). Specify --single_key for single address or vanity address accounts.

Arguments

• account_name
  str
  name of the account to add
• seed
  optionalstr
  seed to generate new account from
• private_key
  optionalstr
  private key for new account
• public_key
  optionalstr
  public key for new account
• single_key
  optionalbool
  create single key account, default is multi-key
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

{
    "id": "account_id",
    "is_default": "this account is used by default",
    "ledger": "name of crypto currency and network",
    "name": "optional account name",
    "seed": "human friendly words from which account can be recreated",
    "encrypted": "if account is encrypted",
    "private_key": "extended private key",
    "public_key": "extended public key",
    "address_generator": "settings for generating addresses",
    "modified_on": "date of last modification to account settings"
}

account_balance

Return the balance of an account

Arguments

• account_id
  optionalstr
  If provided only the balance for this account will be given. Otherwise default account.
• wallet_id
  optionalstr
  balance for specific wallet
• confirmations
  optionalint
  Only include transactions with this many confirmed blocks.

Returns

(decimal) amount of lbry credits in wallet

account_create

Create a new account. Specify --single_key if you want to use the same address for all transactions (not recommended).

Arguments

• account_name
  str
  name of the account to create
• single_key
  optionalbool
  create single key account, default is multi-key
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

{
    "id": "account_id",
    "is_default": "this account is used by default",
    "ledger": "name of crypto currency and network",
    "name": "optional account name",
    "seed": "human friendly words from which account can be recreated",
    "encrypted": "if account is encrypted",
    "private_key": "extended private key",
    "public_key": "extended public key",
    "address_generator": "settings for generating addresses",
    "modified_on": "date of last modification to account settings"
}

account_deposit

Spend a time locked transaction into your account.

Arguments

• txid
  optionalstr
  id of the transaction
• nout
  optionalint
  output number in the transaction
• redeem_script
  optionalstr
  redeem script for output
• private_key
  optionalstr
  private key to sign transaction
• to_account
  optionalstr
  deposit to this account
• wallet_id
  optionalstr
  limit operation to specific wallet.
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until tx has synced

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

account_fund

Transfer some amount (or --everything) to an account from another account (can be the same account). Amounts are interpreted as LBC. You can also spread the transfer across a number of --outputs (cannot be used together with --everything).

Arguments

• to_account
  optionalstr
  send to this account
• from_account
  optionalstr
  spend from this account
• amount
  decimal
  the amount to transfer lbc
• everything
  optionalbool
  transfer everything (excluding claims), default: false.
• outputs
  optionalint
  split payment across many outputs, default: 1.
• wallet_id
  optionalstr
  limit operation to specific wallet.
• broadcast
  optionalbool
  actually broadcast the transaction, default: false.

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

account_list

List details of all of the accounts or a specific account.

Arguments

• account_id
  optionalstr
  If provided only the balance for this account will be given
• wallet_id
  optionalstr
  accounts in specific wallet
• confirmations
  optionalint
  required confirmations (default: 0)
• include_claims
  optionalbool
  include claims, requires than a LBC account is specified (default: false)
• show_seed
  optionalbool
  show the seed for the account
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "id": "account_id",
            "is_default": "this account is used by default",
            "ledger": "name of crypto currency and network",
            "name": "optional account name",
            "seed": "human friendly words from which account can be recreated",
            "encrypted": "if account is encrypted",
            "private_key": "extended private key",
            "public_key": "extended public key",
            "address_generator": "settings for generating addresses",
            "modified_on": "date of last modification to account settings"
        }
    ]
}

account_max_address_gap

Finds ranges of consecutive addresses that are unused and returns the length of the longest such range: for change and receiving address chains. This is useful to figure out ideal values to set for 'receiving_gap' and 'change_gap' account settings.

Arguments

• account_id
  str
  account for which to get max gaps
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(map) maximum gap for change and receiving addresses

account_remove

Remove an existing account.

Arguments

• account_id
  str
  id of the account to remove
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

{
    "id": "account_id",
    "is_default": "this account is used by default",
    "ledger": "name of crypto currency and network",
    "name": "optional account name",
    "seed": "human friendly words from which account can be recreated",
    "encrypted": "if account is encrypted",
    "private_key": "extended private key",
    "public_key": "extended public key",
    "address_generator": "settings for generating addresses",
    "modified_on": "date of last modification to account settings"
}

account_send

Send the same number of credits to multiple addresses from a specific account (or default account).

Arguments

• account_id
  optionalstr
  account to fund the transaction
• wallet_id
  optionalstr
  restrict operation to specific wallet
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until tx has synced

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

account_set

Change various settings on an account.

Arguments

• account_id
  str
  id of the account to change
• wallet_id
  optionalstr
  restrict operation to specific wallet
• default
  optionalbool
  make this account the default
• new_name
  optionalstr
  new name for the account
• receiving_gap
  optionalint
  set the gap for receiving addresses
• receiving_max_uses
  optionalint
  set the maximum number of times to use a receiving address
• change_gap
  optionalint
  set the gap for change addresses
• change_max_uses
  optionalint
  set the maximum number of times to use a change address

Returns

{
    "id": "account_id",
    "is_default": "this account is used by default",
    "ledger": "name of crypto currency and network",
    "name": "optional account name",
    "seed": "human friendly words from which account can be recreated",
    "encrypted": "if account is encrypted",
    "private_key": "extended private key",
    "public_key": "extended public key",
    "address_generator": "settings for generating addresses",
    "modified_on": "date of last modification to account settings"
}

address_is_mine

Checks if an address is associated with the current wallet.

Arguments

• address
  str
  address to check
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(bool) true, if address is associated with current wallet

address_list

List account addresses or details of single address.

Arguments

• address
  optionalstr
  just show details for single address
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict operation to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        "an address in base58"
    ]
}

address_unused

Return an address containing no balance, will create a new address if there is none.

Arguments

• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

            "an address in base58"

blob_announce

Announce blobs to the DHT

Arguments

• blob_hash
  optionalstr
  announce a blob, specified by blob_hash
• stream_hash
  optionalstr
  announce all blobs associated with stream_hash
• sd_hash
  optionalstr
  announce all blobs associated with sd_hash and the sd_hash itself

Returns

(bool) true if successful

blob_clean

Deletes blobs to cleanup disk space

Arguments

Returns

(bool) true if successful

blob_delete

Delete a blob

Arguments

• blob_hash
  str
  blob hash of the blob to delete

Returns

(str) Success/fail message

blob_get

Download and return a blob

Arguments

• blob_hash
  str
  blob hash of the blob to get
• timeout
  optionalint
  timeout in number of seconds

Returns

(str) Success/Fail message or (dict) decoded data

blob_list

Returns blob hashes. If not given filters, returns all blobs known by the blob manager

Arguments

• needed
  optionalbool
  only return needed blobs
• finished
  optionalbool
  only return finished blobs
• uri
  optionalstr
  filter blobs by stream in a uri
• stream_hash
  optionalstr
  filter blobs by stream hash
• sd_hash
  optionalstr
  filter blobs in a stream by sd hash, ie the hash of the stream descriptor blob for a stream that has been downloaded
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

(list) List of blob hashes

blob_reflect

Reflects specified blobs

Arguments

• reflector_server
  optionalstr
  reflector address

Returns

(list) reflected blob hashes

blob_reflect_all

Reflects all saved blobs

Arguments

Returns

(bool) true if successful

channel_abandon

Abandon one of my channel claims.

Arguments

• claim_id
  optionalstr
  claim_id of the claim to abandon
• txid
  optionalstr
  txid of the claim to abandon
• nout
  optionalint
  nout of the claim to abandon
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict operation to specific wallet
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until abandon is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

channel_create

Create a new channel by generating a channel private key and establishing an '@' prefixed claim.

Arguments

• name
  str
  name of the channel prefixed with '@'
• bid
  decimal
  amount to back the claim
• allow_duplicate_name
  optionalbool
  create new channel even if one already exists with given name. default: false.
• title
  optionalstr
  title of the publication
• description
  optionalstr
  description of the publication
• email
  optionalstr
  email of channel owner
• website_url
  optionalstr
  website url
• featured
  optionallist
  claim_ids of featured content in channel
• tags
  optionallist
  content tags
• languages
  optionallist
  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`
• locations
  optionallist
  locations of the channel, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... "locations": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: "COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE" making sure to include colon for blank values, for example to provide only the city: ... --locations="::Manchester" with all values set: ... --locations="US:NH:Manchester:03101:42.990605:-71.460989" optionally, you can just pass the "LATITUDE:LONGITUDE": ... --locations="42.990605:-71.460989" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations="{'country': 'US', 'state': 'NH'}"
• thumbnail_url
  optionalstr
  thumbnail url
• cover_url
  optionalstr
  url of cover image
• account_id
  optionalstr
  account to use for holding the transaction
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the channel is sent to, if not specified it will be determined automatically from the account
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

channel_export

Export channel private key.

Arguments

• channel_id
  str
  claim id of channel to export
• channel_name
  optionalstr
  name of channel to export
• account_id
  optionalstr
  one or more account ids for accounts to look in for channels, defaults to all accounts.
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(str) serialized channel private key

channel_import

Import serialized channel private key (to allow signing new streams to the channel)

Arguments

• channel_data
  str
  serialized channel, as exported by channel export
• wallet_id
  optionalstr
  import into specific wallet

Returns

(dict) Result dictionary

channel_list

List my channel claims.

Arguments

• name
  optionalstr or list
  channel name
• claim_id
  optionalstr or list
  channel id
• is_spent
  optionalbool
  shows previous channel updates and abandons
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination
• resolve
  optionalbool
  resolves each channel to provide additional metadata
• no_totals
  optionalbool
  do not calculate the total number of pages and items in result set (significant performance boost)

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

channel_sign

Signs data using the specified channel signing key.

Arguments

• channel_name
  optionalstr
  name of channel used to sign (or use channel id)
• channel_id
  optionalstr
  claim id of channel used to sign (or use channel name)
• hexdata
  optionalstr
  data to sign, encoded as hexadecimal
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(dict) Signature if successfully made, (None) or an error otherwise
{
    "signature":    (str) The signature of the comment,
    "signing_ts":   (str) The timestamp used to sign the comment,
}

channel_update

Update an existing channel claim.

Arguments

• claim_id
  str
  claim_id of the channel to update
• bid
  optionaldecimal
  amount to back the claim
• title
  optionalstr
  title of the publication
• description
  optionalstr
  description of the publication
• email
  optionalstr
  email of channel owner
• website_url
  optionalstr
  website url
• featured
  optionallist
  claim_ids of featured content in channel
• clear_featured
  optionalbool
  clear existing featured content (prior to adding new ones)
• tags
  optionallist
  add content tags
• clear_tags
  optionalbool
  clear existing tags (prior to adding new ones)
• languages
  optionallist
  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`
• clear_languages
  optionalbool
  clear existing languages (prior to adding new ones)
• locations
  optionallist
  locations of the channel, consisting of 2 letter `country` code and a `state`, `city` and a postal `code` along with a `latitude` and `longitude`. for JSON RPC: pass a dictionary with aforementioned attributes as keys, eg: ... "locations": [{'country': 'US', 'state': 'NH'}] ... for command line: pass a colon delimited list with values in the following order: "COUNTRY:STATE:CITY:CODE:LATITUDE:LONGITUDE" making sure to include colon for blank values, for example to provide only the city: ... --locations="::Manchester" with all values set: ... --locations="US:NH:Manchester:03101:42.990605:-71.460989" optionally, you can just pass the "LATITUDE:LONGITUDE": ... --locations="42.990605:-71.460989" finally, you can also pass JSON string of dictionary on the command line as you would via JSON RPC ... --locations="{'country': 'US', 'state': 'NH'}"
• clear_locations
  optionalbool
  clear existing locations (prior to adding new ones)
• thumbnail_url
  optionalstr
  thumbnail url
• cover_url
  optionalstr
  url of cover image
• account_id
  optionalstr
  account in which to look for channel (default: all)
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the channel is sent
• new_signing_key
  optionalbool
  generate a new signing key, will invalidate all previous publishes
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool
• replace
  optionalbool
  instead of modifying specific values on the channel, this will clear all existing values and only save passed in values, useful for form submissions where all values are always set

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

claim_list

List my stream and channel claims.

Arguments

• claim_type
  optionalstr or list
  claim type: channel, stream, repost, collection
• claim_id
  optionalstr or list
  claim id
• channel_id
  optionalstr or list
  streams in this channel
• name
  optionalstr or list
  claim name
• is_spent
  optionalbool
  shows previous claim updates and abandons
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• has_source
  optionalbool
  list claims containing a source field
• has_no_source
  optionalbool
  list claims not containing a source field
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination
• resolve
  optionalbool
  resolves each claim to provide additional metadata
• order_by
  optionalstr
  field to order by: 'name', 'height', 'amount'
• no_totals
  optionalbool
  do not calculate the total number of pages and items in result set (significant performance boost)
• include_received_tips
  optionalbool
  calculate the amount of tips received for claim outputs

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

claim_search

Search for stream and channel claims on the blockchain. Arguments marked with "supports equality constraints" allow prepending the value with an equality constraint such as '>', '>=', '<' and '<=' eg. --height=">400000" would limit results to only claims above 400k block height. They also support multiple constraints passed as a list of the args described above. eg. --release_time=[">1000000", "<2000000"]

Arguments

• name
  optionalstr
  claim name (normalized)
• text
  optionalstr
  full text search
• claim_id
  optionalstr
  full or partial claim id
• claim_ids
  optionallist
  list of full claim ids
• txid
  optionalstr
  transaction id
• nout
  optionalstr
  position in the transaction
• channel
  optionalstr
  claims signed by this channel (argument is a URL which automatically gets resolved), see --channel_ids if you need to filter by multiple channels at the same time, includes claims with invalid signatures, use in conjunction with --valid_channel_signature
• channel_ids
  optionallist
  claims signed by any of these channels (arguments must be claim ids of the channels), includes claims with invalid signatures, implies --has_channel_signature, use in conjunction with --valid_channel_signature
• not_channel_ids
  optionallist
  exclude claims signed by any of these channels (arguments must be claim ids of the channels)
• has_channel_signature
  optionalbool
  claims with a channel signature (valid or invalid)
• valid_channel_signature
  optionalbool
  claims with a valid channel signature or no signature, use in conjunction with --has_channel_signature to only get claims with valid signatures
• invalid_channel_signature
  optionalbool
  claims with invalid channel signature or no signature, use in conjunction with --has_channel_signature to only get claims with invalid signatures
• limit_claims_per_channel
  optionalint
  only return up to the specified number of claims per channel
• is_controlling
  optionalbool
  winning claims of their respective name
• public_key_id
  optionalstr
  only return channels having this public key id, this is the same key as used in the wallet file to map channel certificate private keys: {'public_key_id': 'private key'}
• height
  optionalint
  last updated block height (supports equality constraints)
• timestamp
  optionalint
  last updated timestamp (supports equality constraints)
• creation_height
  optionalint
  created at block height (supports equality constraints)
• creation_timestamp
  optionalint
  created at timestamp (supports equality constraints)
• activation_height
  optionalint
  height at which claim starts competing for name (supports equality constraints)
• expiration_height
  optionalint
  height at which claim will expire (supports equality constraints)
• release_time
  optionalint
  limit to claims self-described as having been released to the public on or after this UTC timestamp, when claim does not provide a release time the publish time is used instead (supports equality constraints)
• amount
  optionalint
  limit by claim value (supports equality constraints)
• support_amount
  optionalint
  limit by supports and tips received (supports equality constraints)
• effective_amount
  optionalint
  limit by total value (initial claim value plus all tips and supports received), this amount is blank until claim has reached activation height (supports equality constraints)
• trending_score
  optionalint
  limit by trending score (supports equality constraints)
• trending_group
  optionalint
  DEPRECATED - instead please use trending_score
• trending_mixed
  optionalint
  DEPRECATED - instead please use trending_score
• trending_local
  optionalint
  DEPRECATED - instead please use trending_score
• trending_global
  optionalint
  DEPRECATED - instead please use trending_score
• reposted_claim_id
  optionalstr
  all reposts of the specified original claim id
• reposted
  optionalint
  claims reposted this many times (supports equality constraints)
• claim_type
  optionalstr
  filter by 'channel', 'stream', 'repost' or 'collection'
• stream_types
  optionallist
  filter by 'video', 'image', 'document', etc
• media_types
  optionallist
  filter by 'video/mp4', 'image/png', etc
• fee_currency
  optionalstring
  specify fee currency: LBC, BTC, USD
• fee_amount
  optionaldecimal
  content download fee (supports equality constraints)
• duration
  optionalint
  duration of video or audio in seconds (supports equality constraints)
• any_tags
  optionallist
  find claims containing any of the tags
• all_tags
  optionallist
  find claims containing every tag
• not_tags
  optionallist
  find claims not containing any of these tags
• any_languages
  optionallist
  find claims containing any of the languages
• all_languages
  optionallist
  find claims containing every language
• not_languages
  optionallist
  find claims not containing any of these languages
• any_locations
  optionallist
  find claims containing any of the locations
• all_locations
  optionallist
  find claims containing every location
• not_locations
  optionallist
  find claims not containing any of these locations
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination
• order_by
  optionallist
  field to order by, default is descending order, to do an ascending order prepend ^ to the field name, eg. '^amount' available fields: 'name', 'height', 'release_time', 'publish_time', 'amount', 'effective_amount', 'support_amount', 'trending_group', 'trending_mixed', 'trending_local', 'trending_global', 'activation_height'
• no_totals
  optionalbool
  do not calculate the total number of pages and items in result set (significant performance boost)
• wallet_id
  optionalstr
  wallet to check for claim purchase receipts
• include_purchase_receipt
  optionalbool
  lookup and include a receipt if this wallet has purchased the claim
• include_is_my_output
  optionalbool
  lookup and include a boolean indicating if claim being resolved is yours
• remove_duplicates
  optionalbool
  removes duplicated content from search by picking either the original claim or the oldest matching repost
• has_source
  optionalbool
  find claims containing a source field
• sd_hash
  optionalstr
  find claims where the source stream descriptor hash matches (partially or completely) the given hexadecimal string
• has_no_source
  optionalbool
  find claims not containing a source field
• new_sdk_server
  optionalstr
  URL of the new SDK server (EXPERIMENTAL)

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

collection_abandon

Abandon one of my collection claims.

Arguments

• claim_id
  optionalstr
  claim_id of the claim to abandon
• txid
  optionalstr
  txid of the claim to abandon
• nout
  optionalint
  nout of the claim to abandon
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict operation to specific wallet
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until abandon is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

collection_create

Create a new collection.

Arguments

• name
  str
  name of the collection
• bid
  decimal
  amount to back the claim
• claims
  optionallist
  claim ids to be included in the collection
• allow_duplicate_name
  optionalbool
  create new collection even if one already exists with given name. default: false.
• title
  optionalstr
  title of the collection
• description
  optionalstr
  description of the collection
• tags
  optionallist
  content tags
• clear_languages
  optionalbool
  clear existing languages (prior to adding new ones)
• languages
  optionallist
  languages used by the collection, 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`
• locations
  optionallist
  locations of the collection, 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'}"
• thumbnail_url
  optionalstr
  thumbnail url
• channel_id
  optionalstr
  claim id of the publisher channel
• channel_name
  optionalstr
  name of the publisher channel
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• account_id
  optionalstr
  account to use for holding the transaction
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the collection is sent to, if not specified it will be determined automatically from the account
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

collection_list

List my collection claims.

Arguments

• resolve
  optionalbool
  resolve collection claim
• resolve_claims
  optionalint
  resolve every claim
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

collection_resolve

Resolve claims in the collection.

Arguments

• claim_id
  optionalstr
  claim id of the collection
• url
  optionalstr
  url of the collection
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

collection_update

Update an existing collection claim.

Arguments

• claim_id
  str
  claim_id of the collection to update
• bid
  optionaldecimal
  amount to back the claim
• claims
  optionallist
  claim ids
• clear_claims
  optionalbool
  clear existing claim references (prior to adding new ones)
• title
  optionalstr
  title of the collection
• description
  optionalstr
  description of the collection
• tags
  optionallist
  add content tags
• clear_tags
  optionalbool
  clear existing tags (prior to adding new ones)
• languages
  optionallist
  languages used by the collection, 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`
• clear_languages
  optionalbool
  clear existing languages (prior to adding new ones)
• locations
  optionallist
  locations of the collection, 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'}"
• clear_locations
  optionalbool
  clear existing locations (prior to adding new ones)
• thumbnail_url
  optionalstr
  thumbnail url
• channel_id
  optionalstr
  claim id of the publisher channel
• channel_name
  optionalstr
  name of the publisher channel
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• account_id
  optionalstr
  account in which to look for collection (default: all)
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the collection is sent
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool
• replace
  optionalbool
  instead of modifying specific values on the collection, this will clear all existing values and only save passed in values, useful for form submissions where all values are always set

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

file_delete

Delete a LBRY file

Arguments

• delete_from_download_dir
  optionalbool
  delete file from download directory, instead of just deleting blobs
• delete_all
  optionalbool
  if there are multiple matching files, allow the deletion of multiple files. Otherwise do not delete anything.
• sd_hash
  optionalstr
  delete by file sd hash
• file_name
  optionalstr
  delete by file name in downloads folder
• stream_hash
  optionalstr
  delete by file stream hash
• rowid
  optionalint
  delete by file row id
• claim_id
  optionalstr
  delete by file claim id
• txid
  optionalstr
  delete by file claim txid
• nout
  optionalint
  delete by file claim nout
• claim_name
  optionalstr
  delete by file claim name
• channel_claim_id
  optionalstr
  delete by file channel claim id
• channel_name
  optionalstr
  delete by file channel claim name

Returns

(bool) true if deletion was successful

file_list

List files limited by optional filters

Arguments

• sd_hash
  optionalstr
  get file with matching sd hash
• file_name
  optionalstr
  get file with matching file name in the downloads folder
• stream_hash
  optionalstr
  get file with matching stream hash
• rowid
  optionalint
  get file with matching row id
• added_on
  optionalint
  get file with matching time of insertion
• claim_id
  optionalstr
  get file with matching claim id(s)
• outpoint
  optionalstr
  get file with matching claim outpoint(s)
• txid
  optionalstr
  get file with matching claim txid
• nout
  optionalint
  get file with matching claim nout
• channel_claim_id
  optionalstr
  get file with matching channel claim id(s)
• channel_name
  optionalstr
  get file with matching channel name
• claim_name
  optionalstr
  get file with matching claim name
• blobs_in_stream
  optionalint
  get file with matching blobs in stream
• download_path
  optionalstr
  get file with matching download path
• uploading_to_reflector
  optionalbool
  get files currently uploading to reflector
• is_fully_reflected
  optionalbool
  get files that have been uploaded to reflector
• status
  optionalstr
  match by status, ( running | finished | stopped )
• completed
  optionalbool
  match only completed
• blobs_remaining
  optionalint
  amount of remaining blobs to download
• sort
  optionalstr
  field to sort by (one of the above filter fields)
• comparison
  optionalstr
  logical comparison, (eq | ne | g | ge | l | le | in)
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination
• wallet_id
  optionalstr
  add purchase receipts from this wallet

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "streaming_url": "(str) url to stream the file using range requests",
            "completed": "(bool) true if download is completed",
            "file_name": "(str) name of file",
            "download_directory": "(str) download directory",
            "points_paid": "(float) credit paid to download file",
            "stopped": "(bool) true if download is stopped",
            "stream_hash": "(str) stream hash of file",
            "stream_name": "(str) stream name",
            "suggested_file_name": "(str) suggested file name",
            "sd_hash": "(str) sd hash of file",
            "download_path": "(str) download path of file",
            "mime_type": "(str) mime type of file",
            "key": "(str) key attached to file",
            "total_bytes_lower_bound": "(int) lower bound file size in bytes",
            "total_bytes": "(int) file upper bound size in bytes",
            "written_bytes": "(int) written size in bytes",
            "blobs_completed": "(int) number of fully downloaded blobs",
            "blobs_in_stream": "(int) total blobs on stream",
            "blobs_remaining": "(int) total blobs remaining to download",
            "status": "(str) downloader status",
            "claim_id": "(str) None if claim is not found else the claim id",
            "txid": "(str) None if claim is not found else the transaction id",
            "nout": "(int) None if claim is not found else the transaction output index",
            "outpoint": "(str) None if claim is not found else the tx and output",
            "metadata": "(dict) None if claim is not found else the claim metadata",
            "channel_claim_id": "(str) None if claim is not found or not signed",
            "channel_name": "(str) None if claim is not found or not signed",
            "claim_name": "(str) None if claim is not found else the claim name",
            "reflector_progress": "(int) reflector upload progress, 0 to 100",
            "uploading_to_reflector": "(bool) set to True when currently uploading to reflector"
        }
    ]
}

file_reflect

Reflect all the blobs in a file matching the filter criteria

Arguments

• sd_hash
  optionalstr
  get file with matching sd hash
• file_name
  optionalstr
  get file with matching file name in the downloads folder
• stream_hash
  optionalstr
  get file with matching stream hash
• rowid
  optionalint
  get file with matching row id
• reflector
  optionalstr
  reflector server, ip address or url by default choose a server from the config

Returns

(list) list of blobs reflected

file_save

Start saving a file to disk.

Arguments

• file_name
  optionalstr
  file name to save to
• download_directory
  optionalstr
  directory to save into
• sd_hash
  optionalstr
  save file with matching sd hash
• stream_hash
  optionalstr
  save file with matching stream hash
• rowid
  optionalint
  save file with matching row id
• claim_id
  optionalstr
  save file with matching claim id
• txid
  optionalstr
  save file with matching claim txid
• nout
  optionalint
  save file with matching claim nout
• claim_name
  optionalstr
  save file with matching claim name
• channel_claim_id
  optionalstr
  save file with matching channel claim id
• channel_name
  optionalstr
  save file with matching channel claim name

Returns

{
    "streaming_url": "(str) url to stream the file using range requests",
    "completed": "(bool) true if download is completed",
    "file_name": "(str) name of file",
    "download_directory": "(str) download directory",
    "points_paid": "(float) credit paid to download file",
    "stopped": "(bool) true if download is stopped",
    "stream_hash": "(str) stream hash of file",
    "stream_name": "(str) stream name",
    "suggested_file_name": "(str) suggested file name",
    "sd_hash": "(str) sd hash of file",
    "download_path": "(str) download path of file",
    "mime_type": "(str) mime type of file",
    "key": "(str) key attached to file",
    "total_bytes_lower_bound": "(int) lower bound file size in bytes",
    "total_bytes": "(int) file upper bound size in bytes",
    "written_bytes": "(int) written size in bytes",
    "blobs_completed": "(int) number of fully downloaded blobs",
    "blobs_in_stream": "(int) total blobs on stream",
    "blobs_remaining": "(int) total blobs remaining to download",
    "status": "(str) downloader status",
    "claim_id": "(str) None if claim is not found else the claim id",
    "txid": "(str) None if claim is not found else the transaction id",
    "nout": "(int) None if claim is not found else the transaction output index",
    "outpoint": "(str) None if claim is not found else the tx and output",
    "metadata": "(dict) None if claim is not found else the claim metadata",
    "channel_claim_id": "(str) None if claim is not found or not signed",
    "channel_name": "(str) None if claim is not found or not signed",
    "claim_name": "(str) None if claim is not found else the claim name",
    "reflector_progress": "(int) reflector upload progress, 0 to 100",
    "uploading_to_reflector": "(bool) set to True when currently uploading to reflector"
}

file_set_status

Start or stop downloading a file

Arguments

• status
  str
  one of "start" or "stop"
• sd_hash
  optionalstr
  set status of file with matching sd hash
• file_name
  optionalstr
  set status of file with matching file name in the downloads folder
• stream_hash
  optionalstr
  set status of file with matching stream hash
• rowid
  optionalint
  set status of file with matching row id

Returns

(str) Confirmation message

peer_list

Get peers for blob hash

Arguments

• blob_hash
  str
  find available peers for this blob hash
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

(list) List of contact dictionaries {'address': , 'udp_port': , 'tcp_port': ,
'node_id': }

peer_ping

Send a kademlia ping to the specified peer. If address and port are provided the peer is directly pinged, if not provided the peer is located first.

Arguments

Returns

(str) pong, or {'error': } if an error is encountered

preference_get

Get preference value for key or all values if not key is passed in.

Arguments

• key
  optionalstr
  key associated with value
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(dict) Dictionary of preference(s)

preference_set

Set preferences

Arguments

• key
  str
  key associated with value
• value
  str
  key associated with value
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(dict) Dictionary with key/value of new preference

purchase_create

Purchase a claim.

Arguments

• claim_id
  optionalstr
  claim id of claim to purchase
• url
  optionalstr
  lookup claim to purchase by url
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• allow_duplicate_purchase
  optionalbool
  allow purchasing claim_id you already own
• override_max_key_fee
  optionalbool
  ignore max key fee for this purchase
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

purchase_list

List my claim purchases.

Arguments

• claim_id
  optionalstr
  purchases for specific claim
• resolve
  optionalstr
  include resolved claim information
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

settings_clear

Clear daemon settings

Arguments

Returns

(dict) Updated dictionary of daemon settings

settings_get

Get daemon settings

Arguments

Returns

(dict) Dictionary of daemon settings
See ADJUSTABLE_SETTINGS in lbry/conf.py for full list of settings

settings_set

Set daemon settings

Arguments

Returns

(dict) Updated dictionary of daemon settings

stream_abandon

Abandon one of my stream claims.

Arguments

• claim_id
  optionalstr
  claim_id of the claim to abandon
• txid
  optionalstr
  txid of the claim to abandon
• nout
  optionalint
  nout of the claim to abandon
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict operation to specific wallet
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until abandon is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

stream_cost_estimate

Get estimated cost for a lbry stream

Arguments

• uri
  str
  uri to use

Returns

(float) Estimated cost in lbry credits, returns None if uri is not
resolvable

stream_create

Make a new stream claim and announce the associated file to lbrynet.

Arguments

• name
  str
  name of the content (can only consist of a-z A-Z 0-9 and -(dash))
• bid
  decimal
  amount to back the claim
• file_path
  optionalstr
  path to file to be associated with name.
• file_name
  optionalstr
  name of file to be associated with stream.
• file_hash
  optionalstr
  hash of file to be associated with stream.
• validate_file
  optionalbool
  validate that the video container and encodings match common web browser support or that optimization succeeds if specified. FFmpeg is required
• optimize_file
  optionalbool
  transcode the video & audio if necessary to ensure common web browser support. FFmpeg is required
• allow_duplicate_name
  optionalbool
  create new claim even if one already exists with given name. default: false.
• fee_currency
  optionalstring
  specify fee currency
• fee_amount
  optionaldecimal
  content download fee
• fee_address
  optionalstr
  address where to send fee payments, will use value from --claim_address if not provided
• title
  optionalstr
  title of the publication
• description
  optionalstr
  description of the publication
• author
  optionalstr
  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
• tags
  optionallist
  add content tags
• languages
  optionallist
  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`
• locations
  optionallist
  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'}"
• license
  optionalstr
  publication license
• license_url
  optionalstr
  publication license url
• thumbnail_url
  optionalstr
  thumbnail url
• release_time
  optionalint
  original public release of content, seconds since UNIX epoch
• width
  optionalint
  image/video width, automatically calculated from media file
• height
  optionalint
  image/video height, automatically calculated from media file
• duration
  optionalint
  audio/video duration in seconds, automatically calculated
• sd_hash
  optionalstr
  sd_hash of stream
• channel_id
  optionalstr
  claim id of the publisher channel
• channel_name
  optionalstr
  name of the publisher channel
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• account_id
  optionalstr
  account to use for holding the transaction
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the claim is sent to, if not specified it will be determined automatically from the account
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

stream_list

List my stream claims.

Arguments

• name
  optionalstr or list
  stream name
• claim_id
  optionalstr or list
  stream id
• is_spent
  optionalbool
  shows previous stream updates and abandons
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination
• resolve
  optionalbool
  resolves each stream to provide additional metadata
• no_totals
  optionalbool
  do not calculate the total number of pages and items in result set (significant performance boost)

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

stream_repost

Creates a claim that references an existing stream by its claim id.

Arguments

• name
  str
  name of the content (can only consist of a-z A-Z 0-9 and -(dash))
• bid
  decimal
  amount to back the claim
• claim_id
  str
  id of the claim being reposted
• allow_duplicate_name
  optionalbool
  create new claim even if one already exists with given name. default: false.
• title
  optionalstr
  title of the repost
• description
  optionalstr
  description of the repost
• tags
  optionallist
  add repost tags
• channel_id
  optionalstr
  claim id of the publisher channel
• channel_name
  optionalstr
  name of the publisher channel
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• account_id
  optionalstr
  account to use for holding the transaction
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the claim is sent to, if not specified it will be determined automatically from the account
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

stream_update

Update an existing stream claim and if a new file is provided announce it to lbrynet.

Arguments

• claim_id
  str
  id of the stream claim to update
• bid
  optionaldecimal
  amount to back the claim
• file_path
  optionalstr
  path to file to be associated with name.
• validate_file
  optionalbool
  validate that the video container and encodings match common web browser support or that optimization succeeds if specified. FFmpeg is required and file_path must be specified.
• optimize_file
  optionalbool
  transcode the video & audio if necessary to ensure common web browser support. FFmpeg is required and file_path must be specified.
• file_name
  optionalstr
  override file name, defaults to name from file_path.
• file_size
  optionalstr
  override file size, otherwise automatically computed.
• file_hash
  optionalstr
  override file hash, otherwise automatically computed.
• fee_currency
  optionalstring
  specify fee currency
• fee_amount
  optionaldecimal
  content download fee
• fee_address
  optionalstr
  address where to send fee payments, will use value from --claim_address if not provided
• clear_fee
  optionalbool
  clear previously set fee
• title
  optionalstr
  title of the publication
• description
  optionalstr
  description of the publication
• author
  optionalstr
  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
• tags
  optionallist
  add content tags
• clear_tags
  optionalbool
  clear existing tags (prior to adding new ones)
• languages
  optionallist
  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`
• clear_languages
  optionalbool
  clear existing languages (prior to adding new ones)
• locations
  optionallist
  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'}"
• clear_locations
  optionalbool
  clear existing locations (prior to adding new ones)
• license
  optionalstr
  publication license
• license_url
  optionalstr
  publication license url
• thumbnail_url
  optionalstr
  thumbnail url
• release_time
  optionalint
  original public release of content, seconds since UNIX epoch
• width
  optionalint
  image/video width, automatically calculated from media file
• height
  optionalint
  image/video height, automatically calculated from media file
• duration
  optionalint
  audio/video duration in seconds, automatically calculated
• sd_hash
  optionalstr
  sd_hash of stream
• channel_id
  optionalstr
  claim id of the publisher channel
• channel_name
  optionalstr
  name of the publisher channel
• clear_channel
  optionalbool
  remove channel signature
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• account_id
  optionalstr
  account in which to look for stream (default: all)
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• claim_address
  optionalstr
  address where the claim is sent to, if not specified it will be determined automatically from the account
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool
• replace
  optionalbool
  instead of modifying specific values on the stream, this will clear all existing values and only save passed in values, useful for form submissions where all values are always set

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

support_abandon

Abandon supports, including tips, of a specific claim, optionally keeping some amount as supports.

Arguments

• claim_id
  optionalstr
  claim_id of the support to abandon
• txid
  optionalstr
  txid of the claim to abandon
• nout
  optionalint
  nout of the claim to abandon
• keep
  optionaldecimal
  amount of lbc to keep as support
• account_id
  optionalstr
  id of the account to use
• wallet_id
  optionalstr
  restrict operation to specific wallet
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until abandon is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

support_create

Create a support or a tip for name claim.

Arguments

• claim_id
  str
  claim_id of the claim to support
• amount
  decimal
  amount of support
• tip
  optionalbool
  send support to claim owner, default: false.
• channel_id
  optionalstr
  claim id of the supporters identity channel
• channel_name
  optionalstr
  name of the supporters identity channel
• channel_account_id
  optionalstr
  one or more account ids for accounts to look in for channel certificates, defaults to all accounts.
• account_id
  optionalstr
  account to use for holding the transaction
• wallet_id
  optionalstr
  restrict operation to specific wallet
• funding_account_ids
  optionallist
  ids of accounts to fund this transaction
• comment
  optionalstr
  add a comment to the support
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until transaction is in mempool

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

support_list

List staked supports and sent/received tips.

Arguments

• name
  optionalstr or list
  claim name
• claim_id
  optionalstr or list
  claim id
• received
  optionalbool
  only show received (tips)
• sent
  optionalbool
  only show sent (tips)
• staked
  optionalbool
  only show my staked supports
• is_spent
  optionalbool
  show abandoned supports
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination
• no_totals
  optionalbool
  do not calculate the total number of pages and items in result set (significant performance boost)

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

support_sum

List total staked supports for a claim, grouped by the channel that signed the support. If claim_id is a channel claim, you can use --include_channel_content to also include supports for content claims in the channel. !!!! NOTE: PAGINATION DOES NOT DO ANYTHING AT THE MOMENT !!!!!

Arguments

• claim_id
  optionalstr
  claim id
• new_sdk_server
  optionalstr
  URL of the new SDK server (EXPERIMENTAL)
• include_channel_content
  optionalbool
  if claim_id is for a channel, include supports for claims in that channel
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        "glorious data in dictionary"
    ]
}

sync_apply

Apply incoming synchronization data, if provided, and return a sync hash and update wallet data. Wallet must be unlocked to perform this operation. If "encrypt-on-disk" preference is True and supplied password is different from local password, or there is no local password (because local wallet was not encrypted), then the supplied password will be used for local encryption (overwriting previous local encryption password).

Arguments

• password
  optionalstr
  password to decrypt incoming and encrypt outgoing data
• data
  optionalstr
  incoming sync data, if any
• wallet_id
  optionalstr
  wallet being sync'ed
• blocking
  optionalbool
  wait until any new accounts have sync'ed

Returns

(map) sync hash and data

sync_hash

Deterministic hash of the wallet.

Arguments

• wallet_id
  optionalstr
  wallet for which to generate hash

Returns

(str) sha256 hash of wallet

tracemalloc_disable

Disable tracemalloc memory tracing

Arguments

Returns

(bool) is it tracing?

tracemalloc_enable

Enable tracemalloc memory tracing

Arguments

Returns

(bool) is it tracing?

tracemalloc_top

Show most common objects, the place that created them and their size.

Arguments

• items
  int
  maximum items to return, from the most common

Returns

(dict) dictionary containing most common objects in memory
{
    "line": (str) filename and line number where it was created,
    "code": (str) code that created it,
    "size": (int) size in bytes, for each "memory block",
    "count" (int) number of memory blocks
}

transaction_list

List transactions belonging to wallet

Arguments

• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

(list) List of transactions

{
    "claim_info": (list) claim info if in txn [{
                                            "address": (str) address of claim,
                                            "balance_delta": (float) bid amount,
                                            "amount": (float) claim amount,
                                            "claim_id": (str) claim id,
                                            "claim_name": (str) claim name,
                                            "nout": (int) nout
                                            }],
    "abandon_info": (list) abandon info if in txn [{
                                            "address": (str) address of abandoned claim,
                                            "balance_delta": (float) returned amount,
                                            "amount": (float) claim amount,
                                            "claim_id": (str) claim id,
                                            "claim_name": (str) claim name,
                                            "nout": (int) nout
                                            }],
    "confirmations": (int) number of confirmations for the txn,
    "date": (str) date and time of txn,
    "fee": (float) txn fee,
    "support_info": (list) support info if in txn [{
                                            "address": (str) address of support,
                                            "balance_delta": (float) support amount,
                                            "amount": (float) support amount,
                                            "claim_id": (str) claim id,
                                            "claim_name": (str) claim name,
                                            "is_tip": (bool),
                                            "nout": (int) nout
                                            }],
    "timestamp": (int) timestamp,
    "txid": (str) txn id,
    "update_info": (list) update info if in txn [{
                                            "address": (str) address of claim,
                                            "balance_delta": (float) credited/debited
                                            "amount": (float) absolute amount,
                                            "claim_id": (str) claim id,
                                            "claim_name": (str) claim name,
                                            "nout": (int) nout
                                            }],
    "value": (float) value of txn
}

transaction_show

Get a decoded transaction from a txid

Arguments

• txid
  str
  txid of the transaction

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

txo_list

List my transaction outputs.

Arguments

• type
  optionalstr or list
  claim type: stream, channel, support, purchase, collection, repost, other
• txid
  optionalstr or list
  transaction id of outputs
• claim_id
  optionalstr or list
  claim id
• channel_id
  optionalstr or list
  claims in this channel
• not_channel_id
  optionalstr or list
  claims not in this channel
• name
  optionalstr or list
  claim name
• is_spent
  optionalbool
  only show spent txos
• is_not_spent
  optionalbool
  only show not spent txos
• is_my_input_or_output
  optionalbool
  txos which have your inputs or your outputs, if using this flag the other related flags are ignored (--is_my_output, --is_my_input, etc)
• is_my_output
  optionalbool
  show outputs controlled by you
• is_not_my_output
  optionalbool
  show outputs not controlled by you
• is_my_input
  optionalbool
  show outputs created by you
• is_not_my_input
  optionalbool
  show outputs not created by you
• exclude_internal_transfers
  optionalbool
  excludes any outputs that are exactly this combination: "--is_my_input --is_my_output --type=other" this allows to exclude "change" payments, this flag can be used in combination with any of the other flags
• include_received_tips
  optionalbool
  calculate the amount of tips received for claim outputs
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination
• resolve
  optionalbool
  resolves each claim to provide additional metadata
• order_by
  optionalstr
  field to order by: 'name', 'height', 'amount' and 'none'
• no_totals
  optionalbool
  do not calculate the total number of pages and items in result set (significant performance boost)

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

txo_plot

Plot transaction output sum over days.

Arguments

• type
  optionalstr or list
  claim type: stream, channel, support, purchase, collection, repost, other
• txid
  optionalstr or list
  transaction id of outputs
• claim_id
  optionalstr or list
  claim id
• name
  optionalstr or list
  claim name
• channel_id
  optionalstr or list
  claims in this channel
• not_channel_id
  optionalstr or list
  claims not in this channel
• is_spent
  optionalbool
  only show spent txos
• is_not_spent
  optionalbool
  only show not spent txos
• is_my_input_or_output
  optionalbool
  txos which have your inputs or your outputs, if using this flag the other related flags are ignored (--is_my_output, --is_my_input, etc)
• is_my_output
  optionalbool
  show outputs controlled by you
• is_not_my_output
  optionalbool
  show outputs not controlled by you
• is_my_input
  optionalbool
  show outputs created by you
• is_not_my_input
  optionalbool
  show outputs not created by you
• exclude_internal_transfers
  optionalbool
  excludes any outputs that are exactly this combination: "--is_my_input --is_my_output --type=other" this allows to exclude "change" payments, this flag can be used in combination with any of the other flags
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• days_back
  optionalint
  number of days back from today (not compatible with --start_day, --days_after, --end_day)
• start_day
  optionaldate
  start on specific date (YYYY-MM-DD) (instead of --days_back)
• days_after
  optionalint
  end number of days after --start_day (instead of --end_day)
• end_day
  optionaldate
  end on specific date (YYYY-MM-DD) (instead of --days_after)

Returns

List[Dict]

txo_spend

Spend transaction outputs, batching into multiple transactions as necessary.

Arguments

• type
  optionalstr or list
  claim type: stream, channel, support, purchase, collection, repost, other
• txid
  optionalstr or list
  transaction id of outputs
• claim_id
  optionalstr or list
  claim id
• channel_id
  optionalstr or list
  claims in this channel
• not_channel_id
  optionalstr or list
  claims not in this channel
• name
  optionalstr or list
  claim name
• is_my_input
  optionalbool
  show outputs created by you
• is_not_my_input
  optionalbool
  show outputs not created by you
• exclude_internal_transfers
  optionalbool
  excludes any outputs that are exactly this combination: "--is_my_input --is_my_output --type=other" this allows to exclude "change" payments, this flag can be used in combination with any of the other flags
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until abandon is in mempool
• batch_size
  optionalint
  number of txos to spend per transactions
• include_full_tx
  optionalbool
  include entire tx in output and not just the txid

Returns

[
    {
        "txid": "hash of transaction in hex",
        "height": "block where transaction was recorded",
        "inputs": [
            {
                "txid": "hash of transaction in hex",
                "nout": "position in the transaction",
                "height": "block where transaction was recorded",
                "amount": "value of the txo as a decimal",
                "address": "address of who can spend the txo",
                "confirmations": "number of confirmed blocks",
                "is_change": "payment to change address, only available when it can be determined",
                "is_received": "true if txo was sent from external account to this account",
                "is_spent": "true if txo is spent",
                "is_mine": "payment to one of your accounts, only available when it can be determined",
                "type": "one of 'claim', 'support' or 'purchase'",
                "name": "when type is 'claim' or 'support', this is the claim name",
                "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
                "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
                "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
                "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
                "protobuf": "hex encoded raw protobuf version of 'value' field",
                "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
                "claim": "for purchase outputs only, metadata of purchased claim",
                "reposted_claim": "for repost claims only, metadata of claim being reposted",
                "signing_channel": "for signed claims only, metadata of signing channel",
                "is_channel_signature_valid": "for signed claims only, whether signature is valid",
                "purchase_receipt": "metadata for the purchase transaction associated with this claim"
            }
        ],
        "outputs": [
            {
                "txid": "hash of transaction in hex",
                "nout": "position in the transaction",
                "height": "block where transaction was recorded",
                "amount": "value of the txo as a decimal",
                "address": "address of who can spend the txo",
                "confirmations": "number of confirmed blocks",
                "is_change": "payment to change address, only available when it can be determined",
                "is_received": "true if txo was sent from external account to this account",
                "is_spent": "true if txo is spent",
                "is_mine": "payment to one of your accounts, only available when it can be determined",
                "type": "one of 'claim', 'support' or 'purchase'",
                "name": "when type is 'claim' or 'support', this is the claim name",
                "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
                "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
                "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
                "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
                "protobuf": "hex encoded raw protobuf version of 'value' field",
                "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
                "claim": "for purchase outputs only, metadata of purchased claim",
                "reposted_claim": "for repost claims only, metadata of claim being reposted",
                "signing_channel": "for signed claims only, metadata of signing channel",
                "is_channel_signature_valid": "for signed claims only, whether signature is valid",
                "purchase_receipt": "metadata for the purchase transaction associated with this claim"
            }
        ],
        "total_input": "sum of inputs as a decimal",
        "total_output": "sum of outputs, sans fee, as a decimal",
        "total_fee": "fee amount",
        "hex": "entire transaction encoded in hex"
    }
]

txo_sum

Sum of transaction outputs.

Arguments

• type
  optionalstr or list
  claim type: stream, channel, support, purchase, collection, repost, other
• txid
  optionalstr or list
  transaction id of outputs
• claim_id
  optionalstr or list
  claim id
• name
  optionalstr or list
  claim name
• channel_id
  optionalstr or list
  claims in this channel
• not_channel_id
  optionalstr or list
  claims not in this channel
• is_spent
  optionalbool
  only show spent txos
• is_not_spent
  optionalbool
  only show not spent txos
• is_my_input_or_output
  optionalbool
  txos which have your inputs or your outputs, if using this flag the other related flags are ignored (--is_my_output, --is_my_input, etc)
• is_my_output
  optionalbool
  show outputs controlled by you
• is_not_my_output
  optionalbool
  show outputs not controlled by you
• is_my_input
  optionalbool
  show outputs created by you
• is_not_my_input
  optionalbool
  show outputs not created by you
• exclude_internal_transfers
  optionalbool
  excludes any outputs that are exactly this combination: "--is_my_input --is_my_output --type=other" this allows to exclude "change" payments, this flag can be used in combination with any of the other flags
• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet

Returns

int

utxo_list

List unspent transaction outputs

Arguments

• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict results to specific wallet
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ]
}

utxo_release

When spending a UTXO it is locally locked to prevent double spends; occasionally this can result in a UTXO being locked which ultimately did not get spent (failed to broadcast, spend transaction was not accepted by blockchain node, etc). This command releases the lock on all UTXOs in your account.

Arguments

• account_id
  optionalstr
  id of the account to query
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

None

wallet_add

Add existing wallet.

Arguments

• wallet_id
  str
  wallet file name

Returns

{
    "id": "wallet_id",
    "name": "optional wallet name"
}

wallet_balance

Return the balance of a wallet

Arguments

• wallet_id
  optionalstr
  balance for specific wallet
• confirmations
  optionalint
  Only include transactions with this many confirmed blocks.

Returns

(decimal) amount of lbry credits in wallet

wallet_create

Create a new wallet.

Arguments

• wallet_id
  str
  wallet file name
• skip_on_startup
  optionalbool
  don't add wallet to daemon_settings.yml
• create_account
  optionalbool
  generates the default account
• single_key
  optionalbool
  used with --create_account, creates single-key account

Returns

{
    "id": "wallet_id",
    "name": "optional wallet name"
}

wallet_decrypt

Decrypt an encrypted wallet, this will remove the wallet password. The wallet must be unlocked to decrypt it

Arguments

• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(bool) true if wallet is decrypted, otherwise false

wallet_encrypt

Encrypt an unencrypted wallet with a password

Arguments

• new_password
  str
  password to encrypt account
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(bool) true if wallet is decrypted, otherwise false

wallet_list

List wallets.

Arguments

• wallet_id
  optionalstr
  show specific wallet only
• page
  optionalint
  page to return during paginating
• page_size
  optionalint
  number of items on page during pagination

Returns

{
    "page": "Page number of the current items.",
    "page_size": "Number of items to show on a page.",
    "total_pages": "Total number of pages.",
    "total_items": "Total number of items.",
    "items": [
        {
            "id": "wallet_id",
            "name": "optional wallet name"
        }
    ]
}

wallet_lock

Lock an unlocked wallet

Arguments

• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(bool) true if wallet is locked, otherwise false

wallet_reconnect

Reconnects ledger network client, applying new configurations.

Arguments

Returns

None

wallet_remove

Remove an existing wallet.

Arguments

• wallet_id
  str
  name of wallet to remove

Returns

{
    "id": "wallet_id",
    "name": "optional wallet name"
}

wallet_send

Send the same number of credits to multiple addresses using all accounts in wallet to fund the transaction and the default account to receive any change.

Arguments

• wallet_id
  optionalstr
  restrict operation to specific wallet
• change_account_id
  optionalstr
  account where change will go
• funding_account_ids
  optionalstr
  accounts to fund the transaction
• preview
  optionalbool
  do not broadcast the transaction
• blocking
  optionalbool
  wait until tx has synced

Returns

{
    "txid": "hash of transaction in hex",
    "height": "block where transaction was recorded",
    "inputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "outputs": [
        {
            "txid": "hash of transaction in hex",
            "nout": "position in the transaction",
            "height": "block where transaction was recorded",
            "amount": "value of the txo as a decimal",
            "address": "address of who can spend the txo",
            "confirmations": "number of confirmed blocks",
            "is_change": "payment to change address, only available when it can be determined",
            "is_received": "true if txo was sent from external account to this account",
            "is_spent": "true if txo is spent",
            "is_mine": "payment to one of your accounts, only available when it can be determined",
            "type": "one of 'claim', 'support' or 'purchase'",
            "name": "when type is 'claim' or 'support', this is the claim name",
            "claim_id": "when type is 'claim', 'support' or 'purchase', this is the claim id",
            "claim_op": "when type is 'claim', this determines if it is 'create' or 'update'",
            "value": "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
            "value_type": "determines the type of the 'value' field: 'channel', 'stream', etc",
            "protobuf": "hex encoded raw protobuf version of 'value' field",
            "permanent_url": "when type is 'claim' or 'support', this is the long permanent claim URL",
            "claim": "for purchase outputs only, metadata of purchased claim",
            "reposted_claim": "for repost claims only, metadata of claim being reposted",
            "signing_channel": "for signed claims only, metadata of signing channel",
            "is_channel_signature_valid": "for signed claims only, whether signature is valid",
            "purchase_receipt": "metadata for the purchase transaction associated with this claim"
        }
    ],
    "total_input": "sum of inputs as a decimal",
    "total_output": "sum of outputs, sans fee, as a decimal",
    "total_fee": "fee amount",
    "hex": "entire transaction encoded in hex"
}

wallet_status

Status of wallet including encryption/lock state.

Arguments

• wallet_id
  optionalstr
  status of specific wallet

Returns

Dictionary of wallet status information.

wallet_unlock

Unlock an encrypted wallet

Arguments

• password
  str
  password to use for unlocking
• wallet_id
  optionalstr
  restrict operation to specific wallet

Returns

(bool) true if wallet is unlocked, otherwise false