> ## Documentation Index
> Fetch the complete documentation index at: https://help.miyaip.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MiyaIP API integration: authentication and endpoint reference

> Integrate MiyaIP APIs for login, proxy generation, account usage, and proxy assets. Choose the correct credentials and test requests in your browser.

Use the MiyaIP APIs to generate proxy connection details and read your account usage and proxy assets. This reference covers the eight endpoints in the [official developer center](https://miyaip.com/developer-center).

The base URL is `https://miyaip.com`. Parameter names are case-sensitive. Query parameters belong in the request URL; JSON body parameters belong in the request body.

## Choose an endpoint

| Group | Endpoint | Method and path | Authentication |
| - | - | - | - |
| Authentication | [Log in](/api-reference/login) | `POST /api/SysLogin/Login` | None |
| Proxy generation | [Generate dynamic proxies](/api-reference/dynamic-generate) | `GET /api/ProxyLogic/Generate` | Query credentials |
| Proxy generation | [Generate short-lived residential proxies](/api-reference/short-generate) | `POST /api/UserShort/GenerateIps` | Bearer token |
| Proxy generation | [Generate unlimited residential proxies](/api-reference/unlimited-generate) | `GET /api/ProxyLogic/UnlimitedGenerate` | Query credentials |
| Account and usage | [Get user information](/api-reference/user-info) | `GET /api/SysLogin/GetUserInfo` | Bearer token |
| Account and usage | [Read bandwidth usage](/api-reference/bandwidth-analysis) | `GET /api/ProxyLogic/BandwidthAnalysis` | Bearer token |
| Proxy assets | [List residential proxy assets](/api-reference/isp-list) | `GET /api/UserIsps/PageList` | Bearer token |
| Proxy assets | [List datacenter proxy assets](/api-reference/datacenter-list) | `GET /api/DatacenterIps/PageList` | Bearer token |

## Prepare credentials

The endpoints use three authentication modes:

* **No authentication:** Log in with your email and either a password or verification code. The login response contains an access token.
* **Bearer token:** Copy your login token, then enter it on the endpoint page. Requests send `Authorization: Bearer <token>`. Tokens are not shared automatically between pages.
* **Query credentials:** Dynamic and unlimited generation require `Crc` and `KeyName`. Obtain the relevant product credentials from your [MiyaIP dashboard](https://miyaip.com/dashboard). An access token does not replace these query credentials.

For dynamic residential proxies, use the residential product credentials. Mobile proxies use the dynamic endpoint with the mobile credentials and `mealType=mobile`. For unlimited residential proxies, use that product's credentials. Match the product before sending a request.

The user information response includes the residential and mobile keys shown in its example. It does not document an unlimited key in that example; obtain your unlimited credentials from the dashboard.

## Read responses

Dynamic and unlimited generation return successful proxy lists as `text/plain`. Preserve the selected output format when copying the connection details into your client. The other endpoints show JSON responses.

Check the HTTP status separately from a JSON business `code` and `message`. HTTP 200 alone does not prove that the business operation succeeded. The documented error example uses HTTP 400 with a JSON `code` of 500; those are different values. A timeout or browser network failure may produce no HTTP response.

Review the response examples and the cURL, JavaScript, and Python examples on each endpoint page. Replace placeholder credentials locally and keep them out of shared code and logs.

## Use online debugging

Each endpoint has a form that sends a real request directly from your browser to `https://miyaip.com` when you select **Send request**. It does not reuse your website login cookies. Short-lived proxy generation consumes your short-lived IP allowance; review the requested quantity before sending.

Credentials and responses remain in page memory. Refreshing, leaving the page, or changing language clears them. The request preview masks credentials, and sensitive responses are masked by default. You can deliberately reveal or copy the login token when needed.

The debugger has a 30-second client timeout and displays up to 200 KiB of response data. It prevents duplicate clicks while a request is pending and does not retry automatically. Canceling a request stops the browser from waiting; it does not guarantee that the server has canceled the operation. Review your account before repeating a generation request after an interruption.

## Reference limits and related guides

Form bounds marked as public-interface limits reflect the current developer center. The source does not specify token lifetime or refresh behavior, rate limits, traffic units, positive `SessionTime` units, or a complete country and gateway-line enumeration. Check the current dashboard and service response instead of assuming these details.

After obtaining connection details, use the [static proxy verification guide](/developers/static-proxy), [web scraping guide](/developers/web-scraping), or [AI agent browser guide](/developers/ai-agents). Asynchronous crawling is documented separately in the [Crawler API guide](/developers/crawler-api).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.