Pool Endpoint

  • Access to the API is limited to 150 requests / minutes / ip.
  • All API Response are cached for 2 minutes.
  • All endpoints are CORS enabled.
  • Endpoint: http://api.grinmint.com

Pool Stats

Returns json data about various pool statistics.

  • URL

    /v1/poolStats

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200

    • Content:

      Field Type Description
      status bool Response Status
      mined_block []object Array of blocks recently mined by the pool
      - height number Height of the block mined
      - time number Mined on
      - block_hash string Hash of the mined block
      pool_stats []object General pool stats
      - hashrate number Current pool hashrate
      - users number Number of currently active users
      - workers number Number of currently active workers
      - blocks_found_last_hour number Number of blocks found last hour
      - blocks_found_last_24_hours number Number of blocks found in the last 24 hours
      top_user []object Top 10 users by hashrate
      - rank number Rank of the user
      - hashrate number Hashrate of the user
  • Error Response:

    • Code: 404 or 500

    • Content:

      Field Type Description
      status bool Response Status
      message string Reason for error
  • Sample Call:

      $.ajax({
        url: "/v1/poolStats",
        dataType: "json",
        type : "GET",
        success : function(r) {
            console.log(r);
        }
      });

Pool History

Returns json data about the pool hashrate historical data.

  • URL

    /v1/poolHistory

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200

    • Content:

      Field Type Description
      status bool Response Status
      hashrates []object Array of hashrate data
      - time number Time of the data
      - hashrate number Hashrate at that time
      - average_hashrate number Average hashrate at that time
  • Error Response:

    • Code: 404 or 500

    • Content:

      Field Type Description
      status bool Response Status
      message string Reason for error
  • Sample Call:

      $.ajax({
        url: "/v1/poolHistory",
        dataType: "json",
        type : "GET",
        success : function(r) {
            console.log(r);
        }
      });

Network Stats

Returns json data about various network statistics.

  • URL

    /v1/networkStats

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200

    • Content:

      Field Type Description
      status bool Response Status
      height number Current block height
      last_block_pushed string Hash of the last block
      prev_block_to_last string Hash of the previous block
      target_difficulty number Network target difficulty
      total_difficulty number Network total difficulty
      hashrate number Current network hashrate
  • Error Response:

    • Code: 404 or 500

    • Content:

      Field Type Description
      status bool Response Status
      message string Reason for error
  • Sample Call:

      $.ajax({
        url: "/v1/networkStats",
        dataType: "json",
        type : "GET",
        success : function(r) {
            console.log(r);
        }
      });

Network History

Returns json data about the network historical data.

  • URL

    /networkHistory

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200

    • Content:

      Field Type Description
      status bool Response Status
      network_stats []object Array of network statistics
      - time number Time of the data
      - target_difficulty number Target difficulty
      - hashrate number Hashrate at that time
  • Error Response:

    • Code: 404 or 500

    • Content:

      Field Type Description
      status bool Response Status
      message string Reason for error
  • Sample Call:

      $.ajax({
        url: "/v1/networkHistory",
        dataType: "json",
        type : "GET",
        success : function(r) {
            console.log(r);
        }
      });