Skip to main content

API v1 Specification

Read API Function Reference​

get_{table}​

get_{table}(filters=[], filterop='AND', order_by=null, order_dir=null, start_block=null, end_block=null, status=null, limit=1000, offset=0, show_expired=true)

Where {table} must be one of the following values: assets, balances, bets, bet_expirations, bet_matches, bet_match_expirations, bet_match_resolutions, broadcasts, btcpays, burns, cancels, credits, debits, destructions, dispensers, dispenses, dividends, issuances, mempool, orders, order_expirations, order_matches, order_match_expirations, sends, or transactions .

For example: get_balances, get_credits, get_debits are all valid API methods. A complete list of tables can be found in the api.py file in the counterparty-core repository.

Parameters:

  • filters (list/dict): An optional filtering object, or list of filtering objects. See filtering for more information.
  • filterop (string): Specifies how multiple filter settings are combined. Defaults to AND, but OR can be specified as well. See filtering for more information.
  • **order_by ** (string): If sorted results are desired, specify the name of an attribute of the appropriate table to order the results by (e.g. quantity for balance object, if you called get_balances). If left blank, the list of results will be returned unordered.
  • order_dir (string): The direction of the ordering. Either ASC for ascending order, or DESC for descending order. Must be set if order_by is specified. Leave blank if order_by is not specified.
  • start_block (integer): If specified, only results from the specified block index on will be returned
  • end_block (integer): If specified, only results up to and including the specified block index on will be returned
  • status (string/list): return only results with the specified status or statuses (if a list of status strings is supplied). See the status list. Note that if null is supplied (the default), then status is not filtered. Also note that status filtering can be done via the filters parameter, but doing it through this parameter is more flexible, as it essentially allows for situations where OR filter logic is desired, as well as status-based filtering.
  • limit (integer): (maximum) number of elements to return. Can specify a value less than or equal to the instance's max limit (default 1000). For more results, use a combination of limit and offset parameters to paginate results. If the instance has a limit of 0 you can specify any limit for the row results, even 0 to get the full dataset.
  • offset (integer): return results starting from specified offset

Special Parameters:

  • show_expired (boolean): used only for get_orders. When false, get_orders doesn't return orders which expire next block.
  • memo_hex (string): used only for get_sends. When specified, filter the table for a hexadecimal value instead of searching by a text string.

Special Results:

  • memo (string): used only for get_sends. The utf-8 encoded string of the memo (like for pizza). This value will be an empty string for hexadecimal-encoded memo IDs that are not valud UTF-8 strings.
  • memo_hex (string): used only for get_sends. Returns the memo field expressed as a hexadecimal value (like 666f722070697a7a61).

Return:

A list of objects with attributes corresponding to the queried table fields.

Examples:

  • To get a listing of bets, call get_bets. This method will return a list of one or more bet object .
  • To get a listing all open orders for a given address like 1Ayw5aXXTnqYfS3LbguMCf9dxRqzbTVbjf, you could call get_orders with the appropriate parameters. This method will return a list of one or more order object.
  • To get all open "buy BTC" orders from the DEx, call get_orders and use the following filter: [{"field": "get_asset", "op": "==", "value": "BTC"}, {"field": "status", "op": "==", "value": "open"}].
  • To get all BTC pays (for DEx order matches) between the source 1Ayw5aXXTnqYfS3LbguMCf9dxRqzbTVbjf and destination (BTC buyer) 193SB3xgYjmfesdRqXq4g3eG9rD9DmWBSD, use get_btcpays method with these parameters: { "filters": [{"field": "source", "op": "==", "value": "1Ayw5aXXTnqYfS3LbguMCf9dxRqzbTVbjf"}, {"field": "destination", "op": "==", "value": "193SB3xgYjmfesdRqXq4g3eG9rD9DmWBSD"}],"filterop": "and"}

Notes:

  • Please note that the get_balances API call will not return balances for BTC itself. It only returns balances for XCP and other Counterparty assets. To get BTC-based balances, use an existing system such as Bitcoin Core, blockchain.info, etc.

get_asset_info​

get_asset_info(asset, assets)

Gets information on an issued asset.

Parameters:

  • asset (string): The name of the asset or subasset for which to retrieve the information.
  • assets (array): An array of names of the assets or subassets for which to retrieve the information.

Return:

null if the asset was not found. Otherwise, a list of one or more objects, each one with the following properties:

  • asset (string): The assets of the asset itself
  • asset_longname (string): The subasset longname, if any
  • owner (string): The address that currently owns the asset (i.e. has issuance rights to it)
  • divisible (boolean): Whether the asset is divisible or not
  • locked (boolean): Whether the asset is locked (future issuances prohibited)
  • total_issued (integer): The quantities of the asset issued, in total
  • description (string): The asset's current description
  • issuer (string): The asset's original owner (i.e. issuer)

get_dispenser_info​

get_dispenser_info()

Gets information on a dispenser.

Parameters:

  • tx_hash (string): The transaction hash identifier
  • tx_index (integer): The transaction index

Return:

null if the asset was not found. Otherwise, an object with the following properties:

  • asset (string): The assets of the asset itself
  • asset_longname (string): The subasset longname, if any
  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The address that made the bet
  • give_quantity (integer): The quantity given per dispense
  • escrow_quantity (integer): The quantity escrowed in the dispenser
  • give_remaining (integer): The quantity remaining in the dispenser
  • status (integer): The state of the dispenser. 0 for open, 10 for closed.
  • mainchainrate (integer): The quantity of the main chain asset (BTC) per dispensed portion.
  • fiat_price (float): The FIAT price per dispense
  • fiat_unit (string): The FIAT unit being used
  • satoshi_price (integer): The sats required for a dispense
  • oracle_price (float): The BTC price broadcast by the oracle
  • oracle_address (string): The address that is being used as the oracle
  • oracle_price_last_updated (integer): The block_index of the last update from the oracle
  • NOTE: If an oracle_address is given, mainchainrate format is X.XX (fiat) (ex. 1500 = 15.00).

get_supply​

get_supply(asset)

Parameters:

  • asset (string): The name of the asset or subasset for which to retrieve the information.

Return:

null if the asset was not found. Otherwise, a list of one or more objects, each one with the following properties:

get_asset_names​

get_asset_names()

Parameters:

None

Return:

A list of the names of all existing Counterparty assets, ordered alphabetically.

get_holder_count​

get_holder_count()

Parameters:

  • asset (string): The name of the asset or subasset for which to retrieve the information.

Return:

An object the asset name as the property name, and the holder count as the value of that property name.

get_holders​

get_holders()

Parameters:

  • asset (string): The name of the asset or subasset for which to retrieve the information.

Return:

A list of addresses that hold some quantity of the specified asset.

get_messages​

get_messages(block_index)

Return message feed activity for the specified block index. The message feed essentially tracks all database actions and allows for lower-level state tracking for applications that hook into it.

Parameters:

  • block_index (integer): The block index for which to retrieve activity.

Return:

A list of one or more message object if there was any activity in the block, otherwise [] (empty list).

get_messages_by_index​

get_messages_by_index(message_indexes)

Return the message feed messages whose message_index values are contained in the specified list of message indexes.

Parameters:

  • message_indexes (list): An array of one or more message_index values for which the cooresponding message feed entries are desired.

Return:

A list containing a message <#message-object>_ for each message found in the specified message_indexes list. If none were found, [] (empty list) is returned.

get_block_info​

get_block_info(block_index)

Gets basic information for a specific block.

Parameters:

  • block_index (integer): The block index for which to retrieve information.

Return:

If the block was found, an object with the following properties:

  • block_index (integer): The block index (i.e. block height). Should match what was specified for the block_index input parameter).
  • block_hash (string): The block hash identifier
  • block_time (integer): A UNIX timestamp of when the block was processed by the network

get_blocks​

get_blocks(block_indexes, min_message_index=null)

Gets block and message data (for each block) in a bulk fashon. If fetching info and messages for multiple blocks, this is much quicker than using multiple get_block_info() and get_messages() calls.

Parameters:

  • block_indexes (list): A list of 1 or more block indexes for which to retrieve the data.
  • min_message_index (string): Retrieve blocks from the message feed on or after this specific message index (useful since blocks may appear in the message feed more than once, if a reorg occurred). Note that if this parameter is not specified, the messages for the first block will be returned. If unsure, leave this blank.

Return:

A list of objects, one object for each valid block index specified, in order from first block index to last. Each object has the following properties:

  • block_index (integer): The block index (i.e. block height). Should match what was specified for the block_index input parameter).
  • block_hash (string): The block hash identifier
  • block_time (integer): A UNIX timestamp of when the block was processed by the network
  • _messages (list): A list of one or more message object if there was any activity in the block, otherwise [] (empty list).

get_running_info​

get_running_info()

Gets some operational parameters for the server.

Parameters:

None

Return:

An object with the following properties:

  • db_caught_up (boolean): true if block processing is caught up with the Bitcoin blockchain, false otherwise.
  • bitcoin_block_count (integer): The block height on the Bitcoin network (may not necessarily be the same as last_block, if the server is catching up)
  • last_block (integer): The index (height) of the last block processed by the server
  • last_message_index (integer): The index (ID) of the last message in the message feed
  • running_testnet (boolean): true if the server is configured for testnet, false if configured on mainnet.
  • running_testcoin (boolean): true if the server is configured for testcoin use, false if not (default).
  • version_major (integer): The major version of counterparty-server running
  • version_minor (integer): The minor version of counterparty-server running
  • version_revision (integer): The revision version of counterparty-server running
  • api_limit_rows (integer): The max amount of rows any call will return. If 0 there's no limit to calls. Defaults to 1000.

get_element_counts​

get_element_counts()

Gets the number of records for each entity type

Parameters:

None

Return:

An object with a property for each element type (e.g. transactions, blocks, bets, order_matches, etc.) with the value of each property being the record count of that respective entity in the database.

get_unspent_txouts​

get_unspent_txouts(address, unconfirmed=false, unspent_tx_hash=null)

Get a listing of UTXOs for the specified address.

Parameters:

  • address (string): The address for which to receive the UTXO listing
  • unconfirmed (boolean): Set to true to include unconfirmed UTXOs (e.g. those in the mempool)
  • unspent_tx_hash (boolean): Specify a specific transaction hash to only include UTXOs from that transaction
  • order_by (string): Sort results by specified field (e.g. height, -height)

Return:

A list of objects, with each entry in the dict having the following properties:

  • amount: The amount of the UTXO (e.g. 0.12345678)
  • value: The value of the UTXO in satoshis (e.g. 12345678)
  • height: The block height of the UTXO
  • confirmations: Number of confirmations since the UTXO was created
  • txid: The txid (hash) that the UTXO was included in
  • vout: The vout number in the specified txid for the UTXO

getrawtransaction​

getrawtransaction(tx_hash, verbose=false, skip_missing=false)

Gets raw data for a single transaction.

Parameters:

  • tx_hash (string): The transaction hash identifier
  • verbose (boolean): Include some additional information in the result data
  • skip_missing (boolean): If set to false, and the transaction hash cannot be found, return null, otherwise if true, throw an exception.

Return:

If found, a raw transaction objects having the same format as the bitcoind getrawtransaction API call. If not found, null.

getrawtransaction_batch​

getrawtransaction_batch(txhash_list, verbose=false, skip_missing=false)

Gets raw data for a list of transactions.

Parameters:

  • txhash_list (string): A list of transaction hash identifiers
  • verbose (boolean): Include some additional information in the result data for each transaction
  • skip_missing (boolean): If set to false, and one or more transaction hash cannot be found, the missing txhash data will not be included in the result set, otherwise if true, throw an exception.

Return:

A list of raw transaction objects having the same format as the bitcoind getrawtransaction API call.

search_raw_transactions​

search_raw_transactions(address, unconfirmed=true)

Gets raw transaction objects for the specified address.

Parameters:

  • address (string): The address for which to receive the raw transactions
  • unconfirmed (boolean): Set to true to include unconfirmed transactions (e.g. those in the mempool)

Return:

A list of raw transaction objects, with each object having the same format as the bitcoind getrawtransaction API call.

get_tx_info​

get_tx_info(tx_hex, block_index=null)

Get transaction info, as parsed by counterparty-server.

Parameters:

  • tx_hex (string): The canonical hexadecimal serialization of the transaction (not its hash)
  • block_index (integer)

Return:

A list with the following items (in order as listed below):

  • source
  • destination
  • btc_amount
  • fee
  • data: The embedded raw protocol data, in hexadecimal-serialized format

search_pubkey​

search_pubkey(pubkeyhash, provided_pubkeys=null)

For the specified pubkeyhash (i.e. address), return the public key. Note that this requires that the specified address has made at least one outgoing transaction.

Parameters:

  • pubkeyhash (string): The pubkeyhash/address
  • provided_pubkeys (list): A list of supplied pubkeys. If one of these pubkeys matches the pubkeyhash, used if one of the supplied pubkey hashes to the pubkeyhash. (Can be useful if the pubkeyhash has not sent out at least one transaction and you have a list of pubkeys that may match it.)

Return:

A string with the specified pubkey. If the pubkey cannot be found, an exception will be generated and returned.

unpack​

unpack(data_hex)

Parse the data_hex of a message into its parameters. Currently only works with send messages.

Parameters:

  • data_hex (string): The canonical hexadecimal serialization of the transaction (not its hash), e.g. from the data_hex return value from get_tx_info

Return:

  • message_type_id (int): the ID of the message type. Legacy sends are 0 and enhanced sends are 2.
  • unpacked (object): A map of message parameters. For legacy sends this object includes asset and quantity. For enhanced sends, this object includes address, asset, quantity and memo. For legacy sends, the source and destination are found using get_tx_info. For enhanced sends, the destination address is in the message parameters and the source may be found using get_tx_info.

Action/Write API Function Reference​

create_bet​

create_bet(source, feed_address, bet_type, deadline, wager_quantity, counterwager_quantity, expiration, target_value=0.0, leverage=5040)

Issue a bet against a feed.

Parameters:

  • source (string): The address that will make the bet.
  • feed_address (string): The address that hosts the feed to be bet on.
  • bet_type (integer): 0 for Bullish CFD (deprecated), 1 for Bearish CFD (deprecated), 2 for Equal, 3 for NotEqual.
  • deadline (integer): The time at which the bet should be decided/settled, in Unix time (seconds since epoch).
  • wager_quantity (integer): The quantities of XCP to wager (in satoshis, hence integer).
  • counterwager_quantity (integer): The minimum quantities of XCP to be wagered against, for the bets to match.
  • expiration (integer): The number of blocks after which the bet expires if it remains unmatched.
  • target_value (float, default=null): Target value for Equal/NotEqual bet
  • leverage (integer, default=5040): Leverage, as a fraction of 5040
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_broadcast​

create_broadcast(source, fee_fraction, text, timestamp, value)

Broadcast textual and numerical information to the network.

Parameters:

  • source (string): The address that will be sending (must have the necessary quantity of the specified asset).
  • fee_fraction (float): How much of every bet on this feed should go to its operator; a fraction of 1, (i.e. 0.05 is five percent).
  • text (string): The textual part of the broadcast.
  • timestamp (integer): The timestamp of the broadcast, in Unix time.
  • value (float): Numerical value of the broadcast.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_btcpay​

create_btcpay(order_match_id)

Create and (optionally) broadcast a BTCpay message, to settle an Order Match for which you owe BTC.

Parameters:

  • source (string): The source address of the btcpay transaction.
  • order_match_id (string): The concatenation of the hashes of the two transactions which compose the order match.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_burn​

create_burn(source, quantity)

Burn a given quantity of BTC for XCP (on mainnet, possible between blocks 278310 and 283810; on testnet it is still available).

Parameters:

  • source (string): The address with the BTC to burn.
  • quantity (integer): The quantities of BTC to burn (1 BTC maximum burn per address).
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_cancel​

create_cancel(offer_hash, source)

Cancel an open order or bet you created.

Parameters:

  • offer_hash (string): The transaction hash of the order or bet.
  • source (string): The source address of the order or bet.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_destroy​

create_destroy(source, asset, quantity, tag)

Destroy XCP or a user defined asset.

Parameters:

  • source (string): The address that will be sending (must have the necessary quantity of the specified asset).
  • asset (string): The asset or subasset to destroy.
  • quantity (integer): The quantities of the asset to destroy.
  • tag (string, optional): The tag (which works like a Memo ) associated with this transaction.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_dispenser​

create_dispenser(source, asset, give_quantity, escrow_quantity, mainchainrate, status, open_address, oracle_address)

Opens or closes a dispenser for a given asset at a given rate of main chain asset (BTC). Escrowed quantity on open must be equal or greater than give_quantity. It is suggested that you escrow multiples of give_quantity to ease dispenser operation.

Parameters:

  • source (string): The address that will be dispensing (must have the necessary escrow_quantity of the specified asset).
  • asset (string): The asset or subasset to dispense.
  • give_quantity (integer): The quantity of the asset to dispense.
  • escrow_quantity (integer): The quantity of the asset to reserve for this dispenser.
  • mainchainrate (integer): The quantity of the main chain asset (BTC) per dispensed portion.
  • open_address (string): The address that you would like to open the dispenser on.
  • oracle_address (string): The address that you would like to use as a price oracle for this dispenser.
  • status (integer): The state of the dispenser. 0 for open, 1 for open using open_address, 10 for closed.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

Notes:

  • When specifying an oracle_address, mainchainrate format becomes X.XX (fiat) (ex. 1500 = 15.00).
  • Dispensers can be opened on EMPTY addresses (address with no BTC or XCP history)
  • origin address is the source address that opens a dispenser on an EMPTY address
  • Dispensers can be opened, closed, and refilled via source or origin addresses
  • When closing a dispenser from origin, escrowed dispenser funds are credited to origin address
  • Use open_address param to operate on a dispenser from origin address
  • Dispensers have a MAX_DISPENSE limit of 1,000
  • Dispensers MAX_DISPENSE can be reset via a dispenser refill
  • Dispensers have a MAX_REFILL limit of 5
  • Dispensers have a CLOSE delay of 5 blocks

create_dividend​

create_dividend(source, quantity_per_unit, asset, dividend_asset)

Issue a dividend on a specific user defined asset.

Parameters:

  • source (string): The address that will be issuing the dividend (must have the ownership of the asset which the dividend is being issued on).
  • quantity_per_unit (integer): The amount of dividend_asset rewarded.
  • asset (string): The asset or subasset that the dividends are being rewarded on.
  • dividend_asset (string): The asset or subasset that the dividends are paid in.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_issuance​

create_issuance(source, asset, quantity, divisible, description, transfer_destination=null, lock, reset)

Issue a new asset, issue more of an existing asset, lock an asset, reset existing supply, or transfer the ownership of an asset.

Parameters:

  • source (string): The address that will be issuing or transfering the asset.
  • asset (string): The assets to issue or transfer. This can also be a subasset longname for new subasset issuances.
  • quantity (integer): The quantity of the asset to issue (set to 0 if transferring an asset).
  • divisible (boolean, default=true): Whether this asset is divisible or not (if a transfer, this value must match the value specified when the asset was originally issued).
  • description (string, default=''): A textual description for the asset.
  • transfer_destination (string, default=null): The address to receive the asset.
  • lock (boolean, default=false): Whether this issuance should lock supply of this asset forever.
  • reset (boolean, default=false): Wether this issuance should reset any existing supply.
  • NOTE: reset is only possible when no supply is issued, or when the asset owner has control of 100% of the supply.
  • NOTE: When resetting an assets supply, transfer_destination will not work in the same issuance as reset .
  • NOTE: Additional (advanced) parameters for this call are documented here.
  • NOTE: When resetting an assets supply, lock and transfer_destination will not work in the same issuance as reset .

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

Notes:

  • A named asset has an issuance cost of 0.5 XCP.
  • A subasset has an issuance cost of 0.25 XCP.
  • In order to issue an asset, BTC and XCP (for first time, non-free Counterparty assets) are required at the source address to pay fees.

create_order​

create_order(source, give_asset, give_quantity, get_asset, get_quantity, expiration)

Issue an order request.

Parameters:

  • source (string): The address that will be issuing the order request (must have the necessary quantity of the specified asset to give).
  • give_asset (string): The assets to give.
  • give_quantity (integer): The quantities of the asset to give.
  • get_asset (string): The assets requested in return.
  • get_quantity (integer): The quantities of the asset requested in return.
  • expiration (integer): The number of blocks for which the order should be valid.
  • fee_required (integer): The miners’ fee required to be paid by orders for them to match this one; in BTC; required only if buying BTC (may be zero, though)
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_send​

create_send(source, destination, asset, quantity)

Send XCP or a user defined asset.

To send multiple assets/destinations simultaneously you can pass an array of parameters to the destination, asset and quantity parameters. If one of these parameters is an array then the other must be an array of equal length. Each entry corresponds to the same entry index on the other arrays.

Parameters:

  • source (string): The address that will be sending (must have the necessary quantity of the specified asset).
  • destination (string, array[string]): The address to receive the asset.
  • asset (string, array[string]): The asset or subasset to send.
  • quantity (integer, array[integer]): The quantities of the asset to send.
  • memo (string, optional): The Memo associated with this transaction.
  • memo_is_hex (boolean, optional): If this is true, interpret the memo as a hexadecimal value. Defaults to false.
  • use_enhanced_send (boolean, optional): If this is false, the construct a legacy transaction sending bitcoin dust. Defaults to true.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

create_sweep​

create_sweep(source, destination, flags, memo)

Sends all assets and/or transfer ownerships to a destination address.

Parameters:

  • source (string): The address that will be sending.
  • destination (string): The address to receive the assets and/or ownerships.
  • flags (integer): An OR mask of flags indicating how the sweep should be processed. Possible flags are:
    • FLAG_BALANCES: (integer) 1, specifies that all balances should be transferred.
    • FLAG_OWNERSHIP: (integer) 2, specifies that all ownerships should be transferred.
    • FLAG_BINARY_MEMO: (integer) 4, specifies that the memo is in binary/hex form.
  • memo (string, optional): The Memo associated with this transaction.
  • NOTE: Additional (advanced) parameters for this call are documented here.

Return:

The unsigned transaction, as an hex-encoded string. Must be signed before being broadcast: see here for more information.

Advanced create_ parameters​

Each create_ call detailed below can take the following common keyword parameters:

  • encoding (string): The encoding method to use, see transaction encodings for more info.
  • pubkey (string/list): The hexadecimal public key of the source address (or a list of the keys, if multi‐sig). Required when using encoding parameter values of multisig or pubkeyhash. See transactions encoding for more info
  • allow_unconfirmed_inputs (boolean): Set to true to allow this transaction to utilize unconfirmed UTXOs as inputs. Defaults to false.
  • fee (integer): If you'd like to specify a custom miners' fee, specify it here (in satoshi). Leave as default for the server to automatically choose.
  • fee_per_kb (integer): The fee per kilobyte of transaction data constant that the server uses when deciding on the dynamic fee to use (in satoshi).
  • fee_provided (integer): If you would like to specify a maximum fee (up to and including which may be used as the transaction fee), specify it here (in satoshi). This differs from fee in that this is an upper bound value, which fee is an exact value.
  • custom_inputs (list): Use only these specific UTXOs as inputs for the transaction being created. If specified, this parameter is a list of (JSON-encoded) UTXO objects, whose properties match those as retrieved by listunspent function from bitcoind (e.g. see here). Note that the actual UTXOs used may be a subset of this list.
  • unspent_tx_hash (string): When compiling the UTXOs to use as inputs for the transaction being created, only consider unspent outputs from this specific transaction hash. Defaults to null to consider all UTXOs for the address. Do not use this parameter if you are specifying custom_inputs.
  • regular_dust_size (integer): Specify (in satoshi) to override the (dust) amount of BTC used for each non-(bare) multisig output. Defaults to 5430 satoshi.
  • multisig_dust_size (integer): Specify (in satoshi) to override the (dust) amount of BTC used for each (bare) multisig output. Defaults to 7800 satoshi.
  • dust_return_pubkey (string): The dust return pubkey is used in multi-sig data outputs (as the only real pubkey) to make those the outputs spendable. By default, this pubkey is taken from the pubkey used in the first transaction input. However, it can be overridden here (and is required to be specified if a P2SH input is used and multisig is used as the data output encoding.) If specified, specify the public key (in hex format) where dust will be returned to so that it can be reclaimed. Only valid/useful when used with transactions that utilize multisig data encoding. Note that if this value is set to false, this instructs counterparty-server to use the default dust return pubkey configured at the node level. If this default is not set at the node level, the call will generate an exception.
  • disable_utxo_locks (boolean): By default, UTXO's utilized when creating a transaction are "locked" for a few seconds, to prevent a case where rapidly generating create_ calls reuse UTXOs due to their spent status not being updated in bitcoind yet. Specify true for this parameter to disable this behavior, and not temporarily lock UTXOs.
  • op_return_value (integer): The value (in satoshis) to use with any OP_RETURN outputs in the generated transaction. Defaults to 0. Don't use this, unless you like throwing your money away.
  • extended_tx_info (boolean): When this is not specified or false, the create_ calls return only a hex-encoded string. If this is true, the create_ calls return a data object with the following keys: tx_hex, btc_in, btc_out, btc_change, and btc_fee.
  • p2sh_pretx_txid (string): The previous transaction txid for a two part P2SH message. This txid must be taken from the signed transaction.

With the exception of pubkey and allow_unconfirmed_inputs, these values should be left at their defaults, unless you know what you are doing.

Transaction Encodings​

By default the default value of the encoding parameter detailed above is auto, which means that counterparty-server automatically determines the best way to encode the Counterparty protocol data into a new transaction. If you know what you are doing and would like to explicitly specify an encoding:

  • To return the transaction as an OP_RETURN transaction, specify opreturn for the encoding parameter.
    • OP_RETURN transactions cannot have more than 80 bytes of data. If you force OP_RETURN encoding and your transaction would have more than this amount, an exception will be generated.
  • To return the transaction as a multisig transaction, specify multisig for the encoding parameter.
    • pubkey should be set to the hex-encoded public key of the source address.
    • Note that with the newest versions of Bitcoin (0.12.1 onward), bare multisig encoding does not reliably propagate. More information on this is documented here.
  • To return the transaction as a pubkeyhash transaction, specify pubkeyhash for the encoding parameter.
    • pubkey should be set to the hex-encoded public key of the source address.
  • To return the transaction as a 2 part P2SH transaction, specify P2SH for the encoding parameter.
    • First call the create_ method with the encoding set to P2SH.
    • Sign the transaction as usual and broadcast it. It's recommended but not required to wait the transaction to confirm as malleability is an issue here (P2SH isn't yet supported on segwit addresses).
    • The resulting txid must be passed again on an identic call to the create_ method, but now passing an additional parameter p2sh_pretx_txid with the value of the previous transaction's id.
    • The resulting transaction is a P2SH encoded message, using the redeem script on the transaction inputs as data carrying mechanism.
    • Sign the transaction following the Bitcoinjs-lib on javascript, signing a P2SH redeeming transaction section
    • NOTE: Don't leave pretxs hanging without transmitting the second transaction as this pollutes the UTXO set and risks making bitcoin harder to run on low spec nodes.

REST API Function Reference​

The REST API documentation is hosted both on our webiste and on a new API documentation platform called apiary.io. This experimental documentation, complementary to the one in this document, is located here.

get​

get(table_name, filters, filterop)

Query table_name in the database using filters concatenated using filterop.

URL format:

/rest/<table_name>/get?<table_filters>&op=<filter_op>

Example query:

/rest/sends/get?source=mn6q3dS2EnDUx3bmyWc6D4szJNVGtaR7zc&destination=mtQheFaSfWELRB2MyMBaiWjdDm6ux9Ezns&op=AND

Parameters:

  • table_name (string): The name of the desired table. List of all available tables: assets, balances, credits, debits, bets, bet_matches, broadcasts, btcpays, burns, cancels, dividends, issuances, orders, order_matches, sends, bet_expirations, order_expirations, bet_match_expirations, order_match_expirations, bet_match_resolutions, mempool
  • filters (dict, optional): Data filters as a dictionary. The filter format is same as for get_ JSON API queries. See Filtering Read API Results for more information on filters and Object Definitions for fields available for specific objects.
  • filterop (string, optional): The logical operator concatenating the filters. Defaults to AND.

Headers:

  • Accept (string, optional): The format of return data. Can be either application/json or application/xml. Defaults to JSON.

Return:

Desired database rows from table_name sieved using filters.

compose​

compose(message_type, transaction_params)

Compose a message_type transaction with transaction_params as data.

URL format:

/rest/<tx_type>/compose?<tx_data>

Example query:

/rest/send/compose?source=mn6q3dS2EnDUx3bmyWc6D4szJNVGtaR7zc&destination=mtQheFaSfWELRB2MyMBaiWjdDm6ux9Ezns&asset=BTC&quantity=1

Parameters:

  • message_type (string): The type of desired transaction message. List of all available transactions: bet, broadcast, btcpay, burn, cancel, dividend, issuance, order, send, publish, execute
  • transaction_params (dict): The parameters to be passed to the compose_transaction function. See Write API Function Reference for list of transactions and their parameters.

Headers:

  • Accept (string, optional): The format of return data. Can be either application/json or application/xml. Defaults to JSON.

Return:

The hex data of composed transaction.

Objects​

The API calls documented can return any one of these objects.

Balance Object​

An object that describes a balance that is associated to a specific address:

  • address (string): A PubkeyHash Bitcoin address, or the pubkey associated with it (in case the address hasn’t sent anything before).
  • asset (string): The ID of the assets in which the balance is specified
  • quantity (integer): The quantities of the specified asset at this address

Bet Object​

An object that describes a specific bet:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The address that made the bet
  • feed_address (string): The address with the feed that the bet is to be made on
  • bet_type (integer): 0 for Bullish CFD (deprecated), 1 for Bearish CFD (deprecated), 2 for Equal, 3 for Not Equal
  • deadline (integer): The timestamp at which the bet should be decided/settled, in Unix time.
  • wager_quantity (integer): The quantities of XCP to wager
  • counterwager_quantity (integer): The minimum quantities of XCP to be wagered by the user to bet against the bet issuer, if the other party were to accept the whole thing
  • wager_remaining (integer): The quantity of XCP wagered that is remaining to bet on
  • odds (float):
  • target_value (float): Target value for Equal/NotEqual bet
  • leverage (integer): Leverage, as a fraction of 5040
  • expiration (integer): The number of blocks for which the bet should be valid
  • fee_multiplier (integer): How much of every bet on this feed should go to its operator; a fraction of 1, (i.e. 0.05 is five percent)
  • validity (string): Set to "valid" if a valid bet. Any other setting signifies an invalid/improper bet

Bet Match Object​

An object that describes a specific occurance of two bets being matched (either partially, or fully):

  • tx0_index (integer): The Bitcoin transaction index of the initial bet
  • tx0_hash (string): The Bitcoin transaction hash of the initial bet
  • tx0_block_index (integer): The Bitcoin block index of the initial bet
  • tx0_expiration (integer): The number of blocks over which the initial bet was valid
  • tx0_address (string): The address that issued the initial bet
  • tx0_bet_type (string): The type of the initial bet (0 for Bullish CFD (deprecated), 1 for Bearish CFD (deprecated), 2 for Equal, 3 for Not Equal)
  • tx1_index (integer): The transaction index of the matching (counter) bet
  • tx1_hash (string): The transaction hash of the matching bet
  • tx1_block_index (integer): The block index of the matching bet
  • tx1_address (string): The address that issued the matching bet
  • tx1_expiration (integer): The number of blocks over which the matching bet was valid
  • tx1_bet_type (string): The type of the counter bet (0 for Bullish CFD (deprecated), 1 for Bearish CFD (deprecated), 2 for Equal, 3 for Not Equal)
  • feed_address (string): The address of the feed that the bets refer to
  • initial_value (integer):
  • deadline (integer): The timestamp at which the bet match was made, in Unix time.
  • target_value (float): Target value for Equal/NotEqual bet
  • leverage (integer): Leverage, as a fraction of 5040
  • forward_quantity (integer): The quantities of XCP bet in the initial bet
  • backward_quantity (integer): The quantities of XCP bet in the matching bet
  • fee_multiplier (integer):
  • validity (string): Set to "valid" if a valid order match. Any other setting signifies an invalid/improper order match

Broadcast Object​

An object that describes a specific occurance of a broadcast event (i.e. creating/extending a feed):

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The address that made the broadcast
  • timestamp (string): The time the broadcast was made, in Unix time.
  • value (float): The numerical value of the broadcast
  • fee_multiplier (float): How much of every bet on this feed should go to its operator; a fraction of 1, (i.e. 0.05 is five percent)
  • text (string): The textual component of the broadcast
  • validity (string): Set to "valid" if a valid broadcast. Any other setting signifies an invalid/improper broadcast

BTCPay Object​

An object that matches a request to settle an Order Match for which BTC is owed:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string):
  • order_match_id (string):
  • validity (string): Set to "valid" if valid

Burn Object​

An object that describes an instance of a specific burn:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The address the burn was performed from
  • burned (integer): The quantities of BTC burned
  • earned (integer): The quantities of XPC actually earned from the burn (takes into account any bonus quantitys, 1 BTC limitation, etc)
  • validity (string): Set to "valid" if a valid burn. Any other setting signifies an invalid/improper burn

Cancel Object​

An object that describes a cancellation of a (previously) open order or bet:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The address with the open order or bet that was cancelled
  • offer_hash (string): The transaction hash of the order or bet cancelled
  • validity (string): Set to "valid" if a valid burn. Any other setting signifies an invalid/improper burn

Debit/Credit Object​

An object that describes a account debit or credit:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • address (string): The address debited or credited
  • asset (string): The assets debited or credited
  • quantity (integer): The quantities of the specified asset debited or credited

Dividend Object​

An object that describes an issuance of dividends on a specific user defined asset:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The address that issued the dividend
  • asset (string): The assets that the dividends are being rewarded on
  • quantity_per_unit (integer): The quantities of XCP rewarded per whole unit of the asset
  • validity (string): Set to "valid" if a valid burn. Any other setting signifies an invalid/improper burn

Issuance Object​

An object that describes a specific occurance of a user defined asset being issued, or re-issued:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • asset (string): The assets being issued, or re-issued
  • asset_longname (string): The subasset longname, if any
  • quantity (integer): The quantities of the specified asset being issued
  • divisible (boolean): Whether or not the asset is divisible (must agree with previous issuances of the asset, if there are any)
  • issuer (string):
  • transfer (boolean): Whether or not this objects marks the transfer of ownership rights for the specified quantity of this asset
  • validity (string): Set to "valid" if a valid issuance. Any other setting signifies an invalid/improper issuance

Order Object​

An object that describes a specific order:

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The address that made the order
  • give_asset (string): The assets being offered
  • give_quantity (integer): The quantities of the specified asset being offered
  • give_remaining (integer): The quantities of the specified give asset remaining for the order
  • get_asset (string): The assets desired in exchange
  • get_quantity (integer): The quantities of the specified asset desired in exchange
  • get_remaining (integer): The quantities of the specified get asset remaining for the order
  • price (float): The given exchange rate (as an exchange ratio desired from the asset offered to the asset desired)
  • expiration (integer): The number of blocks over which the order should be valid
  • fee_provided (integer): The miners' fee provided; in BTC; required only if selling BTC (should not be lower than is required for acceptance in a block)
  • fee_required (integer): The miners' fee required to be paid by orders for them to match this one; in BTC; required only if buying BTC (may be zero, though)

Order Match Object​

An object that describes a specific occurance of two orders being matched (either partially, or fully):

  • tx0_index (integer): The Bitcoin transaction index of the first (earlier) order
  • tx0_hash (string): The Bitcoin transaction hash of the first order
  • tx0_block_index (integer): The Bitcoin block index of the first order
  • tx0_expiration (integer): The number of blocks over which the first order was valid
  • tx0_address (string): The address that issued the first (earlier) order
  • tx1_index (integer): The transaction index of the second (matching) order
  • tx1_hash (string): The transaction hash of the second order
  • tx1_block_index (integer): The block index of the second order
  • tx1_address (string): The address that issued the second order
  • tx1_expiration (integer): The number of blocks over which the second order was valid
  • forward_asset (string): The assets exchanged FROM the first order to the second order
  • forward_quantity (integer): The quantities of the specified forward asset
  • backward_asset (string): The assets exchanged FROM the second order to the first order
  • backward_quantity (integer): The quantities of the specified backward asset
  • validity (string): Set to "valid" if a valid order match. Any other setting signifies an invalid/improper order match

Send Object​

An object that describes a specific send (e.g. "simple send", of XCP, or a user defined asset):

  • tx_index (integer): The transaction index
  • tx_hash (string): The transaction hash
  • block_index (integer): The block index (block number in the block chain)
  • source (string): The source address of the send
  • destination (string): The destination address of the send
  • asset (string): The assets being sent
  • quantity (integer): The quantities of the specified asset sent
  • validity (string): Set to "valid" if a valid send. Any other setting signifies an invalid/improper send
  • memo (string): The memo associated with this transaction

Message Object​

An object that describes a specific event in the counterpartyd message feed (which can be used by 3rd party applications to track state changes to the counterpartyd database on a block-by-block basis).

  • message_index (integer): The message index (i.e. transaction index)
  • block_index (integer): The block index (block number in the block chain) this event occurred on
  • category (string): A string denoting the entity that the message relates to, e.g. "credits", "burns", "debits". The category matches the relevant table name in counterpartyd (see blocks.py for more info).
  • command (string): The operation done to the table noted in category. This is either "insert", or "update".
  • bindings (string): A JSON-encoded object containing the message data. The properties in this object match the columns in the table referred to by category.

Bet Expiration Object​

An object that describes the expiration of a bet created by the source address.

  • bet_index (integer): The transaction index of the bet expiring
  • bet_hash (string): The transaction hash of the bet expiriing
  • block_index (integer): The block index (block number in the block chain) when this expiration occurred
  • source (string): The source address that created the bet

Order Expiration Object​

An object that describes the expiration of an order created by the source address.

  • order_index (integer): The transaction index of the order expiring
  • order_hash (string): The transaction hash of the order expiriing
  • block_index (integer): The block index (block number in the block chain) when this expiration occurred
  • source (string): The source address that created the order

Bet Match Expiration Object​

An object that describes the expiration of a bet match.

  • bet_match_id (integer): The transaction index of the bet match ID (e.g. the concatenation of the tx0 and tx1 hashes)
  • tx0_address (string): The tx0 (first) address for the bet match
  • tx1_address (string): The tx1 (second) address for the bet match
  • block_index (integer): The block index (block number in the block chain) when this expiration occurred

Order Match Expiration Object​

An object that describes the expiration of an order match.

  • order_match_id (integer): The transaction index of the order match ID (e.g. the concatenation of the tx0 and tx1 hashes)
  • tx0_address (string): The tx0 (first) address for the order match
  • tx1_address (string): The tx1 (second) address for the order match
  • block_index (integer): The block index (block number in the block chain) when this expiration occurred

Status​

Here the list of all possible status for each table:

  • balances: No status field
  • bet_expirations: No status field
  • bet_match_expirations: No status field
  • bet_matches: pending, settled: liquidated for bear (deprecated), settled, settled: liquidated for bull (deprecated), settled: for equal, settled: for notequal, dropped, expired
  • bets: open, filled, cancelled, expired, dropped, invalid: {problem(s)}
  • broadcasts: valid, invalid: {problem(s)}
  • btcpays: valid, invalid: {problem(s)}
  • burns: valid, invalid: {problem(s)}
  • cancels: valid, invalid: {problem(s)}
  • credits: No status field
  • debits: No status field
  • dividends: valid, invalid: {problem(s)}
  • issuances: valid, invalid: {problem(s)}
  • order_expirations: No status field
  • order_match_expirations: No status field
  • order_matches: pending, completed, expired
  • orders: open, filled, canceled, expired, invalid: {problem(s)}
  • sends: valid, invalid: {problem(s)}