[Feature Request] Folding@home widget

[mgrimace]

Description

Folding@Home, aka FAH, aka Folding at Home allows users to donate idle computing power to help fight diseases like cancer, COVID, Alzheimer's, etc. (website)
The service has a webui (screenshot below), and api (documentation) that allows stats to be pulled:

Other

No response

[shamoon]

I like this one just cause it's a cool project. I think you can probably do it with customapi tho?

[mgrimace]

It should be pretty straightforward with customapi
it looks like curl -G https://api.foldingathome.org/uid/:id/totalsreturns the 'work units' and 'score' for a specific userID. There's other stats than can be grabbed for a user based on ID or a team as well.

So it should just be a matter of using https://api.foldingathome.org/uid/:id/totals as the endpoint, and doing the mappings. My only challenge is finding a userID. I think you can grab from the name using something like curl -G https://api.foldingathome.org/user/:name, but my name doesn't seem to have anything associated with it yet, perhaps until I complete a work unit... investigating.

I just set this up today so it's all new to me. I'll post my findings!

[mgrimace]

Ok, using customapi you can pull team stats or individual user stats. Other fields and API information can be found here

Team stats

    - Folding at Home:
        icon: foldingathome.png
        href: http://[IP, NAME, or SECRET]:7396 #add your address here
        widget:
            type: customapi
            url: https://api.foldingathome.org/team/[your team id] #add your teamID here
            refreshInterval: 43200000 #set for every 12 hours, for daily scores to not overuse their api 
            method: GET
            mappings:
              - field: name 
                label: Name
                format: text
              - field: wus
                label: work units
                format: number
                scale: 0.0000001 #adjust the scale as necessary
                suffix: mil #adjust the suffix as necessary
              - field: rank
                label: Rank
                format: number
              - field: score
                label: score
                format: number
                scale: 0.0000000001 #adjust the scale as necessary
                suffix: bil #adjust the suffix as necessary

User stats

    - Folding at Home:
        icon: foldingathome.png
        href: http://[IP, NAME, or SECRET]:7396 #add your address here
        widget:
            type: customapi
            url: https://api.foldingathome.org/user/[Your Name] #add your user name here
            refreshInterval: 43200000 #set for every 12 hours, for daily scores to not overuse their api
            method: GET
            mappings:
              - field: name 
                label: Name
                format: text
              - field: wus
                label: work units
                format: number
              - field: rank
                label: Rank
                format: number
              - field: score
                label: score
                format: number

Note, I'm using Banano as the test user/team here. Individual user stats are delayed for new accounts, so if you've created a new account it may not show your individual stats right away. It's not clear for how long.

Updates

• I changed the refresh interval to twice daily, feel free to change to more frequent though with these stats it's probably uncessary. There's also some potential caution on over-using the API and account banning.
• rank is probably not a useful field for an individual new user (e.g., I'm 'unranked' resulting in NaN in the box), just comment that out if you're new and not getting anything here.

[github-actions[bot]]

This discussion has been automatically closed because it was marked as answered.

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.