API Documentation
Our API allows you to retrieve informations from our website via GET request and supports the following query parameters:
Here is an example of a GET request on our API:
This is the output that our API will return when you query for an url:
If you have any questions feel free to contact us.
| Name | Description |
| city | This parameter queries a username in order to retrieve profile information, and will return the following: username (the requested username), name (the full-name of the user), location (the user location), website (the user's website), bio (the user's biography), date (the date when the user joined the website), image (the user's profile image), followers (number of users that follows the username requested), and the following (number of users followed by the requested username) value. |
URL parameter
Here is an example of a GET request on our API:
http://qulqal.com/api.php?username=system
This is the output that our API will return when you query for an url:
{
"apiVersion":"1.0",
"data":{
"username":"system",
"name":"system system",
"location":"Arabia",
"website":"http://qulqal.com/",
"bio":"This is a long description for an user profile.",
"date":"2012-12-27",
"image":"name of the image.png",
"followers":"1",
"following":"3"
}
}
An example of json decoding would be the following PHP code:
<?php
header('Content-Type: text/plain; charset=utf-8;');
$file = file_get_contents("http://qulqal.com/api.php?username=system");
print_r(json_decode($file));
?>
If you have any questions feel free to contact us.
