CLEAR Global's Language Use Data Platform API contains curated data on language use from across the world. Data is gathered from various public sources, then standardised, aggregated and assesed, providing the best available data for a given location.
\nData is available at three levels of geographic aggregation: Country (also known as Admin 0), Province/State (Admin 1) and District/City (Admin 2).
\nCurrently data is provided for 'Main language used at home', as a proportion of the population of a location and as a 'rank' i.e. the nth most commonly spoken language in that location. Original sources may list this as 'Primary language' or 'Mother tongue' or other similar terms. Additional indicators such as second or third languages will be added in future updates.
\nData can be retrieved along 2 dimensions as follows:
\nLocations: data about languages spoken in a given location via the Get data by location endpoint.
\nLanguages: data about the locations in which a given language is spoken via the via the Get data by language endpoint.
\nBoth endpoints also return metadata about languages, locations and data sources.
\nData is aligned where possible to standard classifications for locations and languages.
\nLocations are aligned to the UNOCHA Common Operational Datasets and use P-Codes as the primary identifier for locations, where available.
\nLanguages are aligned to Glottolog and use the Glottocode as the primary identifier.
\nLanguages and locations not found in those classifications will be given a unique id within the Language Use Data Platform. All identifiers in the system, including those from external classification systems above and those unique to this platform can be retrieved using the Get locations and Get languages endpoints below.
\nResults are paginated and can be accessed using the page and page_size parameters.
No authorisation is required to access the data.
\nAbout for more information about the CLEAR Global Language Use Data Platform, including how the data is collected and processed.
\nVisualizations for an interactive dashboard of the data.
\nThe CLEAR Global website to find out more about CLEAR Global.
\nRetrieve language use data for one or more locations.
\nThe response will be a JSON object an array of items representing languages spoken in the locations requested with the following schema:
\n{\n \"status\": 200,\n \"reasons\": \"OK\",\n \"data\": [\n {\n \"proportion_value\": <float>,\n \"language_rank\": <int>,\n \"language_name\": <string>,\n \"language_code\": <string>,\n \"location_name\": <string>,\n \"location_code\": <string>,\n \"location_level\": <int>,\n \"dataset_name\": <string>,\n \"url\": <string>,\n \"source\": <string>,\n \"datetime_published\": <string>,\n \"reliability_score\": <float>\n }\n ]\n}\n\n(Optional) Page number to return. from 0 to N. Default: 0.
\n","type":"text/plain"},"key":"page","value":"(Optional) Number of records returned per pages. Default: 100. Max: 500.
\n","type":"text/plain"},"key":"page_size","value":"(Optional) The fields to be returned. Available fields are: proportion_value, language_rank, language_name, language_code, location_name, location_code, location_level, geojson, dataset_name, url,source, datetime_published, reliability_score. Default: all fields.
\n","type":"text/plain"},"key":"fields","value":"(Optional) The geographic aggregation level to be returned as a value between 0 and 2 - representing Admin0 (Country level), Admin1 (Province/State), Admin2 (District/City). Defaults to the level of the location_id provided.
\n","type":"text/plain"},"key":"aggregation","value":"(Optional) Filter the returned records by one or more language codes.
\n","type":"text/plain"},"key":"language_code","value":"(Optional) Type of output returned. Can be geojson or json. If omitted defaults to json.
\n","type":"text/plain"},"key":"output","value":"(Required) The code of the location or locations requested. Location codes are P-Codes, as per OCHA Common Operational Datasets. Multiple location codes can be requested separated by commas.
\n","type":"text/plain"},"type":"any","value":"Retrieve location names and codes. Used to identify necessary codes for the data by location or data by language endpoints.
\nThe response will be a JSON object with the following schema:
\n{\n \"status\": 200,\n \"reasons\": \"OK\",\n \"data\": [\n {\n \"location_id\": <int>,\n \"location_name\": <string>,\n \"location_code\": <string>,\n \"location_level\": <int>\n }\n ]\n}\n\n(Optional) Page number to return. from 0 to N. Default: 0.
\n","type":"text/plain"},"key":"page","value":"(Optional) Number of records returned per pages. Default: 100. Max: 500.
\n","type":"text/plain"},"key":"page_size","value":"(Optional) The fields to be returned. Available fields are: location_name, location_code, location_level. Default: all fields.
\n","type":"text/plain"},"key":"fields","value":"(Optional) Filter the returned records with conditions. A list of condition can be represented as follows: [[\"fieldname\", \"operator\", VALUE], [\"fieldname\", \"operator\", VALUE], ...] Any conditions are viable as long as:
\nRetrieve location names and codes. Used to identify necessary codes for the data by location or data by language endpoints.
\nThe response will be a JSON object with the following schema:
\n{\n \"status\": 200,\n \"reasons\": \"OK\",\n \"data\": [\n {\n \"location_id\": <int>,\n \"location_name\": <string>,\n \"location_code\": <string>,\n \"location_level\": <int>\n }\n ]\n}\n\n(Optional) Page number to return. from 0 to N. Default: 0.
\n","type":"text/plain"},"key":"page","value":"(Optional) Number of records returned per pages. Default: 100. Max: 500.
\n","type":"text/plain"},"key":"page_size","value":"(Optional) The fields to be returned. Available fields are: location_name, location_code, location_level. Default: all fields.
\n","type":"text/plain"},"key":"fields","value":"Retrieve data about one or more locations and the languages used there.
\n","_postman_id":"012efde4-da79-4d07-864a-8263c1994878"},{"name":"By Language","item":[{"name":"Get data for a language","id":"37bd3427-8fa2-406e-9101-f40bda4b532e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"ludp.clearglobal.org/public/language/:language_code?page=Retrieve language use data for a language or languages.
\nThe response will be a JSON object an array of items representing locations in which the language requested is spoken with the following schema:
\n{\n \"status\": 200,\n \"reasons\": \"OK\",\n \"data\": [\n {\n \"proportion_value\": <float>,\n \"language_rank\": <int>,\n \"language_name\": <string>,\n \"language_code\": <string>,\n \"location_name\": <string>,\n \"location_code\": <string>,\n \"location_level\": <int>,\n \"dataset_name\": <string>,\n \"url\": <string>,\n \"source\": <string>,\n \"datetime_published\": <string>,\n \"reliability_score\": <float>\n }\n ]\n}\n\n(Optional) Page number to return. from 0 to N. Default: 0.
\n","type":"text/plain"},"key":"page","value":"(Optional) Number of records returned per pages. Default: 100. Max: 500.
\n","type":"text/plain"},"key":"page_size","value":"(Optional) The fields to be returned. Available fields are: proportion_value, language_rank, language_name, language_code, location_name, location_code, location_level, dataset_name, url,source, datetime_published, reliability_score. Default: all fields.
\n","type":"text/plain"},"key":"fields","value":"(Optional) Filter the returned records by one or more location codes.
\n","type":"text/plain"},"key":"location_code","value":"(Optional) Type of output returned. Can be geojson or json. If omitted defaults to json.
\n","type":"text/plain"},"key":"output","value":"(Required) The code of the language or languages requested. Language codes are glottocode as per Glottolog. Multiple language codes can be requested separated by commas.
\n","type":"text/plain"},"type":"any","value":"","key":"language_code"}]}},"response":[{"id":"e657cae1-99ad-4d30-8bc5-3f8bb6a0d211","name":"Get data for Hassaniyya (hass1238)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","disabled":true}],"url":{"raw":"ludp.clearglobal.org/public/language/:language_code?page=0&page_size=10&fields=proportion_value, language_rank, language_name, language_code, location_name, location_code, location_level, dataset_name, url,source, datetime_published, reliability_score","host":["ludp.clearglobal.org/public"],"path":["language",":language_code"],"query":[{"key":"page","value":"0","description":"(Optional) Page number to return. from 0 to N. Default: 0."},{"key":"page_size","value":"10","description":"(Optional) Number of records returned per pages. Default: 100. Max: 500."},{"key":"fields","value":"proportion_value, language_rank, language_name, language_code, location_name, location_code, location_level, dataset_name, url,source, datetime_published, reliability_score","description":"(Optional) The fields to be returned. Available fields are: proportion_value, language_rank, language_name, language_code, location_name, location_code, location_level, dataset_name, url,source, datetime_published, reliability_score. Default: all fields."},{"key":"location_code","value":"Retrieve language names and codes. Used to identify necessary codes for the data by location or data by language endpoints.
\nThe response will be a JSON object with the following schema:
\n{\n \"status\": 200,\n \"reasons\": \"OK\",\n \"data\": [\n {\n \"language_id\": <int>,\n \"language_name\": <string>,\n \"language_code\": <string>\n }\n ]\n}\n\n(Optional) Page number to return. from 0 to N. Default: 0.
\n","type":"text/plain"},"key":"page","value":"(Optional) Number of records returned per pages. Default: 100. Max: 500.
\n","type":"text/plain"},"key":"page_size","value":"(Optional) The fields to be returned. Available fields are: location_name, location_code, location_level. Default: all fields.
\n","type":"text/plain"},"key":"fields","value":"(Optional) Filter the returned records with conditions. A list of condition can be represented as follows: [[\"fieldname\", \"operator\", VALUE], [\"fieldname\", \"operator\", VALUE], ...] Any conditions are viable as long as:
\nRetrieve language names and codes. Used to identify necessary codes for the data by location or data by language endpoints.
\nThe response will be a JSON object with the following schema:
\n{\n \"status\": 200,\n \"reasons\": \"OK\",\n \"data\": [\n {\n \"language_id\": <int>,\n \"language_name\": <string>,\n \"language_code\": <string>\n }\n ]\n}\n\n(Optional) Page number to return. from 0 to N. Default: 0.
\n","type":"text/plain"},"key":"page","value":"(Optional) Number of records returned per pages. Default: 100. Max: 500.
\n","type":"text/plain"},"key":"page_size","value":"(Optional) The fields to be returned. Available fields are: language_code, language_name. Default: all fields.
\n","type":"text/plain"},"key":"fields","value":"Retrieve data about one or more languages and the locations it is used in.
\n","_postman_id":"e56623dc-cf48-4bbf-be0e-4d7d2e8670b7"}],"event":[{"listen":"prerequest","script":{"id":"c9171400-7e31-4c63-aef8-aacb120cefc8","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"13f2a0df-fe1b-4791-8551-3e501240330a","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"ludp.clearglobal.org/public"}]}