Worker 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.
  • Endpoints:
    • US-East endpoint: https://us-east-api.grinmint.com
    • EU-West endpoint: https://eu-west-api.grinmint.com
  • Workers

    Returns json data about all the workers of a single user.

  • URL

    /v1/user/:user/workers

  • Method:

    GET

  • URL Params

    Required:

    user=[string]

  • Data Params

    None

  • Success Response:

    • Code: 404 or 500

    • Content:

      Field Type Description
      status bool Response Status
      workers []object Array of workers
      - name string Name of the worker
      - agent string Agent of the worker
      - last_seen string Last time the worker submitted a share
      - current_primary_hashrate number Current user primary PoW hashrate
      - average_primary_hashrate number Average user primary PoW hashrate
      - current_secondary_hashrate number Current user secondary PoW hashrate
      - average_secondary_hashrate number Average user secondary PoW hashrate
      - valid_shares number Number of valid shares submitted
      - rejected_shares number Number of rejected shares submitted
      - stale_shares number Number of stale shares submitted
  • Error Response:

    • Code: 200

    • Content:

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

      $.ajax({
        url: "/v1/user/quentin@blockcypher.com/workers",
        dataType: "json",
        type : "GET",
        success : function(r) {
            console.log(r);
        }
      });
  • Worker Stats

    Returns json data about a single worker.

  • URL

    /v1/user/:user/worker/:worker/workerStats

  • Method:

    GET

  • URL Params

    Required:

    user=[string]
    worker=[string]

  • Data Params

    None

  • Success Response:

    • Code: 200

    • Content:

      Field Type Description
      status bool Response Status
      worker object Array of workers
      - name string Name of the worker
      - agent string Agent of the worker
      - last_seen string Last time the worker submitted a share
      - current_primary_hashrate number Current user primary PoW hashrate
      - average_primary_hashrate number Average user primary PoW hashrate
      - current_secondary_hashrate number Current user secondary PoW hashrate
      - average_secondary_hashrate number Average user secondary PoW hashrate
      - valid_shares number Number of valid shares submitted
      - rejected_shares number Number of rejected shares submitted
      - stale_shares number Number of stale shares submitted
  • Error Response:

    • Code: 404 or 500

    • Content:

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

      $.ajax({
        url: "/v1/user/quentin@blockcypher.com/worker/rig1/workerStats",
        dataType: "json",
        type : "GET",
        success : function(r) {
          console.log(r);
        }
      });
  • Worker History

    Returns json data about the worker hashrate historical data.

  • URL

    /v1/user/:user/worker/:worker/workerHistory

  • Method:

    GET

  • URL Params

    user=[string]
    worker=[string]

  • Data Params

    None

  • Success Response:

    • Code: 200

    • Content:

      Field Type Description
      status bool Response Status
      name string Name of the worker
      agent string Agent of the worker
      last_seen string Last time the worker submitted a share
      hashrates []object Array of primary PoW hashrate data
      - time number Time of the data
      - primary_hashrate number Primary PoW Hashrate at that time
      - average_primary_hashrate number Average primary PoW hashrate at that time
      - secondary_hashrate number Secondary PoW Hashrate at that time
      - average_secondary_hashrate number Average secondary PoW 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/user/quentin@blockcypher.com/worker/rig1/workerHistory",
        dataType: "json",
        type : "GET",
        success : function(r) {
          console.log(r);
        }
      });
  • Grin is an experimental coin: use at your own risk! Grinmint does not guarantee any return on mining time or hashpower. You are strongly encouraged to move your rewards off the pool as often as possible into a wallet that you control. Although Grinmint takes multiple precautions to keep our users' coins safe, we do not offer any guarantee against hacks or loss. Grinmint is not a wallet. You, the user, assume the risk for any coins left on Grinmint. 60 days after coin maturity, your coins are considered expired and you will no longer be able to request payouts for them.