Welcome to Buyback.Tools API

Buyback.Tools API 1.0.0

API Endpoints for BuyBack.Tools API.

To recieve an API Key, please visit: {BUYBACK_TOOLS_API_PRODUCT_PAGE_LINK}

Once signed up, your API Key is your Stripe Subscripion ID (ex: 'subs743...')

These Docs are a work in progress and will be updated periodically. If you encounter issues, please contact us using the link below.

Contact: Support@BuyBack.Tools

Servers

Description URL
Direct API URL https://us-central1-sheetimei.cloudfunctions.net
BuyBack.Tools API URL (Coming Soon) https://api.buyback.tools

IMEI Tools

GET /check-carrier-eligibility

Description

Returns eligibility for activation by different carriers

Example URL - https://us-central1-sheetimei.cloudfunctions.net/check-carrier- eligibility?apiKey={API_KEY}&imei={IMEI}

Input parameters

Parameter In Type Default Nullable Description
apiKey query string No Your API Key
imei query string No Device IMEI

Response 200 OK 

{
    "att": {
        "blacklisted": false,
        "deviceCompat": true
    },
    "tmobile": {
        "blacklisted": "UNBLOCKED",
        "deviceCompat": "Fully Compatible"
    },
    "verizon": {
        "blacklisted": "Unknown",
        "deviceCompat": "Unknown"
    }
}
Schema of the response body 
{
    "type": "object",
    "properties": {
        "att": {
            "type": "object",
            "properties": {
                "blacklisted": {
                    "type": "string"
                },
                "deviceCompat": {
                    "type": "string"
                }
            }
        },
        "tmobile": {
            "type": "object",
            "properties": {
                "blacklisted": {
                    "type": "string"
                },
                "deviceCompat": {
                    "type": "string"
                }
            }
        },
        "verizon": {
            "type": "object",
            "properties": {
                "blacklisted": {
                    "type": "string"
                },
                "deviceCompat": {
                    "type": "string"
                }
            }
        }
    }
}

Response 500 Internal Server Error

GET /check-samsung-warranty

Description

Returns Warranty Information for Samsung Devices. Warranty Date is returned in the format of Year-Month-Day.

Input parameters

Parameter In Type Default Nullable Description
apiKey query string No Your API Key
imei query string No Device IMEI

Response 200 OK 

{
    "inWarranty": false,
    "originalCarrier": "AT&T",
    "warrantyDate": "2022-12-04"
}
Schema of the response body 
{
    "type": "object",
    "properties": {
        "inWarranty": {
            "type": "boolean"
        },
        "originalCarrier": {
            "type": "string"
        },
        "warrantyDate": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

GET /check-australia-blacklist

Description

Returns blacklist information for austrailias regoinal blacklist database

Input parameters

Parameter In Type Default Nullable Description
apiKey query string No Your API Key
imei query string No Device IMEI

Response 200 OK 

{
    "bl": "Your IMEI Number is currently unblocked."
}
Schema of the response body 
{
    "type": "object",
    "properties": {
        "bl": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

GET /check-manufacturer

Description

Returns device Manufacturer and Model

Input parameters

Parameter In Type Default Nullable Description
apiKey query string No
imei query string No
sickwKey query string No

Response 200 OK 

{
    "manufacturer": "Samsung",
    "model": "Galaxy S21 5G"
}
Schema of the response body 
{
    "type": "object",
    "properties": {
        "manufacturer": {
            "type": "string"
        },
        "model": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

GET /check-imei

Description

Run a standard SickW IMEI check

Input parameters

Parameter In Type Default Nullable Description
apiKey query string No Your BuyBack.Tools API Key
imei query string No IMEI to check
sickwKey query string No Your SickW API Key

Response 200 OK 

{
    "model": "iPhone 12",
    "storage": "64GB",
    "color": "Blue",
    "sim": "Locked",
    "network": "2408 - US Sprint/T-Mobile Locked Policy",
    "ic": true,
    "bl": "Clean",
    "appleCare": false,
    "Warranty": "Coverage Expired",
    "balance": 10.25
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "type": "object",
    "properties": {
        "model": {
            "type": "string"
        },
        "storage": {
            "type": "string"
        },
        "color": {
            "type": "string"
        },
        "sim": {
            "type": "string"
        },
        "network": {
            "type": "string"
        },
        "ic": {
            "type": "string"
        },
        "bl": {
            "type": "string"
        },
        "appleCare": {
            "type": "string"
        },
        "warranty": {
            "type": "string"
        },
        "balance": {
            "type": "number"
        }
    },
    "example": {
        "model": "iPhone 12",
        "storage": "64GB",
        "color": "Blue",
        "sim": "Locked",
        "network": "2408 - US Sprint/T-Mobile Locked Policy",
        "ic": true,
        "bl": "Clean",
        "appleCare": false,
        "Warranty": "Coverage Expired",
        "balance": 10.25
    }
}

Response 500 Internal Server Error

Pricing

GET /check-iphone-pricing

Description

Returns current pricing by Make, Model, and Carrier for Gazelle, EcoATM, and ItsWorthMore

Input parameters

Parameter In Type Default Nullable Description
apiKey query string No
carrier query string No
model query string No
size query string No

Response 200 OK

Response 500 Internal Server Error

Schemas

inline_response_200

Name Type
att Properties: blacklisted, deviceCompat
tmobile Properties: blacklisted, deviceCompat
verizon Properties: blacklisted, deviceCompat

inline_response_200_1

Name Type
inWarranty boolean
originalCarrier string
warrantyDate string

inline_response_200_2

Name Type
bl string

inline_response_200_3

Name Type
manufacturer string
model string

inline_response_200_4

Name Type
appleCare string
balance number
bl string
color string
ic string
model string
network string
sim string
storage string
warranty string