Basic information API interface of national universities and colleges
Published: 2023-03-14 14:41:07

Basic information API interface of national universities and colleges

Provide basic information on universities and colleges across the country.

![gugudata_api_cover](https://static.gugudata.com/api_logo_colleges.jpg)

# 1. Product Features

- Provide the latest national college basic information and enrollment data;
- A total of nearly 3,000 accurate data of national colleges and universities;
- Update correction data once a month;
- Full interface supports HTTPS (TLS v1.0 / v1.1 / v1.2 / v1.3);
- Fully compatible with Apple ATS;
- National multi-node CDN deployment;
- The interface responds extremely quickly, and multiple servers build API interface load balancing;
- [Interface call status and status monitoring](https://www.gugudata.com/status)

# 2. API documentation

**API details address:** [https://www.gugudata.com/api/details/college](https://www.gugudata.com/api/details/college)

**Interface request address:** [https://api.gugudata.com/location/college](https://api.gugudata.com/location/college)

**Return format:** application/json; charset=utf-8

**Request method:** GET

**Request Protocol:** HTTPS

**Request Example:** https://api.gugudata.com/location/college?appkey=YOUR_APPKEY&keywords=YOUR_VALUE&pagesize=10&pageindex=1&keywordstrict=false&collegecategory=

**Interface test:** [https://api.gugudata.com/location/college/demo](https://api.gugudata.com/location/college/demo)

# 3. Request parameters

|  Parameter name  |  Parameter type  |   Required   |   Default value   |   Remarks   |
| :----: | :------: | :------: | :---------: | :------------------------------------------: |
| appkey | string | yes | YOUR_APPKEY | APPKEY obtained after payment |
| keywords | string | Yes | YOUR_VALUE | Search keywords, fuzzy matching of university name, province, city, old name of university, address field, if the parameter value is empty, all data will be returned |
| pagesize | int | No | 10 | The amount of data per page, the maximum value of the parameter is 100 |
| pageindex | int | No | 1 | Page number, which page data |
| keywordstrict | string | No | false | Control whether the keyword parameter is used for fuzzy query when querying, true is to match the name of the university exactly, and the default value is false for fuzzy query |
| collegecategory | string | No | | College category, the parameter default value is empty, no filtering. The optional parameters are: science and engineering\|comprehensive\|teacher\|finance\|medicine\|art\|agriculture\|military\|politics\|language\|sports\|nationality class\|other|


# 4. Return parameters

| Parameter name | Parameter type | Remarks |
| :-----------------------------: | :------: | :----------------------------------: |
| DataStatus.StatusCode | int | Interface return status code |
| DataStatus.StatusDescription | string | Interface return status description |
| DataStatus.ResponseDateTime | string | Interface data return time |
| DataStatus.DataTotalCount | int | The total amount of data under this condition, generally used for pagination calculation |
| Data.SchoolUUID | string | The unique ID of the college on the Gugu Data Platform, which can be used with the [College Entrance Examination Score Line](https://www.gugudata.com/api/details/ceecollegeline), [CEE College Entrance Admission ceemajorline](https://www.gugudata.com/api/details/ceemajorline) interface for unique matching of SchoolUUID |
| Data.CollegeName | string | College name |
| Data.Province | string | Province where the college is located |
| Data.City | string | The city where the college is located |
| Data.District | string | District and county where the college is located |
| Data.Coordinate | string | The longitude and latitude of the geographic coordinates of the college, the format is [longitude,latitude], and the geographic coordinate system is GCJ-02. If you need to convert the coordinate system, please call the [Geographic Coordinate System Conversion](https://www.gugudata.com/api/details/coordinateconverter) interface |
| Data.CollegeType | string | The nature of the college, the enumeration of values is: general undergraduate\|independent college\|specialist (higher vocational)\|higher vocational college\|Sino-foreign cooperative education\|adult education\|HND project\| Distance Education College\|Others |
| Data.Is985 | bool | Whether it is a 985 school or not |
| Data.Is211 | bool | Whether it is a 211 institution |
| Data.IsDualClass | bool | Whether it is a dual first-class institution |
| Data.CollegeCategory | string | College category, the enumeration of values is: comprehensive \|science and engineering\|teacher\|finance\|medicine\|art\|agriculture\|military\|politics and law \|Languages\|Sports\|Nationalities\|Others |
| Data.CollegeTags | string[] | college tags |
| Data.EduLevel | string | School system, the enumeration of values is: general undergraduate\|undergraduate\|specialist (higher vocational)\|specialist\|others |
| Data.CollegeProperty | string | College qualification, the enumeration of values is: public\|private\|Sino-foreign cooperative education |
| Data.CollegeCode | string | College Code |
| Data.Ranking | int | National ranking, the data results returned by the interface are sorted in ascending order according to this value by default |
| Data.RankingInCategory | string | Ranking under the category of the college |
| Data.WebSite | string | College official website |
| Data.CallNumber | string | College Admissions Phone |
| Data.Email | string | College Admissions Email |
| Data.Address | string | College address |
| Data.CoverImage | string | College logo |
| Data.Intro | string | College Profile |
| Data.Expenses | string | College fees (for reference only)

|
| Data.OldName | string | Old name of the college |
| Data.ShortName | string | College short name |
| Data.MajorList.MajorTitle | string | Create major categories |
| Data.MajorList.Majors | string[] | Majors under this category |

# 5. Interface HTTP response standard status code

| Status Code | Status Code Explanation | Remarks |
| :----: | :----------: | :----------------------------------------------------------: |
| 200 | The interface responds normally | See the business status code below **Interface custom status code** |
| 403 | Request Frequency Exceeded | The CDN layer intelligently judges the request frequency through IP, and general high-frequency requests will not trigger this status code |

# 6. Interface response status code

| Status Code | Status Code Explanation | Remarks |
| :----: | :----------------------: | :----------------------------------------------------------: |
| 100 | Normal return | By judging this status code, it can be asserted that the interface returns normally |
| -1 | Request failed | Request processing request failed |
| 501 | Parameter error | Please check whether the number of parameters you passed and the parameter types match |
| 502 | Request frequency limited | It is generally recommended to request no more than 100 times per second |
| 503 | APPKEY authority exceeded/order expired | Please go to the Developer Center to check whether your APPKEY has expired or whether the authority has exceeded |
| 504 | APPKEY error | Please check whether the passed APPKEY is the value obtained from the developer center |
| 505 | The number of requests exceeds the interface limit | Please check whether the corresponding interface has a request limit and your current remaining number of interface requests |
| 900 | Interface internal response error | The availability of the interface is 99.999%, if you get this status code, please email us |

# 7. Develop language request sample code

The development languages included in the sample code: C#, Go, Java, jQuery, Node.js, Objective-C, PHP, Python, Ruby, Swift, etc. Other languages can be implemented by corresponding RESTful API requests.



![code demo](https://devopenclub.parryqiu.com/20220312222920.png)



# 8. Frequently Asked Questions Q&A

- Q: Is there a cache for data requests?

   A: All data is returned directly, and some periodic data is cached during the update cycle.

- Q: How to ensure the security of the key when requesting?

   A: It is generally recommended to place the request to our API in the back-end service of your application. All front-end requests of your application should point to your own back-end service. This architecture is also more pure and easy to maintain.

- Q: What development languages can the interface be used for?

   A: It can be used in all development languages that can make network requests, and is used for rapid data construction of your project.

- Q: Can the performance of the interface be guaranteed?

   A: The interface background architecture is consistent with the commercial project architecture we provide to enterprises. You can view the performance and information returned by the interface by visiting the test interface.

-----

Cuckoo Data, a professional data provider, provides professional and comprehensive data interfaces and commercial data analysis, making data your raw material for production.

![image-20200716141435988](https://devopenclub.parryqiu.com/20200716141437.png)

Based on the 100-billion-level data storage and performance optimization and related massive basic data support that we have provided to enterprise customers in the past seven years, Cuckoo Data abstracts some compliant general data and general functions into product-level data APIs, which greatly satisfies the needs of users in products. The demand for basic data in the development process also reduces the storage and operation and maintenance costs of massive data, as well as the technical threshold and human development costs of complex functions.

In addition to the classified data and functional interfaces that we have opened, there are still massive amounts of data that are being sorted, cleaned, integrated, and constructed. Later, more data and cloud functional interface APIs will be opened for users to use.

# **Currently open data interface API**

- [[Barcode Tool] Universal QR Code Generation](https://www.gugudata.com/api/details/qrcode)
- [[Barcode tool] Wi-Fi wireless network QR code generation](https://www.gugudata.com/api/details/wifiqrcode)
- [[Barcode Tools] Universal Barcode Generation](https://www.gugudata.com/api/details/barcode)
- [[Image Recognition] Universal OCR](https://www.gugudata.com/api/details/ocr)
- [[Image Recognition] Universal Image OCR to Word](https://www.gugudata.com/api/details/ocr2word)
- [[Image recognition] HTML to PDF](https://www.gugudata.com/api/details/html2pdf)
- [[Image recognition] HTML to Word](https://www.gugudata.com/api/details/html2word)
- [[Image recognition] Markdown to PDF](https://www.gugudata.com/api/details/markdown2pdf)
- [[Area/Coordinates] Basic Information of National Universities](https://www.gugudata.com/api/details/college)
- [[Area/Coordinates] Geographic Coordinate Inverse Code](https://www.gugudata.com/api/details/geodecode)
- [[Area/Coordinates] IP address location](https://www.gugudata.com/api/details/iplocation)
- [[Region/Coordinates] National provinces, cities, streets and districts information](https://www.gugudata.com/api/details/chinaregions)
- [[Area/Coordinate] Geographic Coordinate System Conversion](https://www.gugudata.com/api/details/coordinateconverter)
- [[Metadata/Dictionary] Provincial admission scores for college entrance examination over the years](https://www.gugudata.com/api/details/ceeprovince)
- [[Metadata/Dictionary] College Entrance Examination Scores Over the Years](https://www.gugudata.com/api/details/ceecollegeline)
- [[Metadata/Dictionary] Admission scores for majors in college entrance examination over the years](https://www.gugudata.com/api/details/ceemajorline)
- [[News/Information] Software development technology blog headlines](https://www.gugudata.com/api/details/techblogs)
- [[News/Information] Fetch the text of any linked article](https://www.gugudata.com/api/details/fetchcontent)
- [[News/Information] Official account headline article](https://www.gugudata.com/api/details/wxarticle)
- [[News/Information] Fetch any link text image](https://www.gugudata.com/api/details/fetchcontentimages)
- [[News/Information] Get the official account article cover](https://www.gugudata.com/api/details/wxarticlecover)
- [[News/Information] Humorous joke collection](https://www.gugudata.com/api/details/joke)
- [[SMS/Voice] Phone attribution query](https://www.gugudata.com/api/details/mobileattribution)
- [[SMS/Voice] International phone number check and correction](https://www.gugudata.com/api/details/internationalphone)
- [[Text/Text] Chinese text word segmentation](https://www.gugudata.com/api/details/segment)
- [[Text/Text] Chinese and English typesetting standardization](https://www.gugudata.com/api/details/formatarticle)
- [[text/text] data of millions of Chinese couplets](https://www.gugudata.com/api/details/couplet)
- [[Text/Text] International Standard Book Number ISBN](https://www.gugudata.com/api/details/isbn)
- [[Text/Text] Simplified and Traditional Chinese conversion](https://www.gugudata.com/api/details/stconvert)
- [[Text/Text] Tang Poetry and Song Ci Encyclopedia](https://www.gugudata.com/api/details/chinesepoem)
- [[Text/Text] Keyword Summary Intelligent Extraction](https://www.gugudata.com/api/details/nlpabstract)
- [[Text/Text] Text Semantic Similarity Detection](https://www.gugudata.com/api/details/nlpsimilarity)
- [[Text/Text] NLP Chinese Intelligent Error Correction](https://www.gugudata.com/api/details/nlpcorrect)
- [[Text/Text] Artificial intelligence couplet generation](https://www.gugudata.com/api/details/coupletai)
- [[Weather/Air Quality] National Weather Forecast Information](https://www.gugudata.com/api/details/weatherinfo)
- [[Weather/Air Quality] National Real-time Air Quality Index](https://www.gugudata.com/api/details/airquality)
-[[Weather/Air Quality] Sunrise and Sunset Time](https://www.gugudata.com/api/details/sunriseandsunset)
- [[Weather/Air Quality] Lunar Calendar and 24 Solar Terms](https://www.gugudata.com/api/details/lunarcalendar)
- [[Website Tools] Get any site title and icon](https://www.gugudata.com/api/details/favicon)
- [[Stock Quotes] U.S. stock real-time market data](https://www.gugudata.com/api/details/stockusrealtime)
- [[Stock Quotes] Historical U.S. Stock Quotes Data](https://www.gugudata.com/api/details/stockus)
- [[Stock Quotes] US stock time-sharing trading data](https://www.gugudata.com/api/details/stockusperminute)
- [[Stock Quotes] Basic financial data of US stocks over the years](https://www.gugudata.com/api/details/usfundamental)
- [[Stock Quotes] Hong Kong stocks real-time market data](https://www.gugudata.com/api/details/stockhkrealtime)
- [[Stock Quotes] Hong Kong Stocks Historical Quotes Data](https://www.gugudata.com/api/details/stockhk)
- [[Stock Quotes] Hong Kong stock time-sharing trading data](https://www.gugudata.com/api/details/stockhkperminute)
- [[Stock Quotes] Hong Kong Stock Listed Companies Announcement](https://www.gugudata.com/api/details/stockhkbulletin)
- [[Stock Quotes] Three major financial statements of Hong Kong stocks over the years](https://www.gugudata.com/api/details/hkannualreport)
- [[Stock Quotes] A share real-time market data](https://www.gugudata.com/api/details/stockcnrealtime)
- [[Stock Quotes] A-share Historical Quotes Data](https://www.gugudata.com/api/details/stockcn)
- [[Stock Quotes] A share hourly transaction data](https://www.gugudata.com/api/details/stockcnperminute)
- [[Stock Quotes] Three major financial statements of A shares over the years](https://www.gugudata.com/api/details/annualreport)
- [[Stock Quotes] China Stock Index Data](https://www.gugudata.com/api/details/stockcnrealtimeindex)
- [[Stock Quotes] A-share individual stock information query](https://www.gugudata.com/api/details/fundamentalinfo)
- [[Stock Quotes] Financial Indicators of A Shares Over the Years](https://www.gugudata.com/api/details/financialindicator)
- [[Stock Quotes] A-Share Index Component Data](https://www.gugudata.com/api/details/stockcnindexcontains)
- [[Stock Quotes] A-share Index History Data](https://www.gugudata.com/api/details/stockcnindexhistory)
- [[Stock quotes] A-share pre-market data](https://www.gugudata.com/api/details/stockcnpreopen)
- [[Stock Quotes] A share transaction data](https://www.gugudata.com/api/details/stockcnticks)
- [[Stock Quotes] A Share Trading Calendar](https://www.gugudata.com/api/details/stockcntradecalendar)
- [[Stock Quotes] Options real-time market data](https://www.gugudata.com/api/details/stockcnoptions)
- [[Stock Quotes] Basic Fund Information List](https://www.gugudata.com/api/details/fundinfolist)
- [[Stock Quotes] Index Fund Basic Information](https://www.gugudata.com/api/details/fundbasicindex)
- [[Stock Quotes] Open-end Fund NAV real-time data](https://www.gugudata.com/api/details/fundopennavrealtime)
- [[Stock Quotes] Open-end Fund NAV Historical Data](https://www.gugudata.com/api/details/fundopennavhistory)
- [[Stock Quotes] Science and Technology Innovation Board Historical Market Data](https://www.gugudata.com/api/details/stockkcb)
- [[Stock Quotes] US stock pink sheet real-time market data](https://www.gugudata.com/api/details/pinksheetsrealtime)
- [[Stock Quotes] Classified U.S. stock real-time market data](https://www.gugudata.com/api/details/usfamous)
- [[Stock Quotes] Real-time data of public open-end funds](https://www.gugudata.com/api/details/fundopenrealtime)
- [[Stock Quotes] Historical data of public open-end funds](https://www.gugudata.com/api/details/fundopenrealtime)
- [[Stock Quotes] Exchange-traded fund real-time data](https://www.gugudata.com/api/details/fundopenetfrealtime)
- [[Stock Quotes] Exchange Traded Fund Historical Data](https://www.gugudata.com/api/details/fundopenetfhistory)
- [[Stock Quotes] Exchange-traded fund time-sharing quotes](https://www.gugudata.com/api/details/fundhistoryminute)
- [[Sports/Competition] Olympic Games Data](https://www.gugudata.com/api/details/olympic))