Rankings
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a collection of ranking lists created in DreamApply.
URI
/api/v10/rankingsView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v10/rankings | C | GET HEAD | List all ranking lists created in DreamApply |
/api/v10/rankings/ID/ | R | GET HEAD | Get information about a ranking list |
/api/v10/rankings/ID/offers | R | GET HEAD | List all offers in a ranking list |
GET List rankings
List all ranking lists created in DreamApply.
This request is supported in API version 10 and later.
Syntax
GET /api/v10/rankings
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/rankings"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
X-Count | 3 | The number of ranking lists |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of ranking lists was successfully returned |
Example response
Response
{
"1": {
"id": 1,
"created": "2026-05-20T11:01:02+00:00",
"modified": "2026-05-20T11:01:02+00:00",
"title": "Computer Science and Engineering Ranking",
"offers": "/api/v10/rankings/1/offers"
},
"2": {
"id": 2,
"created": "2026-05-20T11:01:17+00:00",
"modified": "2026-05-20T11:01:17+00:00",
"title": "Electrical and Electronics Engineering Ranking",
"offers": "/api/v10/rankings/2/offers"
},
"3": {
"id": 3,
"created": "2026-05-20T11:01:31+00:00",
"modified": "2026-05-20T11:01:31+00:00",
"title": "Industrial and Systems Engineering Ranking",
"offers": "/api/v10/rankings/3/offers"
}
}