Read your machines, earnings, invoices and a summary from your own tools with a read-only key. How to create, use and revoke it.
Advanced
The Owner API lets your own tools read the figures you see in your portal: a spreadsheet, a script, a dashboard at home. It is read-only. A key can look at your data. It cannot change a setting, a payout address or an invoice.
What it gives you
Endpoint
What it returns
machines
Your machines and their current state
earnings
The bitcoin your machines have earned
invoices
Your monthly invoices and reports
summary
The headline figures of your account in one call
The exact address of each endpoint, the fields in each answer and the limits are on the Developers page. That page is the reference. This guide shows the way of working.
Create a new key and give it a name that says where it will be used, such as the name of your spreadsheet.
Copy the key at once and store it in a password manager.
Use one key per tool. If one tool is retired or leaks, you revoke that key only.
Careful: Treat a key like a password. Anyone who has it can read your machines, earnings and invoices. Never paste it into a chat, an email, a screenshot or a shared document.
A first call with curl
curl is a small program, already on Mac and Linux and on recent versions of Windows, that fetches an address from the command line. A call sends your key in a header and receives your data as text. It has this shape:
KEY_HEADER, YOUR_KEY and API_ADDRESS are placeholders. The Developers page gives the exact header and address, with an example you can copy: paste your key into it and run it. Change the last word to machines, earnings or invoices to call the other endpoints.
Google Sheets and Zapier, by polling
The API answers when asked. It does not push changes to you. To keep a tool up to date, have it ask on a schedule. This is called polling.
Google Sheets: write a short Apps Script that fetches an endpoint with your key and writes the answer into a sheet, then add a time trigger so it runs every hour or every day.
Zapier: use a scheduled trigger followed by a web request step that calls the endpoint with your key in the header. Send the result to a sheet, an email or a chat message.
Your own script: any language that can make a web request works. Run it on a schedule.
Good to know: Ask no more often than the figures change. Hashrate moves every few minutes, earnings once a day, invoices once a month. For most uses, once an hour is plenty.
Keep the key safe
Store it in the tool's secret or credential field, not in a cell or in the code itself.
Do not share a sheet or a zap that shows the key.
Give your accountant a file or their own key, not yours.
Check the list on API keys now and then, and remove keys you no longer use.