Miner.farm API Documentation


  • Staff

    Miner.farm API Documentation

    Overview

    The miner.farm API is available so you can use your account and farm data in your own dashboards and/or phone apps.

    Communication is POST request to https://miner.farm/api/v1/<shortkey>/<longkey>
    Where short and long keys are the account API keys. These keys are generated on account creation, and can be regenerated by the user on the Account Page.

    Usage

    Example command: curl -X POST https://miner.farm/api/v1/shortKeyhere/longKeyHere

    Data Structure

    A sample of data currently returned (some whitespace added for readability):

    {
    "Account":{"URL":"hella_cool","ID":10,"Type":"Pro","Private":"N,0","FarmName":"Hella Cool","Email":"email@host.not","Expires":"2038-01-31T00:00:00Z"},
    
    "Request":{"URL":"https://miner.farm/api/v1/sdfsdS/sO1rRjKjIqnVQTks3xxXXxxXxxXxOzZMuZAX0jOYnC","Date":"2017-08-07T18:04:19Z"},
    
    "Data":{
        "11":{"Hostname":"Icey (Centos6).1","Comment":"","Summary":"Elapsed=14409089,MHS 5s=530.0,Found Blocks=6225,Accepted=6174426,Rejected=1047,Hardware Errors=1076,","Port":4028,"Group":"89766","Alias":"","Version":"Miner=FakeMiner 0.8.1,API=1.0","Devices":"ASC=0,MHS 5s=107.0,Accepted=1029125,Rejected=174,Hardware Errors=169,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=1,MHS 5s=103.0,Accepted=1028867,Rejected=182,Hardware Errors=184,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=2,MHS 5s=108.0,Accepted=1028049,Rejected=175,Hardware Errors=188,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=3,MHS 5s=100.0,Accepted=1029655,Rejected=178,Hardware Errors=187,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=4,MHS 5s=103.0,Accepted=1029177,Rejected=148,Hardware Errors=169,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=5,MHS 5s=101.0,Accepted=1029556,Rejected=190,Hardware Errors=179,Temperature=30,Status=Alive,Last Share Pool=0,somedata,","IP":"127.0.0.1","MonProfile":0,"Access":"Read Write","Pools":"POOL=0,URL=http://fakepool.com:1234,Status=Alive,Priority=0,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=1,URL=http://pseudopool.com:8585,Status=Alive,Priority=1,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=2,URL=http://notapool.com:3333,Status=Alive,Priority=2,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=3,URL=http://dedpool.com:666,Status=Dead,Priority=3,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=4,URL=http://fauxpool.com:1101,Status=Alive,Priority=4,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\n"},
    
        "2":{"Hostname":"ZULU.2","Comment":"","Summary":"Elapsed=2234158,MHS 5s=2090.0,","Port":4029,"Group":"WYLXR83426","Alias":"","Version":"Miner=FakeMiner 0.7.0,API=1.0","Devices":"ASC=0,MHS 5s=206.0,Accepted=223416,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=1,MHS 5s=208.0,Accepted=223416,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=2,MHS 5s=208.0,Accepted=223415,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=3,MHS 5s=205.0,Accepted=223415,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=4,MHS 5s=202.0,Accepted=223416,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=5,MHS 5s=209.0,Accepted=223416,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=6,MHS 5s=206.0,Accepted=223415,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=7,MHS 5s=207.0,Accepted=223415,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=8,MHS 5s=204.0,Accepted=223415,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=9,MHS 5s=209.0,Accepted=223415,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,","IP":"127.0.0.1","MonProfile":0,"Access":"Miner Unavailable","Pools":"POOL=0,URL=http://fakepool.com:1234,Status=Alive,Priority=0,User=fakeu22,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=1,URL=http://pseudopool.com:8585,Status=Alive,Priority=1,User=fakeu22,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=2,URL=http://notapool.com:3333,Status=Alive,Priority=2,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=3,URL=http://dedpool.com:666,Status=Dead,Priority=3,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=4,URL=http://fauxpool.com:1101,Status=Alive,Priority=4,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\n"},
    
        "17":{"Hostname":"Zulu.2","Comment":null,"Summary":"Elapsed=168920,MHS 5s=1560.0,Found Blocks=119,Accepted=110282,Rejected=11,Hardware Errors=22,","Port":4029,"Group":"ZILIO00352","Alias":null,"Version":"Miner=FakeMiner 0.8.1,API=1.0","Devices":"ASC=0,MHS 5s=127.0,Accepted=8532,Rejected=1,Hardware Errors=,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=1,MHS 5s=125.0,Accepted=8511,Rejected=,Hardware Errors=,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=2,MHS 5s=131.0,Accepted=8472,Rejected=,Hardware Errors=1,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=3,MHS 5s=125.0,Accepted=8457,Rejected=1,Hardware Errors=2,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=4,MHS 5s=129.0,Accepted=8413,Rejected=1,Hardware Errors=3,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=5,MHS 5s=133.0,Accepted=8512,Rejected=1,Hardware Errors=3,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=6,MHS 5s=130.0,Accepted=8519,Rejected=1,Hardware Errors=,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=7,MHS 5s=128.0,Accepted=8478,Rejected=2,Hardware Errors=2,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=8,MHS 5s=127.0,Accepted=8515,Rejected=,Hardware Errors=4,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=9,MHS 5s=127.0,Accepted=8424,Rejected=1,Hardware Errors=2,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=10,MHS 5s=127.0,Accepted=8414,Rejected=1,Hardware Errors=1,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=11,MHS 5s=126.0,Accepted=8461,Rejected=2,Hardware Errors=2,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=12,MHS 5s=129.0,Accepted=8581,Rejected=,Hardware Errors=2,Temperature=30,Status=Alive,Last Share Pool=0,somedata,","IP":"127.0.0.1","MonProfile":0,"Access":"Read Write","Pools":"POOL=0,URL=http://fakepool.com:1234,Status=Alive,Priority=0,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=1,URL=http://pseudopool.com:8585,Status=Alive,Priority=1,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=2,URL=http://notapool.com:3333,Status=Alive,Priority=2,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=3,URL=http://dedpool.com:666,Status=Dead,Priority=3,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=4,URL=http://rejectpool.com:1101,Status=Alive,Priority=4,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Reject,Pool Rejected%=7.3,\n"},
    
        "1":{"Hostname":"ZULU.1","Comment":"","Summary":"Elapsed=2234162,MHS 5s=1524.0,","Port":4028,"Group":"WYLXR83426","Alias":"","Version":"Miner=FakeMiner 0.7.0,API=1.0","Devices":"ASC=0,MHS 5s=127.0,Accepted=223417,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=1,MHS 5s=131.0,Accepted=223416,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=2,MHS 5s=133.0,Accepted=223417,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=3,MHS 5s=132.0,Accepted=223417,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=4,MHS 5s=134.0,Accepted=223417,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=5,MHS 5s=132.0,Accepted=223417,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=6,MHS 5s=130.0,Accepted=223417,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=7,MHS 5s=132.0,Accepted=223417,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=8,MHS 5s=134.0,Accepted=223416,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=9,MHS 5s=130.0,Accepted=223417,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=10,MHS 5s=129.0,Accepted=223416,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=11,MHS 5s=128.0,Accepted=223417,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,","IP":"127.0.0.1","MonProfile":0,"Access":"Miner Unavailable","Pools":"POOL=0,URL=http://fakepool.com:1234,Status=Alive,Priority=0,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=1,URL=http://pseudopool.com:8585,Status=Alive,Priority=1,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=2,URL=http://notapool.com:3333,Status=Alive,Priority=2,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=3,URL=http://dedpool.com:666,Status=Dead,Priority=3,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=4,URL=http://fauxpool.com:1101,Status=Alive,Priority=4,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\n"},
    
        "18":{"Hostname":"Zulu.4","Comment":null,"Summary":"","Port":4031,"Group":"ZILIO00352","Alias":null,"Version":"","Devices":"","IP":"127.0.0.1","MonProfile":0,"Access":"Connection Failed","Pools":""},"16":{"Hostname":"Zulu.5","Comment":null,"Summary":"","Port":4032,"Group":"ZILIO00352","Alias":null,"Version":"","Devices":"","IP":"127.0.0.1","MonProfile":0,"Access":"Connection Failed","Pools":""},"13":{"Hostname":"Icey (Centos6).3","Comment":"","Summary":"Elapsed=4406487,MHS 5s=500.0,Found Blocks=1547,Accepted=1529977,Rejected=267,Hardware Errors=246,","Port":4030,"Group":"89766","Alias":"","Version":"Miner=FakeMiner 0.8.1,API=1.0","Devices":"GPU=0,MHS 5s=102.0,Accepted=254528,Rejected=48,Hardware Errors=48,Temperature=80.5,Status=Alive,Last Share Pool=0,somedata,\nGPU=1,MHS 5s=104.0,Accepted=255047,Rejected=34,Hardware Errors=43,Temperature=80.5,Status=Alive,Last Share Pool=0,somedata,\nGPU=2,MHS 5s=105.0,Accepted=254892,Rejected=49,Hardware Errors=32,Temperature=80.5,Status=Alive,Last Share Pool=0,somedata,\nGPU=3,MHS 5s=102.0,Accepted=254915,Rejected=47,Hardware Errors=50,Temperature=80.5,Status=Alive,Last Share Pool=0,somedata,\nGPU=4,MHS 5s=106.0,Accepted=255628,Rejected=43,Hardware Errors=37,Temperature=80.5,Status=Alive,Last Share Pool=0,somedata,\nGPU=5,MHS 5s=106.0,Accepted=254972,Rejected=46,Hardware Errors=36,Temperature=80.5,Status=Alive,Last Share Pool=0,somedata,","IP":"127.0.0.1","MonProfile":0,"Access":"Read Write","Pools":"POOL=0,URL=http://fakepool.com:1234,Status=Alive,Priority=0,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=1,URL=http://pseudopool.com:8585,Status=Alive,Priority=1,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=2,URL=http://notapool.com:3333,Status=Alive,Priority=2,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=3,URL=http://dedpool.com:666,Status=Dead,Priority=3,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=4,URL=http://fauxpool.com:1101,Status=Alive,Priority=4,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\n"},
    
        "3":{"Hostname":"ZULU.3","Comment":"","Summary":"Elapsed=2234154,MHS 5s=2545.0,","Port":4030,"Group":"WYLXR83426","Alias":"","Version":"Miner=FakeMiner 0.7.0,API=1.0","Devices":"ASC=0,MHS 5s=503.0,Accepted=223415,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=1,MHS 5s=508.0,Accepted=223415,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=2,MHS 5s=501.0,Accepted=223416,Rejected=2235,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=3,MHS 5s=507.0,Accepted=223415,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,\nASC=4,MHS 5s=500.0,Accepted=223415,Rejected=2234,Hardware Errors=0,Temperature=30,Status=Alive,Last Share Pool=0,somedata,","IP":"127.0.0.1","MonProfile":0,"Access":"Miner Unavailable","Pools":"POOL=0,URL=http://fakepool.com:1234,Status=Alive,Priority=0,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=1,URL=http://pseudopool.com:8585,Status=Alive,Priority=1,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=2,URL=http://notapool.com:3333,Status=Alive,Priority=2,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=3,URL=http://dedpool.com:666,Status=Dead,Priority=3,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\nPOOL=4,URL=http://fauxpool.com:1101,Status=Alive,Priority=4,User=fakeu01,somedataLast.+Last Share Difficulty=5,Algorithm Type=Fake,Pool Rejected%=0.0,\n"},
    


  • Is it possible to add a miner status, for checking if the miner is on/off?


  • Staff

    Development on the current version of miner.farm is frozen in favor of working on the new platform. A much richer API set will be available when it is released, so you will have better detailed information. Look for it in the coming months!

    Thank you for your support,
    Lily


  • Staff

    @vladfoamete said in Miner.farm API Documentation:

    Is it possible to add a miner status, for checking if the miner is on/off?

    Meanwhile, try this: on Farm View, click "Agent Settings" and turn email notifications on for that agent. Then you can get emails when the rig is not available.

    For details: https://forum.getpimp.org/category/13/miner-farm-support


 



Want 10% more hash from your rigs?



We promise to keep your email safe and never spam you.



Copyright (c) 2012-2018 PiMP LLC. All rights Reserved.

Looks like your connection to PiMP Forum was lost, please wait while we try to reconnect.