Endpoints
This page contains the documentation for each endpoint, but if you're just getting started, we recommend taking a look at one of the guides e.g. Get College Information.
Note that all endpoints return JSON, even in the case of an error. The response will always have a true or false key named success.
{
"success": false,
"message": "API Key was not provided"
}Every request must include your API key.
College Retrieval
Get information for one or more colleges.
GET /v1/api/college/info
See the college information guide for examples
Note that along with info_ids, one of college_names, college_ids or college_unit_ids must be provided
Query Parameters
info_ids *
String
Comma-delimited information ids. Specifies what additional info to return in the response.
Example: student_faculty_ratio,in_state_tuition
college_ids
String
Comma-delimited semantic ids for each college to query for.
Example: rensselaer-polytechnic-institute,stanford-university
college_names
String
Names or abbreviations for colleges to query for.
Example:
MIT,Rensselaer Polytechnic
{
"success": true,
"colleges": [
{
"collegeId": "rensselaer-polytechnic-institute",
"collegeUnitId": "194824",
"name": "Rensselaer Polytechnic Institute",
"studentFacultyRatio": 15,
"inStateTuition": 51000
},
{
"collegeId": "stanford-university",
"collegeUnitId": "243744",
"name": "Stanford University",
"studentFacultyRatio": 10,
"inStateTuition": 48987
}
]
}Get a list of colleges matching a filter.
GET /v1/api/college-list
Query Parameters
info_ids*
String
Comma-delimited information ids. Specifies what additional info to return in the response.
Example: student_faculty_ratio,in_state_tuition
limit
Number
Maximum number of colleges to return. Default max is 20.
Example: 20
offset
Number
Use this when loading more on page scroll. Can be used to get more than the limit of colleges with multiple requests. Specifies what index to begin returning colleges at.
Example: 10
{
"success": true,
"colleges": [
{
"collegeId": "university-of-california---berkeley",
"collegeUnitId": "110635",
"name": "University of California - Berkeley",
"website": "www.berkeley.edu",
"city": "Berkeley",
"stateAbbr": "CA",
"aliases": [
"UC Berkeley"
],
},
{
"collegeId": "university-of-california---los-angeles",
"collegeUnitId": "110662",
"name": "University of California - Los Angeles",
"website": "www.ucla.edu",
"city": "Los Angeles",
"stateAbbr": "CA",
"aliases": [
"UCLA"
],
}
]
}Autocomplete
Autocomplete college names based on query.
GET /v1/api/autocomplete/colleges
Search for a college by name, location or abbreviation. Great for college search fields. See an example in the college information guide.
Query Parameters
query*
String
Text to search colleges for.
Example: RPI
{
"success": true,
"collegeList": [
{
"id": "massachusetts-institute-of-technology",
"unitId": 166683,
"name": "Massachusetts Institute of Technology",
"city": "Cambridge",
"state": "MA"
},
{
"id": "smith-college",
"unitId": 167835,
"name": "Smith College",
"city": "Northampton",
"state": "MA",
"matchingIndices": [
1,
4
]
},
{
"id": "hobart-william-smith-colleges",
"unitId": 191630,
"name": "Hobart William Smith Colleges",
"city": "Geneva",
"state": "NY",
"matchingIndices": [
16,
19
]
}
]
}Autocomplete high school names based on query.
GET /vi/api/autocomplete/high-schools
Great for high school search fields. This is useful if you have a form where a student should enter their high school.
Query Parameters
q*
String
The user's input to the form field or the name of the high school to search for.
Example: San Francisco
zipcode
String
A zip code. This significantly improves selection recommendations.
Example: 94063
Last updated