{"info":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","description":"

Ghana's education data: schools, the 2026 GES SHS placement register and CSSPS choice validation.

\n
    \n
  1. Get a free key at https://sukuudata.com/register
    2. \n
  2. Set the collection variable apiKey
    3. \n
  3. Send any request.
    4. \n
\n

Quickstart: https://sukuudata.com/quickstart

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"58644905","collectionId":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","publishedId":"2sBYHNVhYX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-30T22:55:15.000Z"},"item":[{"name":"Schools","item":[{"name":"List and filter schools","id":"c8c9803a-2e7d-4ed7-a46e-1dd27367316f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/schools?region=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=&sort=&page=1&limit=20","description":"

Paginated list of schools. Filters combine with AND; comma-separated values within one filter combine with OR.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","schools"],"host":["https://api.sukuudata.com"],"query":[{"description":{"content":"

Region code, pcode or name. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"region","value":""},{"description":{"content":"

District code, pcode or name. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"district","value":""},{"description":{"content":"

KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"level","value":""},{"description":{"content":"

Deprecated alias of level.

\n","type":"text/plain"},"key":"type","value":""},{"description":{"content":"

PUBLIC or PRIVATE. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"schoolType","value":""},{"description":{"content":"

School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"gender","value":""},{"description":{"content":"

DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"residential","value":""},{"description":{"content":"

ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

Exact town name (case-insensitive).

\n","type":"text/plain"},"key":"town","value":""},{"description":{"content":"

Substring of the school name (case-insensitive).

\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"

Only schools with (true) or without (false) coordinates.

\n","type":"text/plain"},"key":"hasLocation","value":""},{"description":{"content":"

name (default) or lastVerifiedAt; prefix with - for descending.

\n","type":"text/plain"},"key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"02aa706f-e795-4a6c-90ec-a2a9129a50fe","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools?region=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""},{"description":"name (default) or lastVerifiedAt; prefix with - for descending.","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"PRIMARY\",\n \"type\": null,\n \"gender\": \"MIXED\",\n \"residentialType\": \"BOARDING\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"NEEDS_REVIEW\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"PILOT_PRIVATE\",\n \"institutionType\": \"TVET\",\n \"gender\": \"BOYS\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n }\n ],\n \"specialNeeds\": [\n \"LEARNING_DIFFICULTIES\",\n \"HEARING_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"HIGH\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"TVET\",\n \"type\": null,\n \"gender\": null,\n \"residentialType\": \"BOARDING\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"ACTIVE\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"C\",\n \"institutionType\": \"SHTS\",\n \"gender\": \"MIXED\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n }\n ],\n \"specialNeeds\": [\n \"HEARING_IMPAIRED\",\n \"VISUALLY_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"NONE\"\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\"\n }\n}"},{"id":"aea4fa2d-c2d4-4135-975d-786e4c221a97","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools?region=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""},{"description":"name (default) or lastVerifiedAt; prefix with - for descending.","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"a444be89-e865-418e-ab35-0cf7ac4737be","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools?region=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""},{"description":"name (default) or lastVerifiedAt; prefix with - for descending.","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"0756813f-6673-44d5-a9c0-007a17bee40a","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools?region=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""},{"description":"name (default) or lastVerifiedAt; prefix with - for descending.","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"c8c9803a-2e7d-4ed7-a46e-1dd27367316f"},{"name":"Autocomplete schools by name","id":"97bc0a41-789d-49f1-9cd9-7ed4725f1022","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/schools/search?q=®ion=&level=&limit=10","description":"

Typo-tolerant name search for school pickers and sign-up forms. Prefix matches rank first. Returns at most limit results, best first.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","schools","search"],"host":["https://api.sukuudata.com"],"query":[{"description":{"content":"

(Required) What the user has typed so far

\n","type":"text/plain"},"key":"q","value":""},{"description":{"content":"

Region code, pcode or name. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"region","value":""},{"description":{"content":"

KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"level","value":""},{"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"6b569c71-d6f0-439d-905c-ba7b3225faaa","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/search?q=®ion=&level=&limit=10","host":["https://api.sukuudata.com"],"path":["api","v1","schools","search"],"query":[{"description":"(Required) What the user has typed so far","key":"q","value":""},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": null,\n \"type\": \"Private\",\n \"gender\": \"GIRLS\",\n \"residentialType\": \"MIXED\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"ACTIVE\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"C\",\n \"institutionType\": \"SHTS\",\n \"gender\": \"GIRLS\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n }\n ],\n \"specialNeeds\": [\n \"HEARING_IMPAIRED\",\n \"HEARING_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"NONE\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"PRIMARY\",\n \"type\": \"Private\",\n \"gender\": \"GIRLS\",\n \"residentialType\": \"BOARDING\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"ACTIVE\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"C\",\n \"institutionType\": \"SHTS\",\n \"gender\": \"BOYS\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n }\n ],\n \"specialNeeds\": [\n \"LEARNING_DIFFICULTIES\",\n \"LEARNING_DIFFICULTIES\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"HIGH\"\n }\n }\n ]\n}"},{"id":"2f356f1b-fc21-4d82-b87c-2b249cddc3e6","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/search?q=®ion=&level=&limit=10","host":["https://api.sukuudata.com"],"path":["api","v1","schools","search"],"query":[{"description":"(Required) What the user has typed so far","key":"q","value":""},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"key":"limit","value":"10"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"982ff2c3-9d41-4c17-826e-bda30d6b19af","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/search?q=®ion=&level=&limit=10","host":["https://api.sukuudata.com"],"path":["api","v1","schools","search"],"query":[{"description":"(Required) What the user has typed so far","key":"q","value":""},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"key":"limit","value":"10"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"2b94346c-436f-431c-a0ed-d97c62b2cf5c","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/search?q=®ion=&level=&limit=10","host":["https://api.sukuudata.com"],"path":["api","v1","schools","search"],"query":[{"description":"(Required) What the user has typed so far","key":"q","value":""},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"key":"limit","value":"10"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"97bc0a41-789d-49f1-9cd9-7ed4725f1022"},{"name":"Schools near a point","id":"4ae72479-cefb-4222-982a-e4fa9e22bd09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/schools/nearby?lat=&lng=&radius=5&limit=20®ion=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=","description":"

Schools within radius km of a point, nearest first. Accepts the same filters as GET /schools.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","schools","nearby"],"host":["https://api.sukuudata.com"],"query":[{"description":{"content":"

(Required) Latitude (WGS84)

\n","type":"text/plain"},"key":"lat","value":""},{"description":{"content":"

(Required) Longitude (WGS84)

\n","type":"text/plain"},"key":"lng","value":""},{"description":{"content":"

Radius in km (max 50)

\n","type":"text/plain"},"key":"radius","value":"5"},{"key":"limit","value":"20"},{"description":{"content":"

Region code, pcode or name. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"region","value":""},{"description":{"content":"

District code, pcode or name. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"district","value":""},{"description":{"content":"

KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"level","value":""},{"description":{"content":"

Deprecated alias of level.

\n","type":"text/plain"},"key":"type","value":""},{"description":{"content":"

PUBLIC or PRIVATE. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"schoolType","value":""},{"description":{"content":"

School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"gender","value":""},{"description":{"content":"

DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"residential","value":""},{"description":{"content":"

ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

Exact town name (case-insensitive).

\n","type":"text/plain"},"key":"town","value":""},{"description":{"content":"

Substring of the school name (case-insensitive).

\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"

Only schools with (true) or without (false) coordinates.

\n","type":"text/plain"},"key":"hasLocation","value":""}],"variable":[]}},"response":[{"id":"427945cc-18b9-47d3-8c96-2cbd87a24996","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/nearby?lat=&lng=&radius=5&limit=20®ion=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=","host":["https://api.sukuudata.com"],"path":["api","v1","schools","nearby"],"query":[{"description":"(Required) Latitude (WGS84)","key":"lat","value":""},{"description":"(Required) Longitude (WGS84)","key":"lng","value":""},{"description":"Radius in km (max 50)","key":"radius","value":"5"},{"key":"limit","value":"20"},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"PRIMARY\",\n \"type\": \"Public\",\n \"gender\": \"BOYS\",\n \"residentialType\": \"MIXED\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"NEEDS_REVIEW\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"B\",\n \"institutionType\": \"SHS\",\n \"gender\": \"MIXED\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n }\n ],\n \"specialNeeds\": [\n \"HEARING_IMPAIRED\",\n \"VISUALLY_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"MEDIUM\"\n },\n \"distanceKm\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"SHS\",\n \"type\": \"Public\",\n \"gender\": \"BOYS\",\n \"residentialType\": null,\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"ACTIVE\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"A\",\n \"institutionType\": \"SHTS\",\n \"gender\": \"MIXED\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n }\n ],\n \"specialNeeds\": [\n \"VISUALLY_IMPAIRED\",\n \"VISUALLY_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"HIGH\"\n },\n \"distanceKm\": \"\"\n }\n ]\n}"},{"id":"37b43bf5-b57b-455e-832c-7b355956426d","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/nearby?lat=&lng=&radius=5&limit=20®ion=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=","host":["https://api.sukuudata.com"],"path":["api","v1","schools","nearby"],"query":[{"description":"(Required) Latitude (WGS84)","key":"lat","value":""},{"description":"(Required) Longitude (WGS84)","key":"lng","value":""},{"description":"Radius in km (max 50)","key":"radius","value":"5"},{"key":"limit","value":"20"},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"ec83b35a-4000-45f2-93bd-0de7629022b5","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/nearby?lat=&lng=&radius=5&limit=20®ion=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=","host":["https://api.sukuudata.com"],"path":["api","v1","schools","nearby"],"query":[{"description":"(Required) Latitude (WGS84)","key":"lat","value":""},{"description":"(Required) Longitude (WGS84)","key":"lng","value":""},{"description":"Radius in km (max 50)","key":"radius","value":"5"},{"key":"limit","value":"20"},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"08e13eb3-3b7f-408f-9209-193d6be54612","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/nearby?lat=&lng=&radius=5&limit=20®ion=&district=&level=&type=&schoolType=&gender=&residential=&status=&town=&search=&hasLocation=","host":["https://api.sukuudata.com"],"path":["api","v1","schools","nearby"],"query":[{"description":"(Required) Latitude (WGS84)","key":"lat","value":""},{"description":"(Required) Longitude (WGS84)","key":"lng","value":""},{"description":"Radius in km (max 50)","key":"radius","value":"5"},{"key":"limit","value":"20"},{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"KG, PRIMARY, JHS, SHS or TVET. Comma-separate to match any of several values.","key":"level","value":""},{"description":"Deprecated alias of level.","key":"type","value":""},{"description":"PUBLIC or PRIVATE. Comma-separate to match any of several values.","key":"schoolType","value":""},{"description":"School gender: MIXED, BOYS or GIRLS. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY, BOARDING or MIXED (day and boarding). Comma-separate to match any of several values.","key":"residential","value":""},{"description":"ACTIVE (default), NEEDS_REVIEW (no longer in the source; may have closed) or ALL. Comma-separate to match any of several values.","key":"status","value":""},{"description":"Exact town name (case-insensitive).","key":"town","value":""},{"description":"Substring of the school name (case-insensitive).","key":"search","value":""},{"description":"Only schools with (true) or without (false) coordinates.","key":"hasLocation","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"4ae72479-cefb-4222-982a-e4fa9e22bd09"},{"name":"Get a school","id":"5ea7cd84-3cdc-401a-b14f-9d7775b91454","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/schools/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","schools",":id"],"host":["https://api.sukuudata.com"],"query":[],"variable":[{"id":"6a421e84-7b48-4a85-be8d-24b0023334f3","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"65addd80-ba77-4931-83df-2e87197f547e","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/:id","host":["https://api.sukuudata.com"],"path":["api","v1","schools",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"KG\",\n \"type\": null,\n \"gender\": \"BOYS\",\n \"residentialType\": \"MIXED\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"ACTIVE\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"PILOT_PRIVATE\",\n \"institutionType\": \"SHTS\",\n \"gender\": \"BOYS\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n }\n ],\n \"specialNeeds\": [\n \"HEARING_IMPAIRED\",\n \"VISUALLY_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"MEDIUM\"\n }\n }\n}"},{"id":"c6b12e1b-e51d-4790-9f20-d776c8e801e2","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/:id","host":["https://api.sukuudata.com"],"path":["api","v1","schools",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"bbec4f67-8cff-469c-ad96-ea915056fb8d","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/:id","host":["https://api.sukuudata.com"],"path":["api","v1","schools",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"2820984d-41ee-4476-b497-67f1033ef03c","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/:id","host":["https://api.sukuudata.com"],"path":["api","v1","schools",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"533ade25-3fb2-4f9f-b19c-79b984655444","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/schools/:id","host":["https://api.sukuudata.com"],"path":["api","v1","schools",":id"],"variable":[{"key":"id"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"5ea7cd84-3cdc-401a-b14f-9d7775b91454"}],"id":"f4052521-d7d0-4c68-8301-760a98822c3f","description":"

Every school we have a record for, KG to TVET

\n","_postman_id":"f4052521-d7d0-4c68-8301-760a98822c3f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}}},{"name":"Secondary schools","item":[{"name":"Find SHS, SHTS and TVET schools in the placement register","id":"96466664-d763-4f5e-9962-e342da5a90d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/secondary-schools?region=&district=&search=&category=&institutionType=&programme=&studentGender=FEMALE&gender=&residential=&specialNeeds=&hasLocation=&lat=&lng=&radius=25&sort=&page=1&limit=20","description":"

Schools in the GES placement register, with category, programmes and boarding. Pass lat/lng to limit to a radius and get distances (sorted nearest first by default). Use studentGender to get only schools the student can attend.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","secondary-schools"],"host":["https://api.sukuudata.com"],"query":[{"description":{"content":"

Region code, pcode or name. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"region","value":""},{"description":{"content":"

District code, pcode or name. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"district","value":""},{"description":{"content":"

Substring of the school name

\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"

Placement category: A, B, C or PILOT_PRIVATE. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"category","value":""},{"description":{"content":"

SHS, SHTS (senior high/technical) or TVET. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"institutionType","value":""},{"description":{"content":"

Programme code the school must offer (see GET /programmes). Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"programme","value":""},{"description":{"content":"

Only schools open to this student

\n","type":"text/plain"},"key":"studentGender","value":"FEMALE"},{"description":{"content":"

School gender: MIXED, BOYS or GIRLS. Ignored when studentGender is set. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"gender","value":""},{"description":{"content":"

DAY or BOARDING: only schools offering it. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"residential","value":""},{"description":{"content":"

VISUALLY_IMPAIRED, HEARING_IMPAIRED or LEARNING_DIFFICULTIES: schools with these facilities. Comma-separate to match any of several values.

\n","type":"text/plain"},"key":"specialNeeds","value":""},{"key":"hasLocation","value":""},{"description":{"content":"

Latitude (WGS84)

\n","type":"text/plain"},"key":"lat","value":""},{"description":{"content":"

Longitude (WGS84)

\n","type":"text/plain"},"key":"lng","value":""},{"description":{"content":"

km, when lat/lng given

\n","type":"text/plain"},"key":"radius","value":"25"},{"description":{"content":"

name, -name, category, -category, or distance (needs lat/lng)

\n","type":"text/plain"},"key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"f8cc3a2d-2aa0-47db-8a38-d8ca1e0ca5ef","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools?region=&district=&search=&category=&institutionType=&programme=&studentGender=FEMALE&gender=&residential=&specialNeeds=&hasLocation=&lat=&lng=&radius=25&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"Substring of the school name","key":"search","value":""},{"description":"Placement category: A, B, C or PILOT_PRIVATE. Comma-separate to match any of several values.","key":"category","value":""},{"description":"SHS, SHTS (senior high/technical) or TVET. Comma-separate to match any of several values.","key":"institutionType","value":""},{"description":"Programme code the school must offer (see GET /programmes). Comma-separate to match any of several values.","key":"programme","value":""},{"description":"Only schools open to this student","key":"studentGender","value":"FEMALE"},{"description":"School gender: MIXED, BOYS or GIRLS. Ignored when studentGender is set. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY or BOARDING: only schools offering it. Comma-separate to match any of several values.","key":"residential","value":""},{"description":"VISUALLY_IMPAIRED, HEARING_IMPAIRED or LEARNING_DIFFICULTIES: schools with these facilities. Comma-separate to match any of several values.","key":"specialNeeds","value":""},{"key":"hasLocation","value":""},{"description":"Latitude (WGS84)","key":"lat","value":""},{"description":"Longitude (WGS84)","key":"lng","value":""},{"description":"km, when lat/lng given","key":"radius","value":"25"},{"description":"name, -name, category, -category, or distance (needs lat/lng)","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"TVET\",\n \"type\": \"Private\",\n \"gender\": \"MIXED\",\n \"residentialType\": \"MIXED\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"NEEDS_REVIEW\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"PILOT_PRIVATE\",\n \"institutionType\": \"TVET\",\n \"gender\": \"BOYS\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n }\n ],\n \"specialNeeds\": [\n \"VISUALLY_IMPAIRED\",\n \"HEARING_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"NONE\"\n },\n \"distanceKm\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"PRIMARY\",\n \"type\": \"Public\",\n \"gender\": \"GIRLS\",\n \"residentialType\": \"MIXED\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"ACTIVE\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"C\",\n \"institutionType\": \"SHTS\",\n \"gender\": \"MIXED\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\"\n }\n ],\n \"specialNeeds\": [\n \"HEARING_IMPAIRED\",\n \"VISUALLY_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"MEDIUM\"\n },\n \"distanceKm\": \"\"\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\"\n }\n}"},{"id":"1f91efaf-7147-437e-8614-8dc23ad44dfe","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools?region=&district=&search=&category=&institutionType=&programme=&studentGender=FEMALE&gender=&residential=&specialNeeds=&hasLocation=&lat=&lng=&radius=25&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"Substring of the school name","key":"search","value":""},{"description":"Placement category: A, B, C or PILOT_PRIVATE. Comma-separate to match any of several values.","key":"category","value":""},{"description":"SHS, SHTS (senior high/technical) or TVET. Comma-separate to match any of several values.","key":"institutionType","value":""},{"description":"Programme code the school must offer (see GET /programmes). Comma-separate to match any of several values.","key":"programme","value":""},{"description":"Only schools open to this student","key":"studentGender","value":"FEMALE"},{"description":"School gender: MIXED, BOYS or GIRLS. Ignored when studentGender is set. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY or BOARDING: only schools offering it. Comma-separate to match any of several values.","key":"residential","value":""},{"description":"VISUALLY_IMPAIRED, HEARING_IMPAIRED or LEARNING_DIFFICULTIES: schools with these facilities. Comma-separate to match any of several values.","key":"specialNeeds","value":""},{"key":"hasLocation","value":""},{"description":"Latitude (WGS84)","key":"lat","value":""},{"description":"Longitude (WGS84)","key":"lng","value":""},{"description":"km, when lat/lng given","key":"radius","value":"25"},{"description":"name, -name, category, -category, or distance (needs lat/lng)","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"ce482649-3bbe-4b53-b549-9bd6ff37efab","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools?region=&district=&search=&category=&institutionType=&programme=&studentGender=FEMALE&gender=&residential=&specialNeeds=&hasLocation=&lat=&lng=&radius=25&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"Substring of the school name","key":"search","value":""},{"description":"Placement category: A, B, C or PILOT_PRIVATE. Comma-separate to match any of several values.","key":"category","value":""},{"description":"SHS, SHTS (senior high/technical) or TVET. Comma-separate to match any of several values.","key":"institutionType","value":""},{"description":"Programme code the school must offer (see GET /programmes). Comma-separate to match any of several values.","key":"programme","value":""},{"description":"Only schools open to this student","key":"studentGender","value":"FEMALE"},{"description":"School gender: MIXED, BOYS or GIRLS. Ignored when studentGender is set. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY or BOARDING: only schools offering it. Comma-separate to match any of several values.","key":"residential","value":""},{"description":"VISUALLY_IMPAIRED, HEARING_IMPAIRED or LEARNING_DIFFICULTIES: schools with these facilities. Comma-separate to match any of several values.","key":"specialNeeds","value":""},{"key":"hasLocation","value":""},{"description":"Latitude (WGS84)","key":"lat","value":""},{"description":"Longitude (WGS84)","key":"lng","value":""},{"description":"km, when lat/lng given","key":"radius","value":"25"},{"description":"name, -name, category, -category, or distance (needs lat/lng)","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"774e28ca-ffa0-48f0-8ab7-b69f3a821bf4","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools?region=&district=&search=&category=&institutionType=&programme=&studentGender=FEMALE&gender=&residential=&specialNeeds=&hasLocation=&lat=&lng=&radius=25&sort=&page=1&limit=20","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools"],"query":[{"description":"Region code, pcode or name. Comma-separate to match any of several values.","key":"region","value":""},{"description":"District code, pcode or name. Comma-separate to match any of several values.","key":"district","value":""},{"description":"Substring of the school name","key":"search","value":""},{"description":"Placement category: A, B, C or PILOT_PRIVATE. Comma-separate to match any of several values.","key":"category","value":""},{"description":"SHS, SHTS (senior high/technical) or TVET. Comma-separate to match any of several values.","key":"institutionType","value":""},{"description":"Programme code the school must offer (see GET /programmes). Comma-separate to match any of several values.","key":"programme","value":""},{"description":"Only schools open to this student","key":"studentGender","value":"FEMALE"},{"description":"School gender: MIXED, BOYS or GIRLS. Ignored when studentGender is set. Comma-separate to match any of several values.","key":"gender","value":""},{"description":"DAY or BOARDING: only schools offering it. Comma-separate to match any of several values.","key":"residential","value":""},{"description":"VISUALLY_IMPAIRED, HEARING_IMPAIRED or LEARNING_DIFFICULTIES: schools with these facilities. Comma-separate to match any of several values.","key":"specialNeeds","value":""},{"key":"hasLocation","value":""},{"description":"Latitude (WGS84)","key":"lat","value":""},{"description":"Longitude (WGS84)","key":"lng","value":""},{"description":"km, when lat/lng given","key":"radius","value":"25"},{"description":"name, -name, category, -category, or distance (needs lat/lng)","key":"sort","value":""},{"key":"page","value":"1"},{"key":"limit","value":"20"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"96466664-d763-4f5e-9962-e342da5a90d2"},{"name":"Get a secondary school by CSSPS code","id":"8525068c-b82b-4409-b2b9-6957b50771fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/secondary-schools/:code","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","secondary-schools",":code"],"host":["https://api.sukuudata.com"],"query":[],"variable":[{"id":"60f39a5d-ace4-4ba2-b375-6dbb41bace69","description":{"content":"

(Required) 7-digit CSSPS school code

\n","type":"text/plain"},"type":"any","value":"7832184","key":"code"}]}},"response":[{"id":"989fbd4c-c279-43c7-9406-8b80ba2d1a58","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools/:code","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools",":code"],"variable":[{"key":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"level\": \"KG\",\n \"type\": null,\n \"gender\": \"BOYS\",\n \"residentialType\": \"MIXED\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"district\": \"\",\n \"districtCode\": \"\",\n \"town\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"status\": \"ACTIVE\",\n \"source\": \"\",\n \"lastVerifiedAt\": \"\",\n \"secondary\": {\n \"csspsCode\": \"\",\n \"category\": \"PILOT_PRIVATE\",\n \"institutionType\": \"SHTS\",\n \"gender\": \"BOYS\",\n \"offersDay\": \"\",\n \"offersBoarding\": \"\",\n \"programmes\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n }\n ],\n \"specialNeeds\": [\n \"HEARING_IMPAIRED\",\n \"VISUALLY_IMPAIRED\"\n ],\n \"registerYear\": \"\",\n \"locationConfidence\": \"MEDIUM\"\n }\n }\n}"},{"id":"f15f83f2-8fde-4c85-b13a-d84431778c71","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools/:code","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools",":code"],"variable":[{"key":"code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"75186ce8-5778-49e4-9a2d-20b0bdf50ca8","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools/:code","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools",":code"],"variable":[{"key":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"00189048-61b5-4815-a73e-8774c7b9695e","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools/:code","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools",":code"],"variable":[{"key":"code"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"63e224d1-3cae-4cab-9d99-ded3c029b306","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/secondary-schools/:code","host":["https://api.sukuudata.com"],"path":["api","v1","secondary-schools",":code"],"variable":[{"key":"code"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"8525068c-b82b-4409-b2b9-6957b50771fe"},{"name":"List programmes","id":"6a2fbf4b-05b1-41c5-acd2-862c0efa03b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/programmes?kind=","description":"

General programmes (e.g. 502 General Science) and TVET trades, with how many schools offer each.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","programmes"],"host":["https://api.sukuudata.com"],"query":[{"description":{"content":"

GENERAL or TVET

\n","type":"text/plain"},"key":"kind","value":""}],"variable":[]}},"response":[{"id":"cef2e376-6aa0-4a96-917b-2356ae419f1c","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/programmes?kind=","host":["https://api.sukuudata.com"],"path":["api","v1","programmes"],"query":[{"description":"GENERAL or TVET","key":"kind","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\",\n \"schoolCount\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"GENERAL\",\n \"schoolCount\": \"\"\n }\n ]\n}"},{"id":"e38da26f-f4f8-44e6-9f4d-8bd3b590e11d","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/programmes?kind=","host":["https://api.sukuudata.com"],"path":["api","v1","programmes"],"query":[{"description":"GENERAL or TVET","key":"kind","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"bad165d0-dbb4-430f-9e01-a4184520d4d4","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/programmes?kind=","host":["https://api.sukuudata.com"],"path":["api","v1","programmes"],"query":[{"description":"GENERAL or TVET","key":"kind","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"5d232966-93c1-47cd-a0e2-493507147206","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/programmes?kind=","host":["https://api.sukuudata.com"],"path":["api","v1","programmes"],"query":[{"description":"GENERAL or TVET","key":"kind","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"6a2fbf4b-05b1-41c5-acd2-862c0efa03b9"}],"id":"f374ed1b-92e1-48ed-a2ca-f589d8187a02","description":"

SHS/SHTS/TVET and pilot private schools from the GES placement register

\n","_postman_id":"f374ed1b-92e1-48ed-a2ca-f589d8187a02","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}}},{"name":"Placement","item":[{"name":"CSSPS school-selection rules (2026)","id":"02a55364-9c66-4cba-b939-deb7951d33bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/placement/rules","description":"

The official rules as data, with their source, so apps can show and enforce them.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","placement","rules"],"host":["https://api.sukuudata.com"],"query":[],"variable":[]}},"response":[{"id":"096d5a3d-a272-4129-b1e7-79680f51353b","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/placement/rules"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"year\": \"\",\n \"source\": {\n \"est_7c\": -78258915.45428239\n },\n \"totalChoices\": \"\",\n \"maxBoardingChoices\": \"\",\n \"maxDayChoices\": \"\",\n \"categoryLimits\": {\n \"cillum_02\": \"qui ut labore\",\n \"pariaturaef\": \"adipisicin\"\n },\n \"noRepeatedSchools\": \"\",\n \"dayCatchmentKm\": \"\",\n \"notes\": [\n \"\",\n \"\"\n ]\n }\n}"},{"id":"a49fab54-ab9a-4373-8dc1-ff79c22e5948","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/placement/rules"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"5e47d24a-8ba8-4c20-be01-090bb4b88710","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/placement/rules"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"569a4003-9e38-4398-a533-ba63972fc73b","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/placement/rules"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"02a55364-9c66-4cba-b939-deb7951d33bd"},{"name":"Validate a candidate's school choices","id":"2dd2070e-cf66-4bf4-af04-b29c4731f12f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"studentGender\": \"MALE\",\n \"choices\": [\n {\n \"csspsCode\": \"0010121\",\n \"programme\": \"502\",\n \"residential\": \"BOARDING\"\n },\n {\n \"csspsCode\": \"0010110\",\n \"programme\": \"502\",\n \"residential\": \"BOARDING\"\n },\n {\n \"csspsCode\": \"0021303\",\n \"programme\": \"502\",\n \"residential\": \"BOARDING\"\n },\n {\n \"csspsCode\": \"0030109\",\n \"programme\": \"502\",\n \"residential\": \"BOARDING\"\n },\n {\n \"csspsCode\": \"0030403\",\n \"programme\": \"502\",\n \"residential\": \"BOARDING\"\n },\n {\n \"csspsCode\": \"0070114\",\n \"programme\": \"502\",\n \"residential\": \"DAY\"\n },\n {\n \"csspsCode\": \"0070503\",\n \"programme\": \"502\",\n \"residential\": \"DAY\"\n },\n {\n \"csspsCode\": \"0030402\",\n \"programme\": \"502\",\n \"residential\": \"DAY\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sukuudata.com/api/v1/placement/validate","description":"

Checks a BECE candidate's CSSPS choices against the official rules (8 choices, boarding/day split, category limits, no repeats) and against what each school offers (programme, boarding, gender). errors break a rule; warnings are advice, such as a day school far from home. Returns 200 with valid: false for a form that breaks rules; 400 only for a malformed request.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","placement","validate"],"host":["https://api.sukuudata.com"],"query":[],"variable":[]}},"response":[{"id":"8d53c1b0-611d-411e-82d1-c45f2219e548","name":"Default Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"choices\": [\n {\n \"csspsCode\": \"nisi incididunt non ullamco\"\n }\n ],\n \"studentGender\": \"MALE\",\n \"home\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.sukuudata.com/api/v1/placement/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"valid\": \"\",\n \"rulesYear\": \"\",\n \"registerYear\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"choice\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"choice\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"choice\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"choice\": \"\"\n }\n ],\n \"summary\": {\n \"total\": \"\",\n \"boarding\": \"\",\n \"day\": \"\",\n \"byCategory\": {\n \"laboris_d\": {\n \"total\": \"\",\n \"boarding\": \"\",\n \"day\": \"\"\n }\n }\n },\n \"choices\": [\n {\n \"choice\": \"\",\n \"school\": {\n \"id\": \"\",\n \"name\": \"\",\n \"csspsCode\": \"\",\n \"category\": \"\",\n \"region\": \"\",\n \"district\": \"\"\n },\n \"programme\": {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n \"residential\": \"\",\n \"distanceKm\": \"\"\n },\n {\n \"choice\": \"\",\n \"school\": {\n \"id\": \"\",\n \"name\": \"\",\n \"csspsCode\": \"\",\n \"category\": \"\",\n \"region\": \"\",\n \"district\": \"\"\n },\n \"programme\": {\n \"code\": \"\",\n \"name\": \"\",\n \"kind\": \"TVET\"\n },\n \"residential\": \"\",\n \"distanceKm\": \"\"\n }\n ]\n }\n}"},{"id":"96a6bdbc-ec0e-4d24-8b53-b30dc4ed239a","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"choices\": [\n {\n \"csspsCode\": \"nisi incididunt non ullamco\"\n }\n ],\n \"studentGender\": \"MALE\",\n \"home\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.sukuudata.com/api/v1/placement/validate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"3c8b212e-7622-45c1-8b68-c8b6ed2abf0f","name":"Missing or invalid API key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"choices\": [\n {\n \"csspsCode\": \"nisi incididunt non ullamco\"\n }\n ],\n \"studentGender\": \"MALE\",\n \"home\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.sukuudata.com/api/v1/placement/validate"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"2067db9d-46ae-489c-b49e-7584537c8cb5","name":"Monthly quota exceeded","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"choices\": [\n {\n \"csspsCode\": \"nisi incididunt non ullamco\"\n }\n ],\n \"studentGender\": \"MALE\",\n \"home\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.sukuudata.com/api/v1/placement/validate"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"2dd2070e-cf66-4bf4-af04-b29c4731f12f"}],"id":"e9289b0e-e9d7-473c-8989-82d0764ed097","description":"

CSSPS school-selection rules and choice validation

\n","_postman_id":"e9289b0e-e9d7-473c-8989-82d0764ed097","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}}},{"name":"Geography","item":[{"name":"List regions","id":"3ed89fcd-c84c-4022-8118-238b2be83b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/regions","description":"

All 16 regions, with the number of active schools in each.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","regions"],"host":["https://api.sukuudata.com"],"query":[],"variable":[]}},"response":[{"id":"46773fa6-a7f9-4101-b2fe-6a03b8b01e73","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/regions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"pcode\": \"\",\n \"schoolCount\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"pcode\": \"\",\n \"schoolCount\": \"\"\n }\n ]\n}"},{"id":"fca20c4c-f03d-4694-9e80-5b1491e4e6de","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/regions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"9b9128eb-8edf-4295-add9-29d2c1923798","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/regions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"1f623322-2cd4-4a48-a399-25647230338d","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/regions"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"3ed89fcd-c84c-4022-8118-238b2be83b12"},{"name":"Get a region","id":"0d53ae16-708a-47b7-af87-816ed7bc74a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/regions/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","regions",":id"],"host":["https://api.sukuudata.com"],"query":[],"variable":[{"id":"5a75d993-a45c-4afc-8081-f081d1dcaf6a","description":{"content":"

(Required) Region id, code, pcode or name

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"30d199c0-d54d-40aa-8bda-d5194f1ec95c","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/regions/:id","host":["https://api.sukuudata.com"],"path":["api","v1","regions",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"pcode\": \"\",\n \"schoolCount\": \"\"\n }\n}"},{"id":"71a1eb8b-6fe6-4abf-a12a-8e047d60e653","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/regions/:id","host":["https://api.sukuudata.com"],"path":["api","v1","regions",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"e24fad44-e586-4d6e-8ba7-46e365ef8d59","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/regions/:id","host":["https://api.sukuudata.com"],"path":["api","v1","regions",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"fc465291-2262-4cd2-a7f4-018b6e081acc","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/regions/:id","host":["https://api.sukuudata.com"],"path":["api","v1","regions",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"47d4ffc6-43ac-4a2a-afb5-895a8cfed6ec","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/regions/:id","host":["https://api.sukuudata.com"],"path":["api","v1","regions",":id"],"variable":[{"key":"id"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"0d53ae16-708a-47b7-af87-816ed7bc74a2"},{"name":"List districts","id":"edcdd3b9-5574-443f-9020-b2c99a382985","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/districts?region=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","districts"],"host":["https://api.sukuudata.com"],"query":[{"description":{"content":"

Only districts in this region (code, pcode or name)

\n","type":"text/plain"},"key":"region","value":""}],"variable":[]}},"response":[{"id":"4d24e1dc-497c-4704-b3cb-2f23f5a960fd","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts?region=","host":["https://api.sukuudata.com"],"path":["api","v1","districts"],"query":[{"description":"Only districts in this region (code, pcode or name)","key":"region","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"pcode\": \"\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"schoolCount\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"pcode\": \"\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"schoolCount\": \"\"\n }\n ]\n}"},{"id":"8cbd104e-c60b-4ca1-9708-d40fc898825a","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts?region=","host":["https://api.sukuudata.com"],"path":["api","v1","districts"],"query":[{"description":"Only districts in this region (code, pcode or name)","key":"region","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"2f984bbe-badb-467e-be13-0c478c6445f5","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts?region=","host":["https://api.sukuudata.com"],"path":["api","v1","districts"],"query":[{"description":"Only districts in this region (code, pcode or name)","key":"region","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"bab9b6e6-42a0-452b-8762-3ea2b1e55113","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts?region=","host":["https://api.sukuudata.com"],"path":["api","v1","districts"],"query":[{"description":"Only districts in this region (code, pcode or name)","key":"region","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"edcdd3b9-5574-443f-9020-b2c99a382985"},{"name":"Get a district","id":"8f026498-8fd2-4a06-94f2-2b8d3351277b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/districts/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","districts",":id"],"host":["https://api.sukuudata.com"],"query":[],"variable":[{"id":"a610311a-411e-48f3-a9fd-fa633ddbbbd2","description":{"content":"

(Required) District id, code, pcode or name

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"dd585773-5b0e-488c-a15c-d7ee3031d14b","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts/:id","host":["https://api.sukuudata.com"],"path":["api","v1","districts",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"pcode\": \"\",\n \"region\": \"\",\n \"regionCode\": \"\",\n \"schoolCount\": \"\"\n }\n}"},{"id":"af95e186-741a-4841-b530-97b677e32e69","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts/:id","host":["https://api.sukuudata.com"],"path":["api","v1","districts",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"7fcf3eb7-c6aa-4e72-b5ff-5d4dd66c6f14","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts/:id","host":["https://api.sukuudata.com"],"path":["api","v1","districts",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"d70efe3a-48a0-450f-b564-1b278c354ccb","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts/:id","host":["https://api.sukuudata.com"],"path":["api","v1","districts",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"cd54f2d8-07e9-49e8-9f7f-959db82fbe71","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/districts/:id","host":["https://api.sukuudata.com"],"path":["api","v1","districts",":id"],"variable":[{"key":"id"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"8f026498-8fd2-4a06-94f2-2b8d3351277b"}],"id":"4c5add76-3cbf-4171-82c1-56c0ca5b7142","description":"

Regions and districts

\n","_postman_id":"4c5add76-3cbf-4171-82c1-56c0ca5b7142","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}}},{"name":"Data","item":[{"name":"School statistics","id":"20a9356f-3063-4ad8-bf3e-cbd8d351311d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/statistics/schools?region=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","statistics","schools"],"host":["https://api.sukuudata.com"],"query":[{"description":{"content":"

Region code, pcode or name

\n","type":"text/plain"},"key":"region","value":""}],"variable":[]}},"response":[{"id":"d9159cd0-e66c-4a05-ac7c-06696c9370f0","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/statistics/schools?region=","host":["https://api.sukuudata.com"],"path":["api","v1","statistics","schools"],"query":[{"description":"Region code, pcode or name","key":"region","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"region\": \"\",\n \"total\": \"\",\n \"public\": \"\",\n \"private\": \"\",\n \"withLocation\": \"\",\n \"byLevel\": {\n \"aliquipba6\": \"\"\n },\n \"placementSchoolsByCategory\": {\n \"adipisicing_0f_\": \"\",\n \"exe\": \"\"\n }\n }\n}"},{"id":"8d4d1fab-5042-42ca-a1a0-0467f9d818f4","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/statistics/schools?region=","host":["https://api.sukuudata.com"],"path":["api","v1","statistics","schools"],"query":[{"description":"Region code, pcode or name","key":"region","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"812a117e-3800-445d-ae48-d26c3ca5a2d4","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/statistics/schools?region=","host":["https://api.sukuudata.com"],"path":["api","v1","statistics","schools"],"query":[{"description":"Region code, pcode or name","key":"region","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"29aeb5ff-3615-445f-9692-68d9fbf78889","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.sukuudata.com/api/v1/statistics/schools?region=","host":["https://api.sukuudata.com"],"path":["api","v1","statistics","schools"],"query":[{"description":"Region code, pcode or name","key":"region","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"20a9356f-3063-4ad8-bf3e-cbd8d351311d"},{"name":"Data sources and completeness","id":"1052f6a5-8279-4eeb-aadc-e3641abecf63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.sukuudata.com/api/v1/data-quality","description":"

Where the data comes from (with licences), when it was last synced, and what share of schools have each field. Check this before relying on a field.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}},"urlObject":{"path":["api","v1","data-quality"],"host":["https://api.sukuudata.com"],"query":[],"variable":[]}},"response":[{"id":"3718973e-a66d-475e-8f80-11c39dfa04e6","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/data-quality"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"schools\": {\n \"active\": \"\",\n \"needsReview\": \"\",\n \"completeness\": {\n \"quic7\": {\n \"count\": \"\",\n \"percent\": \"\"\n }\n }\n },\n \"placementRegister\": {\n \"schools\": \"\",\n \"year\": \"\",\n \"withLocation\": \"\",\n \"rulesYear\": \"\",\n \"outdated\": \"\"\n },\n \"sources\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"licence\": \"\",\n \"records\": \"\",\n \"dataVersion\": \"\",\n \"lastSyncedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"licence\": \"\",\n \"records\": \"\",\n \"dataVersion\": \"\",\n \"lastSyncedAt\": \"\"\n }\n ]\n }\n}"},{"id":"245b197b-d7ec-492d-97ab-3b81aa4d9ae7","name":"Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/data-quality"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"93283932-9255-4e9c-803b-ebda6e0f35aa","name":"Missing or invalid API key","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/data-quality"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"},{"id":"7851c892-a90a-49bd-b2e0-f0c7df13570f","name":"Monthly quota exceeded","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.sukuudata.com/api/v1/data-quality"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"\",\n \"code\": \"\"\n}"}],"_postman_id":"1052f6a5-8279-4eeb-aadc-e3641abecf63"}],"id":"c25b7b1d-79bb-49a7-b056-8e0a6ef9d932","description":"

Statistics, sources and data quality

\n","_postman_id":"c25b7b1d-79bb-49a7-b056-8e0a6ef9d932","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","id":"aa637f93-5ce2-42f3-b2fd-2c795fd46707","name":"SukuuData API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]}},"variable":[{"key":"baseUrl","value":"https://api.sukuudata.com"},{"key":"apiKey","value":"","description":"Your SukuuData key (sukuu_live_...). Get one free at https://sukuudata.com/register"}]}