All calls must be made by using the link
https://api.alphacoders.com/3.0
, arguments have to be passed as GET params.
The response contains a JSON object, which will always contain a top-level boolean property
success
, in case of failure the error property will contain a short error code.
{ "success": true, "result": "the info you want" }
{ "success": false, "error": "en error occurred" }The selection of the method is done via the parameter called
method
and is required on all calls.
Existing arguments and errors are defined in the documentation for the relevant method.
You can test our API without a key! The five URLs below will work without a key:
Only those five exact urls/set of parameters will work without the use of an API key. If you're wondering whether you can consume our api, the above five URLs are examples of the types of pages you'll be grabbing.
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | newest | Name of method |
type | yes | desktop | phone | Type of wallpapers to grab |
min_ratio | no | float (requires max_ratio) | (phone wallpapers only) |
max_ratio | no | float (requires min_ratio) | (phone wallpapers only) |
width | no | int (requires height) | Get only wallpapers with a certain width |
height | no | int (requires width) | Get only wallpapers with a certain height |
operator | no | max | equal | min | The type of resolution filter, <= will be used with 'max', = with 'equal' and >= with 'min'. |
page | no | int [1 .. 200] | Page number |
{ "success":true, "wallpapers":[{"id":int,"width":int,"height":int,...},{"id":int,"width":int,"height":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the wallpaper. |
width | int | Width of the wallpaper. |
height | int | Height of the wallpaper. |
file_type | string | Format of the wallpaper. |
file_size | int | Size of the wallpaper in (octets). |
url_image | string | URL to the wallpaper. |
url_thumb | string | URL to the wallpaper's thumbnail. |
url_page | string | URL to the wallpaper's page on Alpha Coders. |
category | string | Name of the category. |
category_id | int | ID of the category. |
sub_category | string | Name of the sub-category. |
sub_category_id | int | ID of ths sub-category. |
user_name | string | Submitter of the wallpaper. |
user_id | int | Submitter ID of the wallpaper. |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&type=phone&method=newest"); $results = json_decode($api_result); foreach($results->wallpapers as $wallpaper) { echo "Have wallpaper id: " . $wallpaper->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | highest_rated | Name of method |
type | yes | desktop | phone | Type of wallpapers to grab |
min_ratio | no | float (requires max_ratio) | (phone wallpapers only) |
max_ratio | no | float (requires min_ratio) | (phone wallpapers only) |
width | no | int (requires height) | Get only wallpapers with a certain width |
height | no | int (requires width) | Get only wallpapers with a certain height |
operator | no | max | equal | min | The type of resolution filter, <= will be used with 'max', = with 'equal' and >= with 'min'. |
page | no | int [1 .. 200] | Page number |
{ "success":true, "wallpapers":[{"id":int,"width":int,"height":int,...},{"id":int,"width":int,"height":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the wallpaper. |
width | int | Width of the wallpaper. |
height | int | Height of the wallpaper. |
file_type | string | Format of the wallpaper. |
file_size | int | Size of the wallpaper in (octets). |
url_image | string | URL to the wallpaper. |
url_thumb | string | URL to the wallpaper's thumbnail. |
url_page | string | URL to the wallpaper's page on Alpha Coders. |
category | string | Name of the category. |
category_id | int | ID of the category. |
sub_category | string | Name of the sub-category. |
sub_category_id | int | ID of ths sub-category. |
user_name | string | Submitter of the wallpaper. |
user_id | int | Submitter ID of the wallpaper. |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&type=desktop&method=highest_rated"); $results = json_decode($api_result); foreach($results->wallpapers as $wallpaper) { echo "Have wallpaper id: " . $wallpaper->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | category | Name of method |
type | yes | desktop | phone | Type of wallpapers to grab |
id | yes | int | ID of the category |
sort | no | newest | rating | How the wallpapers are sorted |
min_ratio | no | float (requires max_ratio) | (phone wallpapers only) |
max_ratio | no | float (requires min_ratio) | (phone wallpapers only) |
width | no | int (requires height) | Get only wallpapers with a certain width |
height | no | int (requires width) | Get only wallpapers with a certain height |
operator | no | max | equal | min | The type of resolution filter, <= will be used with 'max', = with 'equal' and >= with 'min'. |
page | no | int [1 .. 200] | Page number |
{ "success":true, "wallpapers":[{"id":int,"width":int,"height":int,...},{"id":int,"width":int,"height":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the wallpaper. |
width | int | Width of the wallpaper. |
height | int | Height of the wallpaper. |
file_type | string | Format of the wallpaper. |
file_size | int | Size of the wallpaper in (octets). |
url_image | string | URL to the wallpaper. |
url_thumb | string | URL to the wallpaper's thumbnail. |
url_page | string | URL to the wallpaper's page on Mobile Abyss. |
category | string | Name of the category. |
category_id | int | ID of the category. |
sub_category | string | Name of the sub-category. |
sub_category_id | int | ID of ths sub-category. |
user_name | string | Submitter of the wallpaper. |
user_id | int | Submitter ID of the wallpaper. |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=category&type=phone&id=3"); $results = json_decode($api_result); foreach($results->wallpapers as $wallpaper) { echo "Have wallpaper id: " . $wallpaper->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | category_list | Name of method |
{ "success":true, "categories":[{"id":int,"desktop_wallpaper_count":int,"phone_wallpaper_count":int,...},{"id":int,"desktop_wallpaper_count":int,"phone_wallpaper_count":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the category. |
name | string | name of the category |
desktop_wallpaper_count | int | Count of desktop wallpapers in the category |
phone_wallpaper_count | int | Count of phone wallpapers in the category |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=category_list"); $results = json_decode($api_result); foreach($results->categories as $category) { echo "Have category id: " . $category->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | sub_category | Name of method |
type | yes | desktop | phone | Type of wallpapers to grab |
id | yes | int | ID of the sub category |
sort | no | newest | rating | How the wallpapers are sorted |
min_ratio | no | float (requires max_ratio) | (phone wallpapers only) |
max_ratio | no | float (requires min_ratio) | (phone wallpapers only) |
width | no | int (requires height) | Get only wallpapers with a certain width |
height | no | int (requires width) | Get only wallpapers with a certain height |
operator | no | max | equal | min | The type of resolution filter, <= will be used with 'max', = with 'equal' and >= with 'min'. |
page | no | int [1 .. 200] | Page number |
{ "success":true, "wallpapers":[{"id":int,"width":int,"height":int,...},{"id":int,"width":int,"height":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the wallpaper. |
width | int | Width of the wallpaper. |
height | int | Height of the wallpaper. |
file_type | string | Format of the wallpaper. |
file_size | int | Size of the wallpaper in (octets). |
url_image | string | URL to the wallpaper. |
url_thumb | string | URL to the wallpaper's thumbnail. |
url_page | string | URL to the wallpaper's page on Mobile Abyss. |
category | string | Name of the category. |
category_id | int | ID of the category. |
sub_category | string | Name of the sub-category. |
sub_category_id | int | ID of ths sub-category. |
user_name | string | Submitter of the wallpaper. |
user_id | int | Submitter ID of the wallpaper. |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=sub_category&type=desktop&id=173812"); $results = json_decode($api_result); foreach($results->wallpapers as $wallpaper) { echo "Have wallpaper id: " . $wallpaper->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | sub_category_list | Name of method |
id | yes | int | The category id |
page | no | int | Page Number. 30 subcategories/page. |
{ "success":true, "sub_categories":[{"id":int,"name":string,"desktop_wallpaper_count":int,"phone_wallpaper_count":int,...},{"id":int,"name":string,"desktop_wallpaper_count":int,"phone_wallpaper_count":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the category. |
name | string | name of the category |
desktop_wallpaper_count | int | Count of desktop wallpapers in the category |
phone_wallpaper_count | int | Count of phone wallpapers in the category |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=category_list"); $results = json_decode($api_result); foreach($results->categories as $category) { echo "Have category id: " . $category->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | tag | Name of method |
type | yes | desktop | phone | Type of wallpapers to grab |
id | yes | int | ID of the tag |
sort | no | newest | rating | How the wallpapers are sorted |
min_ratio | no | float (requires max_ratio) | (phone wallpapers only) |
max_ratio | no | float (requires min_ratio) | (phone wallpapers only) |
width | no | int (requires height) | Get only wallpapers with a certain width |
height | no | int (requires width) | Get only wallpapers with a certain height |
operator | no | max | equal | min | The type of resolution filter, <= will be used with 'max', = with 'equal' and >= with 'min'. |
page | no | int [1 .. 200] | Page number |
{ "success":true, "wallpapers":[{"id":int,"width":int,"height":int,...},{"id":int,"width":int,"height":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the wallpaper. |
width | int | Width of the wallpaper. |
height | int | Height of the wallpaper. |
file_type | string | Format of the wallpaper. |
file_size | int | Size of the wallpaper in (octets). |
url_image | string | URL to the wallpaper. |
url_thumb | string | URL to the wallpaper's thumbnail. |
url_page | string | URL to the wallpaper's page on Mobile Abyss. |
category | string | Name of the category. |
category_id | int | ID of the category. |
sub_category | string | Name of the sub-category. |
sub_category_id | int | ID of ths sub-category. |
user_name | string | Submitter of the wallpaper. |
user_id | int | Submitter ID of the wallpaper. |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=tag&type=phone&id=114"); $results = json_decode($api_result); foreach($results->wallpapers as $wallpaper) { echo "Have wallpaper id: " . $wallpaper->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | search | Name of method |
type | yes | desktop | phone | Type of wallpapers to grab |
term | yes | string | The search term used for matching. Max 128 characters |
min_ratio | no | float (requires max_ratio) | (phone wallpapers only) |
max_ratio | no | float (requires min_ratio) | (phone wallpapers only) |
width | no | int (requires height) | Get only wallpapers with a certain width |
height | no | int (requires width) | Get only wallpapers with a certain height |
operator | no | max | equal | min | The type of resolution filter, <= will be used with 'max', = with 'equal' and >= with 'min'. |
page | no | int [1 .. 200] | Page number |
{ "success":true, "wallpapers":[{"id":int,"width":int,"height":int,...},{"id":int,"width":int,"height":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the wallpaper. |
width | int | Width of the wallpaper. |
height | int | Height of the wallpaper. |
file_type | string | Format of the wallpaper. |
file_size | int | Size of the wallpaper in (octets). |
url_image | string | URL to the wallpaper. |
url_thumb | string | URL to the wallpaper's thumbnail. |
url_page | string | URL to the wallpaper's page on Mobile Abyss. |
category | string | Name of the category. |
category_id | int | ID of the category. |
sub_category | string | Name of the sub-category. |
sub_category_id | int | ID of ths sub-category. |
user_name | string | Submitter of the wallpaper. |
user_id | int | Submitter ID of the wallpaper. |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=search&term=star+wars&type=phone"); $results = json_decode($api_result); foreach($results->wallpapers as $wallpaper) { echo "Have wallpaper id: " . $wallpaper->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | random | Name of method |
type | yes | desktop | phone | Type of wallpapers to grab |
{ "success":true, "wallpapers":[{"id":int,"width":int,"height":int,...},{"id":int,"width":int,"height":int,...},...] }
Name | Type | Description |
---|---|---|
id | int | ID of the wallpaper. |
width | int | Width of the wallpaper. |
height | int | Height of the wallpaper. |
file_type | string | Format of the wallpaper. |
file_size | int | Size of the wallpaper in (octets). |
url_image | string | URL to the wallpaper. |
url_thumb | string | URL to the wallpaper's thumbnail. |
url_page | string | URL to the wallpaper's page on Mobile Abyss. |
category | string | Name of the category. |
category_id | int | ID of the category. |
sub_category | string | Name of the sub-category. |
sub_category_id | int | ID of ths sub-category. |
user_name | string | Submitter of the wallpaper. |
user_id | int | Submitter ID of the wallpaper. |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=random&type=desktop"); $results = json_decode($api_result); foreach($results->wallpapers as $wallpaper) { echo "Have wallpaper id: " . $wallpaper->id; }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | tag | Name of method |
type | yes | desktop | phone | Type of wallpaper to grab |
id | yes | int | ID of the phone wallpaper |
{ "success":true, "wallpaper":{"id":int,"name":string,"featured":boolean,"width":int,"height":int,...}, "tags":[{"id":int,"name":string},{"id":int,"name":string},...] }
Parameter | Required | Value | Description |
---|---|---|---|
auth | yes | string | Your authentication key |
method | yes | random | Name of method |
{ "success":true, "count":10000 }
Name | Type | Description |
---|---|---|
count | int | Your query count for the month |
{ "success":false, "error":string }
$api_result = file_get_contents("https://api.alphacoders.com/3.0?auth=YOUR_KEY&method=query_count"); $results = json_decode($api_result); echo $results->count