# University API

### **University API Documentation**

A University API is like a digital guide to a university, offering information about courses, faculty, departments, and more. It's a powerful tool for students, researchers, and developers to access information, automate tasks, and build helpful applications. Think of it as a central hub for university data, making it easier to connect and interact with the institution.

## Base URL

<pre><code><strong>https://santechapi.vercel.app
</strong></code></pre>

### Authentication

```
headers : {
"token" : {YOUR API KEY}
}
```

**Endpoint:** `university/country/{:q}`

### Parameters:

* {q}: Random input text from the user

*HTTP Method: `Get`*

**Example request**

```
GET /university/country/India
```

**Example Response**

`200`

```
[
{
	"state-province": "Mumbai",
	"alpha_two_code": "IN",
	"web_pages": [
		"https://atharvacoe.ac.in"
	],
	"name": "Atharva College of Engineering",
	"domains": [
		"atharvacoe.ac.in"
	],
	"country": "India"
},
{
	"state-province": "Delhi",
	"alpha_two_code": "IN",
	"web_pages": [
		"http://bpitindia.ac.in"
	],
	"name": "Bhagwan Parshuram Institute of Technology",
	"domains": [
		"bpitindia.edu.in",
		"bpitindia.in"
	],
	"country": "India"
},
{
	"domains": [
		"upes.ac.in"
	],
	"alpha_two_code": "IN",
	"web_pages": [
		"https://www.upes.ac.in/"
	],
	"name": "University of Petroleum and Energy Studies",
	"state-province": "Dehradun",
	"country": "India"
},
{
	"domains": [
		"ashoka.edu.in"
	],
	"alpha_two_code": "IN",
	"web_pages": [
		"https://www.ashoka.edu.in"
	],
	"name": "Ashoka University",
	"state-province": "Haryana",
	"country": "India"
}
]
```

### Error Handling

In case of an error, the API will respond with an appropriate HTTP status code and an error message in the response body.

`402`

```
 {
message:"param required for keyword based university fetch"
}

```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://santech.gitbook.io/docs/university-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.