API Documentation

This documentation provides a detailed overview of the main API endpoints for managing Spotify keys, including checking status, renewing, upgrading, and more.

INFO API CALL

URL: /API/?info=<key>

Method: GET

Query Parameter:

• info: A unique key to query its status in the system.

Responses

1. Key Not Provided or Invalid

If the info parameter is empty or not found in the database.

{
    "status": "not_exist",
    "message": "This key was not found in our database"
}

2. Successful or Failed Upgrade/Renewal Status

If the key has a status of failed_upgrade or success_renew.

{
    "status": "failed_upgrade" | "success_renew",
    "message": "<Status message>",
    "used": 0,
    "purchase_date": "<Timestamp of purchase>",
    "used_date": "<Timestamp of last used>"
}

3. Invite Details Available

If the key status is active with an available invite token.

{
    "status": "<Key status>",
    "message": "<Status message>",
    "invite": "<Invite Token>",
    "address": "<Invite Address>",
    "used": 1,
    "purchase_date": "<Timestamp of purchase>",
    "used_date": "<Timestamp of last used>"
}

4. General Status with Message

If a status message is provided.

{
    "status": "<Key status>",
    "message": "<Status message>",
    "used": "<Used status>",
    "purchase_date": "<Timestamp of purchase>",
    "used_date": "<Timestamp of last used>"
}

5. General Status without Message

If no specific message is provided, but additional information like username and verification address is available.

{
    "status": "<Key status>",
    "message": "",
    "username": "<Username>",
    "verify_address": "<Verification Address>",
    "used": "<Used status>",
    "purchase_date": "<Timestamp of purchase>",
    "used_date": "<Timestamp of last used>"
}

 

RENEW API CALL

URL: /API/?renew=<key>&login=<login>&pwd=<password>&country=<country>

Method: GET

Query Parameters:

• renew: The key to renew.
• login: The login for the Spotify account.
• pwd: The password for the Spotify account.
• newemail: The email address for the new account.
• country: The country for the new account, e.g United States would be "US".

Responses

{
    "status": "not_exist",
    "message": "This key was not found in our database"
}

{
    "status": "error",
    "message": "The password must be at least 10 characters long and include at least one number or special character (e.g., # ? ! &)"
}

{
    "status": "error",
    "message": "This key is usable, you can proceed with the upgrade"
}

{
    "status": "error",
    "message": "This key was last used with the old system, to proceed with the renew try to join again the family, you can retrieve invite and address in the info page. In case family is full or invite is expired, contact support by sending Key, Order ID and Downgrade screenshots"
}

{
    "status": "error",
    "message": "You are processing already an upgrade task, wait until the end, you can check the current status via the key info"
}

{
    "status": "error",
    "message": "You are processing already a renew task, wait until the end, you can check the current status via the key info"
}

{
    "status": "success",
    "message": "Renew request sent successfully, your account will be renewed in a few minutes you can check the status via the key info"
}

{
    "status": "error",
    "message": "This key is usable, you can proceed with the upgrade"
}

{
    "status": "error",
    "message": "This key was not found in our database"
}

 

UPGRADE API CALL

URL: /API/?upgrade=<key>&login=<login>&pwd=<password>&country=<country>

Method: GET

Query Parameters:

• upgrade: The key to upgrade.
• login: The login for the Spotify account.
• pwd: The password for the Spotify account.
• country: The country code for the Spotify account.

Responses

{
    "status": "not_exist",
    "message": "This key was not found in our database"
}

{
    "status": "error",
    "message": "This key is not usable, your account is still premium, if not, renew it"
}

{
    "status": "success",
    "message": "Upgrade request sent successfully, your account will be Premium in a few minutes, you can check the status via the key info"
}

{
    "status": "error",
    "message": "This key was not found in our database"
}

 

STOCK API CALL

URL: /API/?stock

Method: GET

The response is a JSON array where each object in the array represents a country with its available slots for upgrades.

Example Response

[
    {"country": "CountryName1", "country_code": "CC", "slots": 10},
    {"country": "CountryName2", "country_code": "CC", "slots": 25},
    {"country": "CountryName3", "country_code": "CC", "slots": 5}
]

Response Elements Explained

• country: The name of the country.
• country_code: The ISO 3166-1 alpha-2 code for the country.
• slots: The number of available slots for Spotify upgrades in that country.

POSSIBLE STATUS AND MESSAGES

Statuses

• failed_upgrade
• success_renew
• in_queue
• success
• failed
• not_exist

Messages

• System error, try again and if the problem persists contact support
• Account details provided are invalid
• Account has been temporarily locked by Spotify, please try again in a few hours. If the issue persists, consider using a different account
• There are currently no more upgrades available in stock for the desired location, try a different country
• The account provided is already premium
• Your account was upgraded less than 12 months ago, you need to use another one
• Family plan is expired
• Family plan is full
• Family plan is invalid
• Error with family plan, likely already registered to it
• Wrong address
• Key Renewed
• The account provided is still premium