# Generated by Scrape::ApiDefinitionsJob: 2018-11-29 05:54:53 UTC
# See: https://git.io/vx5CY
---
- name: transaction_status_api
  description: |
    This API is intended to evaluate a transaction status after calling [`condenser_api.broadcast_transaction`]({{ '/apidefinitions/#condenser_api.broadcast_transaction' | relative_url }}).
    
    To enable this API for `hived`, the following is required in `config.ini` by specifying:
    
    ```ini
    plugin = transaction_status_api
    ```
    
    See: [#3060]({{ 'https://github.com/steemit/steem/pull/3060' | archived_url }})
  methods:
  - api_method: transaction_status_api.find_transaction
    since: HF23
    purpose: |
      Returns the status of a given transaction id.  Parameters: `trx_id:string`; `expiration:timestamp` (optional)
      
      The result will contain one of the following `status` values:
      
      | Status | Meaning |
      |--------|---------|
      | `unknown` | Expiration time in future, transaction not included in block or mempool |
      | `within_mempool` | Transaction in mempool |
      | `within_reversible_block` | Transaction has been included in block, block not irreversible |
      | `within_irreversible_block` | Transaction has been included in block, block is irreversible |
      | `expired_reversible` | Transaction has expired, transaction is not irreversible (transaction could be in a fork) |
      | `expired_irreversible` | Transaction has expired, transaction is irreversible (transaction cannot be in a fork) |
      | `too_old` | Transaction is too old, I don't know about it |
    parameter_json: '{"transaction_id":"0000000000000000000000000000000000000000", "expiration":"2016-03-24T18:00:21"}'
    expected_response_json: '{"status":"unknown"}'
    curl_examples:
    -  '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000"}, "id":1}'
    -  '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000", "expiration":"2016-03-24T18:00:21"}, "id":1}'
    client_docs:
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
