Integration guide Source 9e38b931

Use the public APILink to this section

TL;DRLink to this section

Public GET routes need no API key, wallet connection or private SDK.
Check the response version, availability and source before using its values.
This API snapshot supports Mining4 integration, not Mining5.

Before you startLink to this section

Obtain the API base URL for your approved environment from its deployment configuration. This source reference does not designate a current public service endpoint.

The examples use curl; set API_BASE_URL to that endpoint. Do not send device, indexer or administrator credentials to public routes.

StepsLink to this section

Read the configured public installation's telemetry:

: "${API_BASE_URL:?Set API_BASE_URL to the approved API endpoint}"
curl --include --fail-with-body --silent --show-error \
  "$API_BASE_URL/v1/public/telemetry"

A complete illustrative HTTP 200 response, for a fictitious installation with no received measurement, is:

{
  "schemaVersion": 1,
  "installationId": "example-installation",
  "revision": null,
  "status": "offline",
  "observedAt": null,
  "receivedAt": null,
  "softwareVersion": null,
  "measurement": null
}

Inspect the body, not just HTTP status. Here offline and measurement: null mean no measurement is available; they do not report zero work. Use the telemetry response contract and preserve timestamps and provenance when a measurement is present.
Choose your next public API resource. Keep large decimal-string counters and amounts as strings or BigInt, and handle that resource's unavailable variant before displaying values.
For an owner portfolio, request a bounded page and retain the owner while following nextCursor:
```
curl --get --fail-with-body --silent --show-error \
  "$API_BASE_URL/v2/public/squeeks/portfolio" \
  --data-urlencode "owner=${OWNER:?Set OWNER to the intended lowercase address}" \
  --data-urlencode "limit=25"
```
On later requests, add --data-urlencode "cursor=$NEXT_CURSOR" with the returned non-null cursor. Stop when it is null; never decode it or reuse it with another owner. See portfolio parameters and responses.
Keep settlement history's response headers alongside its body:
```
curl --include --fail-with-body --silent --show-error \
  "$API_BASE_URL/v4/public/settlements?range=now&queue=1"
```
Preserve X-Squeek-Settlement-Source, any fallback reason, generatedAt and the last safe block. The settlement reference distinguishes cached history, pending queue work and confirmed issuance.
For NFT display, request token metadata with the intended release when you need its card image URL. The metadata response is not immutable; follow its cache headers, and use metadata verification for independent onchain checks.

Expected resultLink to this section

Your application distinguishes available values, stale measurements, unavailable data and HTTP failures. It retains source identity and age instead of silently substituting another deployment or displaying unavailable rewards as zero.

Common failuresLink to this section

HTTP 400: correct the request before retrying; HTTP 403: use an approved browser origin.
HTTP 503: preserve the error state, respect Retry-After and bound retries.
Invalid JSON, schema mismatches and timeouts: report an error, not empty data.

See HTTP errors and conditional responses for exact codes, response bodies and retry-header guarantees. Availability reasons and caching belong to each endpoint's reference.

Verify the resultLink to this section

Check the response against the endpoint's linked JSON Schema and its semantic rules. Do not use a telemetry or process projection as evidence of settlement.

For chain-backed views, check the intended chain, release, contract identities and confirmation-safe block. API display data does not authorize a transaction: read current chain state and simulate before signing.

SourceLink to this section

System/API source snapshot 9e38b931. The example is illustrative, not a live service read; first-party source is private; see source and release scope.

Records verified work and tracks settled rounds and Squeek blocks on Ethereum. Calculates rewards from settled work, holds funded SQK, and pays eligible NFT owners. The Miner ERC-721 contract. Tracks NFT ownership and coordinates minting and merges with Mining. Applies Core or Mining upgrades authorized by its governing Timelock. Generates Miner NFT artwork from fixed onchain visual data. Queues governance operations and enforces a delay before they can be executed. The SQK ERC-20 contract. Enforces the lifetime supply cap; only Mining can mint SQK. Checks that visual data conforms to the required DotGrid format. When new mining power starts earning. Minting and merging schedule it for a later round, and a checkpoint must process the change. A reward update that processes settled work and scheduled mining-power changes. It can make rewards available but doesn't pay them to an owner's wallet. The Miner NFT permanently burned in a merge. Its unclaimed rewards move to the survivor, but its image is not combined or kept. SQK issued under the mining reward rules. You can direct a share of your Miner's rewards to fund SqueekFi projects. The physical mining device that records accepted wheel-magnet passages as work. It is separate from the virtual Miner NFTs. Squeekchain's record of accepted wheel-magnet passages. It doesn't prove animal identity and isn't how Ethereum reaches consensus. Combining two eligible same-level Miners you own into one higher-level Miner. One NFT is permanently burned; the survivor keeps both Miners' unclaimed rewards. The completed Squeek blocks a Miner must wait through before merging. It measures completed work, not elapsed time or Ethereum blocks; transfers don't reset it. The power used to calculate a Miner's share of rewards when eligible and active. A larger share of total power can mean a larger share of rewards. A ten-minute period used to group measured work. The device saves a completed round's work total when measurement remained uninterrupted. The transferable token used for mining rewards. It has a lifetime supply cap and is separate from the Miner NFT and the device's work count. A completed amount of settled work. Enough recorded work completes one Squeek block; it is not an Ethereum block. Squeek Miner NFTs earn SQK linked to recorded wheel activity. Owners can direct a share of those rewards to fund SqueekFi projects. Squeekchain's ecosystem for hamster-powered onchain finance. Miner owners can choose to fund projects with a share of their SQK rewards. The Miner NFT you keep in a merge. It gains a level, keeps its ID and image, and receives both Miners' unclaimed rewards. A Miner's recorded reward balance that hasn't been paid to a wallet. It stays with the NFT when ownership changes. One wheel-magnet passage that met the device's counting rules and was saved. It records work, not an amount of SQK.