API Documentation

https://unihunt.org/api

{
  "status": 1,
  "message": "Success",
  "data": { }
}
            

Authentication

All requests require an X-API-KEY header for authentication.

X-API-KEY: your_api_key_here
Content-Type: application/json
            

Error Response:

{
  "status": 0,
  "message": "Invalid API Key"
}
            

User Management

Register a New User

POST /api/new_user
            

Request Body:

{
  "first_name": "John",
  "last_name": "Doe",
  "user_email": "johndoe@example.com",
  "user_password": "SecurePass123"
}
            

Login User

POST /api/old_user
            

University & Course Management

Get University List

GET /api/university
            

Get Courses

GET /api/course
            

Search & Filtering

Allows searching for courses based on filters such as name, qualification, and country.

Example Request:

GET /api/search?course_name=MBA&country_id=1
            

Get Website Information

GET /api/website

Response:

[
    {
      "site_details_id": "1",
      "website_name": "UniHunt",
      "meta_description": "Explore the realm of higher education with UniHunt, your comprehensive guide to discovering and evaluating the world's leading universities. Our paid service provides expert shortlisting to guide you to the top educational institutions.",
      "website_image": "hunt.png",
      "title": "UniHunt | Your Gateway to Top Universities Worldwide",
      "keywords": "study abroad, usa, uk, canda, australia, University, Shortlisting, Top Universities, Education, College Search, Sop, Sop For Usa, Sop For Australia, Sop Sample, Unihunt, Study Abroad Summer, Summer, Winter Study Abroad, Study Abroad, International Study A",
      "android_app_url": "https://global.app.mi.com/details?lo=IN&la=en_US&id=in.sunglade.unihunt",
      "ios_app_url": null,
      "status": "1",
      "created_at": "2024-06-15 13:39:53",
      "updated_at": "2024-07-22 08:07:53",
      "deleted_at": null
    }
]
              

Country Information

Get All Countries

GET /api/country

Response:

  [
    {
      "country_id": "1",
      "name": "Afghanistan",
      "iso3": "AFG",
      "iso2": "AF",
      "numeric_code": "4",
      "phone_code": "93",
      "capital": "Kabul",
      "currency": "AFN",
      "currency_name": "Afghan afghani",
      "currency_symbol": "?",
      "tld": ".af",
      "native": "افغانستان",
      "region": "Asia"
    },
    {
      "country_id": "2",
      "name": "Aland Islands",
      "iso3": "ALA",
      "iso2": "AX",
      "numeric_code": "248",
      "phone_code": "340",
      "capital": "Mariehamn",
      "currency": "EUR",
      "currency_name": "Euro",
      "currency_symbol": "€",
      "tld": ".ax",
      "native": "Åland",
      "region": "Europe"
    }
  ]
              

Get Country by ID

GET /api/country/{country_id}

Example Request:

GET /api/country/233

Response:

  {
    "country_id": "233",
    "name": "United States",
    "iso3": "USA",
    "iso2": "US",
    "numeric_code": "840",
    "phone_code": "1",
    "capital": "Washington",
    "currency": "USD",
    "currency_name": "United States dollar",
    "currency_symbol": "$",
    "tld": ".us",
    "native": "United States",
    "region": "Americas"
  }
              

University Countries

Get Countries with Available Universities

GET /api/uni-country

Description:

Returns a list of countries that have universities available in the system.

Example Request:

GET /api/uni-country

Response:

  [
    {
      "country_id": "14",
      "country_name": "Australia",
      "iso2": "AU"
    },
    {
      "country_id": "39",
      "country_name": "Canada",
      "iso2": "CA"
    },
    {
      "country_id": "59",
      "country_name": "Denmark",
      "iso2": "DK"
    },
    {
      "country_id": "158",
      "country_name": "New Zealand",
      "iso2": "NZ"
    },
    {
      "country_id": "232",
      "country_name": "United Kingdom",
      "iso2": "GB"
    },
    {
      "country_id": "233",
      "country_name": "United States",
      "iso2": "US"
    }
  ]
              

Response Fields:

Field	Type	Description
country_id	int	Unique identifier for the country
country_name	string	Name of the country
iso2	string	Two-letter ISO country code

Statistics

Get University & Course Counts

GET /api/countuniversitycourse
            

Get Total Counts

GET /api/count