# Generated by Scrape::ApiDefinitionsJob: 2018-09-25 01:15:43 UTC
# See: https://git.io/vx5CY
---
- name: Market history API
  description: Used to lookup market history information. **These AppBase API methods
    are still under development and subject to change.**
  methods:
  - api_method: market_history_api.get_market_history
    purpose: Returns the market history for the internal SBD:STEEM market.
    parameter_json: '{"bucket_seconds":0,"start":"1970-01-01T00:00:00","end":"1970-01-01T00:00:00"}'
    expected_response_json: '{"buckets":[]}'
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":15,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":60,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":300,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":3600,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":86400,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"},
      "id":1}'
  - api_method: market_history_api.get_market_history_buckets
    purpose: Returns the bucket seconds being tracked by the plugin.
    parameter_json: "{}"
    expected_response_json: '{"bucket_sizes":[]}'
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history_buckets",
      "id":1}'
  - api_method: market_history_api.get_order_book
    purpose: Returns the internal market order book.
    parameter_json: '{"limit":500}'
    expected_response_json: '{"bids":[],"asks":[]}'
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_order_book", "params":{"limit":10},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_order_book", "params":{"limit":50},
      "id":1}'
  - api_method: market_history_api.get_recent_trades
    purpose: Returns the most recent trades for the internal SBD:STEEM market.
    parameter_json: '{"limit":1000}'
    expected_response_json: '{"trades":[]}'
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_recent_trades", "params":{"limit":10},
      "id":1}'
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_recent_trades", "params":{"limit":500},
      "id":1}'
  - api_method: market_history_api.get_ticker
    purpose: Returns the market ticker for the internal SBD:STEEM market.
    parameter_json: "{}"
    expected_response_json: '{"latest":"0.00000000000000000","lowest_ask":"0.00000000000000000","highest_bid":"0.00000000000000000","percent_change":"0.00000000000000000","steem_volume":{"amount":"0","precision":3,"nai":"@@000000021"},"sbd_volume":{"amount":"0","precision":3,"nai":"@@000000013"}}'
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_ticker", "id":1}'
  - api_method: market_history_api.get_trade_history
    purpose: Returns the trade history for the internal SBD:STEEM market.
    parameter_json: '{"start":"1970-01-01T00:00:00","end":"1970-01-01T00:00:00","limit":1000}'
    expected_response_json: '{"trades":[]}'
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_trade_history", "params":{"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00","limit":10},
      "id":1}'
  - api_method: market_history_api.get_volume
    purpose: Returns the market volume for the past 24 hours.
    parameter_json: "{}"
    expected_response_json: '{"steem_volume":{"amount":"0","precision":3,"nai":"@@000000021"},"sbd_volume":{"amount":"0","precision":3,"nai":"@@000000013"}}'
    curl_examples:
    - '{"jsonrpc":"2.0", "method":"market_history_api.get_volume", "id":1}'
