Skip to main content
Public API v2 uses https://api.nonce.app/public-api/v2. Workspace resources include a workspace_id in the path, and farm resources also include a farm_id. These IDs come from API responses and are distinct from display names and slugs.

​
Request parameters

Simple lists use query parameters. Structured searches use POST with a JSON body and Content-Type: application/json; POST does not always mean a write operation. For example, Search Miners can read online miners with:
Supported filters and defaults vary by endpoint and are defined in each endpoint’s Reference.

​
Successful responses

Responses contain success, data, and error. On success, success is true and error is null; data is an object or array as defined by the endpoint. Paginated lists also include pagination. An empty list is still a successful response:
For paginated lists and searches, page defaults to 1 and page_size to 20, with a maximum page size of 10,000. Read subsequent pages while page < total_pages. Not every endpoint paginates: ListWorkspaces returns an unpaginated array, and historical metric queries use time windows.

​
Errors

API errors use success: false, data: null, and an error object with code and message. For example, a missing or inaccessible farm can produce:
Validation errors may include error.details.field_errors, which identifies invalid fields. When error.traceId is present, include it with the endpoint and request time when contacting support. Credentials must be excluded from reports. A 400 response requires a corrected request. Other access errors are covered in Authentication and access. Retry guidance is in Rate limits and retries.

​
Time, units, and missing values

Timestamp fields use ISO 8601 as specified by each endpoint. Hashrate is expressed in H/s, power in W, and mining efficiency in J/TH unless the field definition states otherwise. A null metric indicates missing data and must not be interpreted as zero.