Welcome to our Help Center.


Our Help Center is designed to give you a place to get the information you need to be effective at using our site.

You can find information by browsing the sections and categories on the left hand dropdown menu (top if you have a very small screen)

We appreciate any feedback regarding the design of the help center, or new bits of information to add, including tutorials; You can open a ticket with us at any time.

 

Do you offer an API?

Yes. Mining Rig Rentals offers an API for users who want to build tools, integrations, monitoring systems, rental automation, pricing tools, or account-management workflows.

Our current API documentation is available in the API v2 documentation.

API v2 is the supported API version. API v1 is deprecated and should not be used for new integrations.


What can the API be used for?

The API can be used for many Mining Rig Rentals workflows, including public data lookups and account-specific actions.

Common uses include:

  • viewing public rig market data,
  • checking algorithm information,
  • managing rigs,
  • reviewing rentals,
  • applying pool profiles,
  • building monitoring tools,
  • building pricing or availability tools,
  • automating parts of a rental or rig-management workflow.

Some API endpoints are public. Others require authentication and account permissions.


API documentation

Use the API v2 documentation when building new integrations.

API v2 uses authenticated requests for private account actions. Private requests require an API key, API secret, nonce, and request signature. Review the API documentation carefully before building against authenticated endpoints.

Do not rely on old API v1 examples unless you are maintaining legacy code. API v1 is deprecated, and API v1 calls are not compatible with API v2.


Public and private endpoints

The API includes both public and private endpoints.

Public endpoints provide public Mining Rig Rentals data. These may be useful for market tools, statistics, availability checks, and public rig information.

Private endpoints require authentication and may allow access to account-specific information or actions.

Private API keys should be treated like account credentials. Do not share API keys publicly, commit them to source control, or place them in client-side browser code.


API rate limits

Mining Rig Rentals applies API rate limits to protect platform stability and prevent abuse.

The standard limit is currently 100 requests per minute per IP address. Do not attempt to evade this limit by rotating IP addresses, distributing abusive traffic, or bypassing normal request controls.

Design your integration to use the API responsibly:

  • cache data where reasonable,
  • avoid unnecessary polling,
  • use longer polling intervals when real-time data is not required,
  • retry failed requests carefully,
  • use backoff when receiving errors,
  • avoid bursty request patterns,
  • request only the data your application needs.

Excessive or abusive API usage may be restricted.


Can I request a higher API limit?

Higher limits may be considered on a case-by-case basis.

Approval depends on factors such as:

  • the type of API calls being made,
  • expected request volume,
  • project purpose,
  • account activity,
  • rental volume,
  • whether the integration benefits Mining Rig Rentals users,
  • whether the traffic pattern is reasonable,
  • whether the integration can cache or reduce requests.

If you need a higher limit, open a support ticket and explain your use case.

Include:

  • what you are building,
  • which endpoints you need,
  • expected requests per minute,
  • whether traffic is constant or bursty,
  • whether the project is public or private,
  • how many users or systems will use it,
  • what caching or rate control you have implemented.

Mining Rig Rentals does not currently offer a self-service paid API quota purchase system.


Terms of use

Access to API data is subject to the Mining Rig Rentals Terms of Service and Privacy Policy.

Public API data may be used for legitimate integrations, tools, analysis, and user-facing services, but it may not be used in ways that abuse the service, misrepresent Mining Rig Rentals, violate user privacy, overload the platform, or violate our Terms of Service.

Mining Rig Rentals may limit or disable API access if usage is abusive, harmful, excessive, or inconsistent with our policies.


Third-party API projects

Some community projects and wrappers exist for the Mining Rig Rentals API.

Known public projects include:

These projects are not guaranteed to be maintained, complete, secure, or compatible with current API behavior. Review third-party code before using it, and refer to the official API documentation as the source of truth.


API security best practices

When using the API:

  • keep API keys private,
  • use the minimum permissions required,
  • rotate keys if they may have been exposed,
  • do not hard-code keys in public repositories,
  • do not expose private API calls directly from frontend code,
  • log API errors without logging secrets,
  • use server-side code for authenticated requests,
  • monitor your integration for unexpected request volume.

If you believe an API key has been exposed, revoke or replace it immediately.


When to contact support

Contact support if:

  • you need help understanding API behavior,
  • you believe an API response is incorrect,
  • you are seeing authentication failures,
  • your integration is being rate-limited,
  • you need higher API limits,
  • you are building a public integration,
  • you are unsure whether your API use case is allowed.

When contacting support, include:

  • your account name,
  • endpoint or endpoints used,
  • approximate request volume,
  • example request path,
  • example response or error message,
  • timestamp of the issue,
  • whether the issue affects public or private endpoints.

Do not send your API secret in a support ticket.


Summary

Yes, Mining Rig Rentals offers an API.

Use API v2 for new integrations, respect rate limits, keep API keys secure, and contact support if your project requires higher request volume or has special requirements.