AASHE provides access to all STARS Rated institutions through the API. The most common use of this api is as a navigation tool to institutions’ Reports.
Warning
This API supports GET requests only.
In v0.1 of the API, Institutions are currently rated STARS Institutions.
/api/0.1/institutions/
{
meta: {
limit: 20,
next: "/api/0.1/institutions/?offset=20&limit=20&format=json",
offset: 0,
previous: null,
total_count: 188
},
objects: [
{
city: "Decatur",
country: "United States of America",
current_report: {
date_submitted: "2012-02-15",
rating: "Silver",
resource_uri: "/api/0.1/submissions/349/",
version: "1.0"
},
is_member: true,
name: "Agnes Scott College",
postal_code: "30030-3797",
resource_uri: "/api/0.1/institutions/286/",
state: "GA"
},
{
city: "Washington",
country: "United States of America",
current_report: {
date_submitted: "2011-01-31",
rating: "Gold",
resource_uri: "/api/0.1/submissions/55/",
version: "1.0"
},
is_member: true,
name: "American University",
postal_code: "20016-8001",
resource_uri: "/api/0.1/institutions/54/",
state: "DC"
},
...
]
}
/api/0.1/institutions/286/
{
city: "Decatur",
country: "United States of America",
current_report: {
date_submitted: "2012-02-15",
rating: "Silver",
resource_uri: "/api/0.1/submissions/349/",
version: "1.0"
},
is_member: true,
name: "Agnes Scott College",
postal_code: "30030-3797",
resource_uri: "/api/0.1/institutions/286/",
state: "GA"
}
Property | Description |
---|---|
city | The city the institution is located in |
country | The country the institution is located in |
current_report | The most recent submitted report by this institution |
is_member | AASHE Member Status |
name | The formal name of the institution |
postal_code | The primary postal code for the institution |
resource_uri | The URL for the current resource |
state | The state the institution is located in |
Output from the Institutions List URI can be filtered by supplying the following GET parameters:
For example, given a set of institution named “Boston College”, “Boston University”, “Carnegie Mellon University”, and “University of Ohio”;
/api/0.1/institutions/name=Boston%20College will return a list containing only Boston College;
/api/0.1/institutions/name_contains=University will return a list containing Boston University, Carnegie Mellon University, and University of Ohio;
/api/0.1/institutions/name_startswith=B will return a list containing Boston College and Boston University;
/api/0.1/institutions/name_endswith=University will return a list containing Boston University and Carnegie Mellon University.
The filters can be chained;
/api/0.1/institutions/name_endswith=University&name_contains=Mellon will return a list containing only Carnegie Mellon University.
Search terms are case sensitive. Names of institututions are capitalized. For example, filtering with name_startswith=Boston might return a populated list, while filtering with name_startswith=boston returns an empty list.