Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: GeoSight Basemap Codelist API
version: v1.0.0
servers:
- url: https://geosight.unicef.org/api/v1
security:
- ApiKey Auth: []
tags:
- name: Codelist
paths:
/sdmx/codelists/indicators/{Version}/{Agency}/{IndicatorCodelist}:
get:
tags:
- Codelist
summary: SDMX published indicators codelist for a given Agency
operationId: Codelist_GetIndicators
parameters:
- name: Version
in: path
required: true
description: The version of the codelist (e.g. 1.3). Only 1 decimal digit is allowed
schema:
type: number
format: decimal
- name: Agency
in: path
required: true
description: The name of the agency used to filter indicators (e.g. UNICEF). This is the agency owner of the indicator. Indicators borrowed by other agencies are not returned by this method
schema:
type: string
- name: IndicatorCodelist
in: path
required: true
description: The name of the SDMX indicator codelist associated to the agency (e.g. CL_UNICEF_INDICATOR)
schema:
type: string
responses:
'406':
description: Input version has more than 1 decimal digit
content:
application/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
/sdmx/codelists/domains/{Version}/{Agency}/{Codelist}:
get:
tags:
- Codelist
summary: Support the agency / sector / domain / subdomain as an SDMX category scheme
operationId: Codelist_GetDomains
parameters:
- name: Version
in: path
required: true
description: The version of the category scheme (e.g. 1.3). Only 1 decimal digit is allowed
schema:
type: number
format: decimal
- name: Agency
in: path
required: true
description: The name of the agency used to filter domains (e.g. UNICEF). This is the agency owner of the indicator. Indicators borrowed by other agencies are not returned by this method
schema:
type: string
- name: Codelist
in: path
required: true
description: The name of the codelist associated to the agency (e.g. CS_UNICEF)
schema:
type: string
responses:
'406':
description: Input version has more than 1 decimal digit
content:
application/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
/sdmx/codelists/countries/{version}:
get:
tags:
- Codelist
summary: SDMX Country Codelist (only published countries)
operationId: Codelist_GetCountries
parameters:
- name: version
in: path
required: true
description: A decimal expressing the version of the codelist. e.g. 1.0. Only 1 decimal digit is allowed
schema:
type: number
format: decimal
responses:
'406':
description: Input version has more than 1 decimal digit
content:
application/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
/sdmx/codelists/regions/{version}:
get:
tags:
- Codelist
summary: SDMX Regions Codelist
operationId: Codelist_GetRegions
parameters:
- name: version
in: path
required: true
description: A decimal expressing the version of the codelist. e.g. 1.0. Only 1 decimal digit is allowed
schema:
type: number
format: decimal
responses:
'406':
description: Input version has more than 1 decimal digit
content:
application/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
components:
schemas:
ProblemDetails:
type: object
additionalProperties: {}
required:
- extensions
properties:
type:
type: string
title:
type: string
status:
type: integer
format: int32
detail:
type: string
instance:
type: string
extensions:
type: object
additionalProperties: {}
securitySchemes:
ApiKey_Auth:
type: apiKey
in: header
name: Authorization