MobileUnlockStar API: Official Documentation (v1.0)

Welcome to the official MobileUnlockStar API documentation. Our service provides developers, service centers, and businesses with instant access to detailed information about Apple devices in real time.

Through a single gateway, you can integrate Find My status checks, MDM profile detection, carrier locks (SIM Lock), and retrieve the most comprehensive reports from the GSX database directly into your project.

1. Authentication

All requests to the API are private and require authentication using your unique API key. Funds are deducted from your balance only upon successful request execution (Failed requests are not charged).

⚙️ PASSING THE KEY IN HEADERS: X-API-Key: YOUR_UNIQUE_API_KEY Content-Type: application/json

Important: Never publish your API key publicly (e.g., in GitHub repositories) and do not use it on the client side (in browser JavaScript code).

2. Base Settings and Rate Limits

Base URL: https://www.mobileunlockstar.com/api/v1
Response Format: All server responses are returned exclusively in JSON format.
Rate Limits:
- Maximum 60 requests per minute from a single IP address.
- Maximum 1000 requests per day for a single API key.

3. Check Device

The main endpoint for retrieving device information by its IMEI or Serial Number.

HTTP Method: POST /check

Request Body Parameters (JSON):

Parameter	Type	Required	Description
`command`	string	Yes	The code of the service you want to execute.
`identifier`	string	Yes	IMEI (15 digits) or Serial Number.

Available Commands (`command` parameter):

Command Code	Service Name	Description
`findmy`	Find My + Warranty	Check iCloud status (ON/OFF) and warranty info.
`lost`	Lost Status	Check if the device is reported as lost (Clean / Lost).
`mdm`	MDM Status Check	Check if the device is bound to a corporate management profile.
`simlock`	SIM Lock Status	Check network carrier lock status (Locked / Unlocked).
`gsx`	GSX Standard	Basic report from Apple's database (model, warranty, country).
`gsxfast`	GSX Fast Report	Fast detailed report (includes activation and carrier data).
`gsxpremium`	GSX Premium Report	The most complete report. Includes repair history (Repair Data) and all statuses.
`sntoimei`	SN to IMEI	Convert a Serial Number into IMEI / IMEI2.

Request Example (cURL):

curl -X POST https://www.mobileunlockstar.com/api/v1/check \
  -H "X-API-Key: YOUR_UNIQUE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "command": "gsxpremium",
    "identifier": "356557847079356"
  }'

Successful Response Examples (200 OK):

Every successful response always returns your remaining balance (credits) and detailed information based on the requested command.

Example 1: Full GSX Premium Report (iPhone 13)

response_iphone.json

{
  "command": "gsxpremium",
  "cost": 0.8000,
  "balance": 360.8000,
  "gateway_ms": 5531,
  "device": {
    "SerialNo": "C66P74Y9VQ",
    "configDescription": "IPHONE 13,ROW,128GB,GREEN",
    "imei": "356557847079356",
    "productDescription": "iPhone 13",
    "purchase": "2022-07-17T00:00:00Z",
    "purchaseCountry": "India",
    "warrantyStatus": "Out Of Warranty (No Coverage)",
    "warrantyremaining": 0
  },
  "gsx_response": {
    "device": {
      "activationDetails": {
        "appliedActivationDetails": "Unlock.",
        "appliedActivationPolicyID": "10",
        "carrierName": "Vodafone UA",
        "csncsn2eId": "89049032007008882600098562271350",
        "firstActivationDate": "2022-07-17T16:39:25Z",
        "initialActivationPolicyDetails": "Unlock.",
        "initialActivationPolicyID": "10",
        "lastRestoreDate": "2025-11-30T13:27:30Z",
        "lastUnbrickOsBuild": "23B85",
        "macAddress": "0499BB7183E8",
        "nextTetherPolicyDetails": "Unlock.",
        "nextTetherPolicyID": "10",
        "productDescription": "IPHONE 13 GREEN 128GB-HIN",
        "productVersion": "26.1",
        "unlockDate": "2022-08-22T12:14:38Z",
        "unlocked": true
      },
      "caseDetails": [
        {
          "caseId": "102714870157",
          "createdDateTime": "2025-10-05T22:55:21.865Z",
          "summary": "Consumer Activation Lock"
        },
        {
          "caseId": "102645835329",
          "createdDateTime": "2025-07-18T15:18:37.167Z",
          "summary": "Застосування клієнтом функції «Замок активації»"
        }
      ],
      "configCode": "000WLJ",
      "configDescription": "IPHONE 13,ROW,128GB,GREEN",
      "depEnrolled": false,
      "identifiers": {
        "imei": "356557847079356",
        "imei2": "356557847146189",
        "meid": "35655784707935",
        "serial": "C66P74Y9VQ"
      },
      "loaner": false,
      "productDescription": "iPhone 13",
      "productImageURL": "https://cdsassets.apple.com/content/services/pub/image?configcode=000WLJ\u0026size=72x72\u0026accessKey=1772107959_2873733095041576280_mEfwIlRXTUH5zqubnX0M68PseC7GTk%2BUnP611JhVBwnsB0hu175S5hCqjYCIFn8dCw7AdnsmN0PTgSZLTzQJ8w%3D%3D",
      "productLine": "300428",
      "soldToName": "FLIPKART INDIA PVT LTD",
      "warrantyInfo": {
        "daysRemaining": 0,
        "deviceCoverageDetails": [
          "Final Repair coverage is determined at the part level.",
          "This unit is eligible for additional part coverage, check at the part level for coverage.",
          "GSX indicates that this product is out-of-warranty. If you or the customer believes the product is within its warranty period or covered by an AppleCare Extended Service Agreement, upload a proof of purchase."
        ],
        "laborCovered": false,
        "limitedWarranty": false,
        "onsiteCoverage": false,
        "partCovered": false,
        "personalized": false,
        "purchaseCountryCode": "IND",
        "purchaseCountryDesc": "India",
        "purchaseDate": "2022-07-17T00:00:00Z",
        "registrationDate": "2022-07-17T00:00:00Z",
        "warrantyStatusCode": "OO",
        "warrantyStatusDescription": "Out Of Warranty (No Coverage)"
      }
    }
  },
  "fmiStatus": "true",
  "lostStatus": "false",
  "depStatus": "N/A",
  "eligibility": {
    "eligibilityDetails": {
      "coverageCode": "OO",
      "coverageDescription": "Out Of Warranty (No Coverage)",
      "outcome": [
        {
          "action": "WARNING",
          "reasons": [
            {
              "messages": [
                "Find My for this device is active. Find My must be turned off for non-accessory repairs. See OP987 for details."
              ],
              "type": "WARNING"
            }
          ]
        },
        {
          "reasons": [
            {
              "messages": [
                "MRI or Serial Number Reader diagnostics are required to proceed with a repair."
              ],
              "repairOptions": [
                {
                  "option": "SVNR",
                  "priority": 1,
                  "subOption": "NTF"
                },
                {
                  "option": "SVNR",
                  "priority": 2,
                  "subOption": "SRC"
                }
              ],
              "type": "REPAIR_TYPE"
            }
          ]
        }
      ],
      "technicianMandatory": false
    }
  },
  "accInfo": {
    "depStatus": false,
    "eid": "89049032007008882600098562271350",
    "findMyLocked": true,
    "findMyLost": false,
    "imeiNumber": "356557847079356",
    "imeiNumber2": "356557847146189",
    "initialUnbrick": "2022-07-17",
    "materialNumber": "MNGK3HN/A"
  },
  "mdmStatus": "OFF",
  "success": true
}

Example 2: GSX Standard Report (MacBook Air M2)

response_macbook.json

{
  "command": "gsx",
  "cost": 0.4,
  "balance": 362,
  "gateway_ms": 5115,
  "device": {
    "SerialNo": "GCQGP6F3DW",
    "configDescription": "MBA 13.6 MIDNGT,8C CPU,8C GPU8GB,256GB",
    "imei": null,
    "productDescription": "MacBook Air (M2, 2022)",
    "purchase": "2023-08-05T00:00:00Z",
    "purchaseCountry": "India",
    "warrantyStatus": "Out Of Warranty (No Coverage)",
    "warrantyremaining": 0
  },
  "gsx_response": {
    "device": {
      "activationDetails": {
        "unlocked": false
      },
      "configCode": "0006H4",
      "configDescription": "MBA 13.6 MIDNGT,8C CPU,8C GPU8GB,256GB",
      "ctoConfiguration": "NO FINAL CUT PRO PREINSTALLED
MAC OS,J413
NO PRO APPS PREINSTALLED
LIQUID RETINA DISPLAY WITH TRUE TONE
8C CPU/8C GPU/8GB/256GB
PLACEHOLDER 1
APPLE M2 CHIP WITH 8C CPU, 8C GPU
30W USB-C POWER ADAPTER
TWO THUNDERBOLT / USB 4 PORTS
PLACEHOLDER 2
FORCE TOUCH TRACKPAD
TOUCH ID
8GB UNIFIED MEMORY
NO LOGIC PRO PREINSTALLED
PLACEHOLDER 3
256GB SSD STORAGE
MACBOOK AIR 13.6-INCH MIDNIGHT
KEYBOARD,M,J413
PKG,THICK M,B900/B905,J413 (HIN)
MAC OS LOC MAPPING-HIN
B900,30W,J413-HIN
COUNTRY KIT,M,J413-HIN",
      "depEnrolled": false,
      "identifiers": {
        "serial": "GCQGP6F3DW"
      },
      "loaner": false,
      "productDescription": "MacBook Air (M2, 2022)",
      "productImageURL": "https://cdsassets.apple.com/content/services/pub/image?configcode=0006H4&size=72x72&accessKey=1772105117_5987040991153924682_r%2FS5TKk31fj29Qh7SflVyWFXpi96307YNoqlEba6dEH9dvAydvZ2H%2BtDAga%2FKr2IyofbELzbZQ4Junz8Qd1DAA%3D%3D",
      "productLine": "300872",
      "soldToName": "INGRAM MICRO INDIA LTD.",
      "warrantyInfo": {
        "daysRemaining": 0,
        "deviceCoverageDetails": [
          "Final Repair coverage is determined at the part level.",
          "GSX indicates that this product is out-of-warranty. If you or the customer believes the product is within its warranty period or covered by an AppleCare Extended Service Agreement, upload a proof of purchase."
        ],
        "laborCovered": false,
        "limitedWarranty": false,
        "onsiteCoverage": false,
        "partCovered": false,
        "personalized": false,
        "purchaseCountryCode": "IND",
        "purchaseCountryDesc": "India",
        "purchaseDate": "2023-08-05T00:00:00Z",
        "registrationDate": "2023-08-05T00:00:00Z",
        "warrantyStatusCode": "OO",
        "warrantyStatusDescription": "Out Of Warranty (No Coverage)"
      }
    }
  },
  "success": true
}

4. Check Balance and Prices

This method allows you to dynamically check your current balance, your assigned pricing plan name, and the active prices for all available services.

HTTP Method: GET /balance

curl -H "X-API-Key: YOUR_UNIQUE_API_KEY" \
  https://www.mobileunlockstar.com/api/v1/balance

{
  "success": true,
  "username": "MyProject_Bot",
  "balance": 125.40,
  "plan": "VIP",
  "prices": {
    "findmy": 0.40,
    "lost": 0.35,
    "simlock": 0.50,
    "mdm": 0.60,
    "gsx": 1.20,
    "gsxfast": 1.50,
    "gsxpremium": 2.50,
    "sntoimei": 0.40
  }
}

5. Error Handling

If a request fails, the API returns a JSON response with the "success": false field and a description of the problem (message). In the event of supplier-side errors or timeouts, funds are automatically refunded to your balance.

HTTP Code	Status	Description
200	`OK`	Request executed successfully. The response is in the JSON body.
400	`Bad Request`	Missing required parameters or invalid IMEI format.
401	`Unauthorized`	API key is missing or invalid.
402	`Payment Required`	Insufficient funds on the balance to execute this command.
403	`Forbidden`	Account is blocked or IP address access is denied.
404	`Not Found`	The specified command was not found or is deactivated in your plan.
504	`Gateway Timeout`	Apple database timeout. Funds are automatically refunded.

Error Response Example (402):

{
  "success": false,
  "message": "Insufficient funds",
  "required": 1.50,
  "request_id": "req_mus_f6g7h8i9j0"
}

Technical Glossary

A glossary of terms for quick integration with our platform.

API (Application Programming Interface)

A software interface that allows your website, CRM, or Telegram bot to "communicate" with our servers to fetch data.

GSX (Global Service Exchange)

A closed, official database used by Apple Corporation containing the absolute full history of any device, from purchase date to hardware repairs.

JSON (JavaScript Object Notation)

A standard text format for data exchange. It is the format you use to send requests and the format in which you receive responses. Easily readable by both humans and machines.

Rate Limit

A restriction on the number of requests allowed (e.g., 60 per minute), designed to protect the server from DDoS attacks and spam.

Endpoint

An access point (URL address) to a specific API function. In our case, it is /check for device verification and /balance for account finances.

Ready to Integrate?

Contact the administrator to receive your unique API key and configure your pricing plan.

Contact Support