Get an exact prefix
Good to know. Offline format validation and Google prefixes. No subscriber identity, active-line check, current carrier or physical location.
Read the response
data: The requested results, as an object or an array.
meta: Dataset sources, license and dates. null means unknown or unavailable.
API v2 is the canonical path. Older /api/v1 paths remain compatibility aliases for the currently published behavior, including pagination; no removal date is scheduled.
Response fields 10
[] means each item in a list. null means unknown or unavailable, never zero. The guide language does not translate source values.
dataobjectRequested result: a single object or a list.
data.prefixstringLeading digits of a national-format number, including the zero.
data.international_prefixstringInternational form of the prefix, with +212 replacing the leading zero.
data.maskstringPattern: each X is one remaining digit, for example 06XXXXXXXX.
data.categorystringFacility or prefix category; use the published values.
Accepted values:
"carrier""geographic"data.original_operatorobject | nullOperator associated with the prefix in the source; may differ from the current operator.
data.original_operator.codestringOperator identifier inside an operator object; national prefix inside a phone area.
data.original_operator.namestringResource name, grouped by language where applicable.
data.area_codestring | nullAssociated geographic area prefix, or null.
data.more_specific_prefixesstring[]Longer sub-prefixes providing a more specific match.
Data structure
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"prefix",
"international_prefix",
"mask",
"category",
"original_operator",
"area_code",
"more_specific_prefixes"
],
"properties": {
"prefix": {
"type": "string",
"minLength": 2,
"maxLength": 6,
"pattern": "^0[5-8][0-9]{0,4}$"
},
"international_prefix": {
"type": "string"
},
"mask": {
"type": "string",
"pattern": "^0[0-9]+X+$"
},
"category": {
"enum": [
"carrier",
"geographic"
]
},
"original_operator": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
{
"type": "string",
"nullable": true,
"enum": [
null
]
}
]
},
"area_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"nullable": true,
"enum": [
null
]
}
]
},
"more_specific_prefixes": {
"type": "array",
"items": {
"type": "string",
"minLength": 2,
"maxLength": 6,
"pattern": "^0[5-8][0-9]{0,4}$"
}
}
}
},
"meta": {
"type": "object",
"additionalProperties": false,
"required": [
"dataset",
"total",
"license",
"retrieved_at",
"transformation_version",
"sources"
],
"properties": {
"dataset": {
"enum": [
"numbering-ranges"
]
},
"total": {
"type": "integer",
"minimum": 0
},
"license": {
"enum": [
"Apache-2.0"
]
},
"retrieved_at": {
"type": "string",
"format": "date"
},
"transformation_version": {
"type": "string"
},
"sources": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"dataset",
"producer",
"source_url",
"resource_url",
"license",
"source_updated_at"
],
"properties": {
"dataset": {
"type": "string"
},
"producer": {
"type": "string"
},
"source_url": {
"type": "string",
"format": "uri"
},
"resource_url": {
"type": "string",
"format": "uri"
},
"license": {
"enum": [
"Apache-2.0"
]
},
"source_updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"nullable": true,
"enum": [
null
]
}
]
}
}
}
}
}
}
}
}Sources and pagination 13
metaobjectResult context: sources, dates, license and pagination where applicable.
meta.datasetstringName of the dataset for this result or source.
Accepted values:
"numbering-ranges"meta.totalintegerNumber of matching records before pagination; not the size of this page.
meta.licensestringReuse license. mixed means licenses differ: inspect each source.
Accepted values:
"Apache-2.0"meta.retrieved_atstringDate the project retrieved the source file; not the observation date.
meta.transformation_versionstringVersion of the dataset conversion rules; separate from the API version.
meta.sourcesobject[]Sources used for this result, with their publishers and licenses.
meta.sources[].datasetstringName of the dataset for this result or source.
meta.sources[].producerstringOrganization publishing the original data.
meta.sources[].source_urlstringSource publication or dataset landing page.
meta.sources[].resource_urlstringLink to the actual file or resource used.
meta.sources[].licensestringReuse license. mixed means licenses differ: inspect each source.
Accepted values:
"Apache-2.0"meta.sources[].source_updated_atstring | nullLast update reported by the source; not the retrieval date.
Errors
400: Invalid or missing parameter.404: Resource not found.
Errors return error.code, error.message and error.request_id.
errorobjectDetails of a failed request; replaces data and meta.
error.codestringStable error code, such as RESOURCE_NOT_FOUND; use it in application logic.
error.messagestringHuman-readable error explanation; use code for application logic.
error.request_idstringIdentifier for this request, useful when reporting a problem.