通过

军械调查地点 （预览版）

OS Places API 提供地址及其生命周期的详细视图。 它包含 AddressBase Premium 的所有记录，因此提供与创建到停用的地址或属性相关的所有信息。 它包含地方当局、军械调查和皇家邮件地址、当前地址和当前地址、临时地址（如规划发展）和历史信息。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name 弹药调查
URL https://www.ordnancesurvey.co.uk/business-government
Email technicalservices@os.uk
连接器元数据
发布者 弹药调查
网站 https://www.ordnancesurvey.co.uk/business-government
隐私策略 https://www.ordnancesurvey.co.uk/governance/policies/privacy
类别 数据;商业智能

军械调查地点允许用户准确识别地址。 搜索询问地方当局和皇家邮件地址数据集。

可以使用完整或部分地址、邮政编码或唯一属性 ID 发出请求。 搜索还可以查找离给定点最近的地址或用户定义的区域或圆圈内已知的所有地址。

先决条件

OS Places API 需要具有军械调查的活动许可证。 客户必须注册免费试用版，或高级订阅才能生成访问密钥所需的 API 连接器登录。

如何获取凭据

若要了解有关订阅地点选项的详细信息，请在此处联系 Ordnance Survey： https://developer.ordnancesurvey.co.uk/content/contact-us

连接器入门

可在此处找到 API 文档 https://apidocs.os.uk/docs/os-places-overview

我们的入门指南介绍如何使用 Ordnance Survey 的 Places 连接器在电源平台中构建应用，可在此处找到： https://github.com/OrdnanceSurvey/OS-Places-MS-Power-Platform-Connector

  • 在 Power Apps 中执行自由文本地址搜索：可以通过向简单画布添加文本框和按钮来完成此作。 通过将按钮的 OnSelect 设置为：

    设置 （searchResults， OSPlaces.Find （“搜索栏”。Text.results） & UpdateContext（{NoSearch： true}）

    搜索栏中的结果可以发送到 OSPlaces.Find 定义，结果存储在名为 searchResults 的变量中。 该变量可以显示为画布中的库或数据表。

    此方法适用于 Find、Postcode、UPRN 和坐标定义，是开始使用连接器的好方法。

已知问题和限制

Match 和 Cleanse 资源不是此连接器的一部分，因为此连接器已设计为地址查询工具，而不是 Power Platform 中的数据库清理工具。

FAQ

如果对此连接器有任何疑问，请参阅我们的常见问题解答： https://developer.ordnancesurvey.co.uk/os-apis-developer-portal-faqs

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
API 密钥 securestring 此 API 的 API 密钥 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

UPRN作

采用唯一属性引用编号（UPRN）作为搜索参数的搜索。
半径作

将一对坐标作为圆的中心，并返回与圆相交的所有地址。
多边形作

采用 geoJSON 多边形或多多边形对象的 POST 请求，并返回对象中的所有地址。
最近的作

采用一对坐标（X 和 Y）作为输入来确定最接近的地址。
查找作

一种专为快速使用而设计的免费文本搜索，例如表单填充。
边界框作

获取两个点并创建边界框。 然后返回此边界框中的所有地址。
邮政编码作

基于属性的邮政编码进行搜索。 资源的最低值为区域和地区，例如 SO16，将接受由区域、地区、部门和单位组成的完整邮政编码，例如 SO16 0AS

UPRN作

操作 ID:
UPRN

采用唯一属性引用编号（UPRN）作为搜索参数的搜索。

参数

名称 密钥 必需 类型 说明
有效的 UPRN
 uprn True integer

唯一属性引用编号格式的整数 （UPRN）
结果格式
 format string

将返回响应的格式。 默认值：JSON。 接受的值：JSON、XML
地方当局（LPI）和/或皇家邮件（DPA）地址结果
 dataset string

要返回的地址数据集。 可以发送多个值，用逗号分隔。 默认值：DPA。 接受的值：DPA、LPI
语言
 lr string

要返回的地址语言。 有效语言为英语和威尔士语。 筛选器仅适用于 DPA 数据集。 默认值为两种语言。 默认值：EN、CY。
过滤器
 fq string

允许按分类代码和/或逻辑状态代码筛选结果的筛选器。 筛选分类代码将接受通配符 \ 搜索。 可以对分类代码使用空格分离分类代码参数执行多个搜索。 可以使用参数多次运行分类代码筛选器：fq=classification_code：CI classification_code：RD&fq=LOGICAL_STATUS_CODE：6”
输出空间引用系统
 output_srs string

预期的输出空间引用系统。 默认值：EPSG：27700。 接受的值：BNG、EPSG：27700、WGS84、EPSG：4326、EPSG：3857、EPSG：4258

返回

名称 路径 类型 说明
uri
 header.uri string

uri
查询
 header.query string

查询
偏移
 header.offset integer

偏移
totalresults
 header.totalresults integer

totalresults
格式
 header.format string

格式
数据集
 header.dataset string

数据集
lr
 header.lr string

lr
maxresults
 header.maxresults integer

maxresults
matchprecision
 header.matchprecision integer

matchprecision
时代
 header.epoch string

时代
output_srs
 header.output_srs string

output_srs
results
 results array of object

results
UPRN
 results.DPA.UPRN string

UPRN
地址
 results.DPA.ADDRESS string

地址
ORGANISATION_NAME
 results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME
BUILDING_NUMBER
 results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER
THOROUGHFARE_NAME
 results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME
DEPENDENT_LOCALITY
 results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY
POST_TOWN
 results.DPA.POST_TOWN string

POST_TOWN
邮政编码
 results.DPA.POSTCODE string

邮政编码
RPC
 results.DPA.RPC string

RPC
X_COORDINATE
 results.DPA.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.DPA.Y_COORDINATE float

Y_COORDINATE
地位
 results.DPA.STATUS string

地位
LOGICAL_STATUS_CODE
 results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE
 results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE
BLPU_STATE_CODE_DESCRIPTION
 results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.DPA.ENTRY_DATE string

ENTRY_DATE
BLPU_STATE_DATE
 results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE
LANGUAGE
 results.DPA.LANGUAGE string

LANGUAGE
MATCH
 results.DPA.MATCH float

MATCH
MATCH_DESCRIPTION
 results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION
UPRN
 results.LPI.UPRN string

UPRN
地址
 results.LPI.ADDRESS string

地址
USRN
 results.LPI.USRN string

USRN
LPI_KEY
 results.LPI.LPI_KEY string

LPI_KEY
PAO_START_NUMBER
 results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER
STREET_DESCRIPTION
 results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION
TOWN_NAME
 results.LPI.TOWN_NAME string

TOWN_NAME
ADMINISTRATIVE_AREA
 results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA
POSTCODE_LOCATOR
 results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR
RPC
 results.LPI.RPC string

RPC
X_COORDINATE
 results.LPI.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.LPI.Y_COORDINATE float

Y_COORDINATE
地位
 results.LPI.STATUS string

地位
LOGICAL_STATUS_CODE
 results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE_DESCRIPTION
 results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.LPI.ENTRY_DATE string

ENTRY_DATE
STREET_STATE_CODE
 results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE
STREET_STATE_CODE_DESCRIPTION
 results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION
STREET_CLASSIFICATION_CODE
 results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE
STREET_CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION
LPI_LOGICAL_STATUS_CODE
 results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
 results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
LANGUAGE
 results.LPI.LANGUAGE string

LANGUAGE
MATCH
 results.LPI.MATCH float

MATCH
MATCH_DESCRIPTION
 results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

半径作

操作 ID:
Radius

将一对坐标作为圆的中心，并返回与圆相交的所有地址。

参数

名称 密钥 必需 类型 说明
一组逗号分隔坐标
 point True string

BNG 中一个逗号分隔的坐标集，指定搜索圆中心处的坐标。 坐标的精度是两个小数位数（即 1 厘米精度）。
搜索半径
 radius integer

在米内搜索的半径。 最大半径为 1,000 米。 如果上面显示错误消息，则返回一条错误消息。 距离的精度是两个小数位数（即 1 厘米精度）。 默认值：100。 接受的值：0.01 - 1000
结果格式
 format string

将返回响应的格式。 默认值：JSON。 接受的值 JSON、XML
限制结果
 maxresults integer

要返回的最大结果数。 默认值：100
偏移结果
 offset integer

偏移此金额返回的列表。
地方当局（LPI）和/或皇家邮件（DPA）地址结果
 dataset string

要返回的地址数据集。 可以发送多个值，用逗号分隔。 默认值：DPA。 接受的值：DPA、LPI
语言
 lr string

要返回的地址语言。 有效语言为英语和威尔士语。 筛选器仅适用于 DPA 数据集。 默认值为两种语言。 默认值：EN、CY
过滤器
 fq string

允许按分类代码和/或逻辑状态代码筛选结果的筛选器。 筛选分类代码将接受通配符 \ 搜索。 可以对分类代码使用空格分离分类代码参数执行多个搜索。 可以使用参数多次运行分类代码筛选器：fq=classification_code：CI classification_code：RD&fq=LOGICAL_STATUS_CODE：6
输出空间引用系统
 output_srs string

预期的输出空间引用系统。 默认值：EPSG：27700。 接受的值：“BNG”、“EPSG：27700”、“WGS84”、“EPSG：4326”、“EPSG：3857”、“EPSG：4258”
输入空间引用系统
 srs string

输入坐标集的空间引用系统。 接受的值：“BNG”、“EPSG：27700”、“WGS84”、“EPSG：4326”、“EPSG：3857”、“EPSG：4258”

返回

名称 路径 类型 说明
uri
 header.uri string

uri
查询
 header.query string

查询
偏移
 header.offset integer

偏移
totalresults
 header.totalresults integer

totalresults
格式
 header.format string

格式
数据集
 header.dataset string

数据集
lr
 header.lr string

lr
maxresults
 header.maxresults integer

maxresults
matchprecision
 header.matchprecision integer

matchprecision
时代
 header.epoch string

时代
output_srs
 header.output_srs string

output_srs
results
 results array of object

results
UPRN
 results.DPA.UPRN string

UPRN
地址
 results.DPA.ADDRESS string

地址
ORGANISATION_NAME
 results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME
BUILDING_NUMBER
 results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER
THOROUGHFARE_NAME
 results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME
DEPENDENT_LOCALITY
 results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY
POST_TOWN
 results.DPA.POST_TOWN string

POST_TOWN
邮政编码
 results.DPA.POSTCODE string

邮政编码
RPC
 results.DPA.RPC string

RPC
X_COORDINATE
 results.DPA.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.DPA.Y_COORDINATE float

Y_COORDINATE
地位
 results.DPA.STATUS string

地位
LOGICAL_STATUS_CODE
 results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE
 results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE
BLPU_STATE_CODE_DESCRIPTION
 results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.DPA.ENTRY_DATE string

ENTRY_DATE
BLPU_STATE_DATE
 results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE
LANGUAGE
 results.DPA.LANGUAGE string

LANGUAGE
MATCH
 results.DPA.MATCH float

MATCH
MATCH_DESCRIPTION
 results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION
UPRN
 results.LPI.UPRN string

UPRN
地址
 results.LPI.ADDRESS string

地址
USRN
 results.LPI.USRN string

USRN
LPI_KEY
 results.LPI.LPI_KEY string

LPI_KEY
PAO_START_NUMBER
 results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER
STREET_DESCRIPTION
 results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION
TOWN_NAME
 results.LPI.TOWN_NAME string

TOWN_NAME
ADMINISTRATIVE_AREA
 results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA
POSTCODE_LOCATOR
 results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR
RPC
 results.LPI.RPC string

RPC
X_COORDINATE
 results.LPI.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.LPI.Y_COORDINATE float

Y_COORDINATE
地位
 results.LPI.STATUS string

地位
LOGICAL_STATUS_CODE
 results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE_DESCRIPTION
 results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.LPI.ENTRY_DATE string

ENTRY_DATE
STREET_STATE_CODE
 results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE
STREET_STATE_CODE_DESCRIPTION
 results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION
STREET_CLASSIFICATION_CODE
 results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE
STREET_CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION
LPI_LOGICAL_STATUS_CODE
 results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
 results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
LANGUAGE
 results.LPI.LANGUAGE string

LANGUAGE
MATCH
 results.LPI.MATCH float

MATCH
MATCH_DESCRIPTION
 results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

多边形作

操作 ID:
Polygon

采用 geoJSON 多边形或多多边形对象的 POST 请求，并返回对象中的所有地址。

参数

名称 密钥 必需 类型 说明
参考点
 referencepoint integer

引用点几何图形是计算距离值的基础。 仅当指定了参数时，输出才按给定引用点的升序距离进行排序。
限制结果
 maxresults integer

要返回的最大结果数。 默认值：100
地方当局（LPI）和/或皇家邮件（DPA）地址结果
 dataset string

要返回的地址数据集。 可以发送多个值，用逗号分隔。 默认值：DPA。 接受的值：DPA、LPI
偏移结果
 offset integer

偏移此金额返回的列表。
语言
 lr string

要返回的地址语言。 有效语言为英语和威尔士语。 筛选器仅适用于 DPA 数据集。 默认值为两种语言。 默认值：EN、CY。
过滤器
 fq string

允许按分类代码和/或逻辑状态代码筛选结果的筛选器。 筛选分类代码将接受通配符 \ 搜索。 可以对分类代码使用空格分离分类代码参数执行多个搜索。 可以使用参数多次运行分类代码筛选器：fq=classification_code：CI classification_code：RD&fq=LOGICAL_STATUS_CODE：6
输出空间引用系统
 output_srs string

预期的输出空间引用系统。 默认值：EPSG：27700。 接受的值：“BNG”、“EPSG：27700”、“WGS84”、“EPSG：4326”、“EPSG：3857”、“EPSG：4258”
输入坐标参考系统
 srs string

输入坐标集的空间引用系统。
Content-Type
 Content-type True string

Content-Type 标头。 接受的值：“application/json”
类型
 type True string

geoJSON 多边形的第一个 name：value 对。 接受的值：功能
几何
 geometry True string

此处放置多边形对象的位置。 接受的值：多边形对象

返回

名称 路径 类型 说明
uri
 header.uri string

uri
查询
 header.query string

查询
偏移
 header.offset integer

偏移
totalresults
 header.totalresults integer

totalresults
格式
 header.format string

格式
数据集
 header.dataset string

数据集
lr
 header.lr string

lr
maxresults
 header.maxresults integer

maxresults
matchprecision
 header.matchprecision integer

matchprecision
时代
 header.epoch string

时代
output_srs
 header.output_srs string

output_srs
results
 results array of object

results
UPRN
 results.DPA.UPRN string

UPRN
地址
 results.DPA.ADDRESS string

地址
ORGANISATION_NAME
 results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME
BUILDING_NUMBER
 results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER
THOROUGHFARE_NAME
 results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME
DEPENDENT_LOCALITY
 results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY
POST_TOWN
 results.DPA.POST_TOWN string

POST_TOWN
邮政编码
 results.DPA.POSTCODE string

邮政编码
RPC
 results.DPA.RPC string

RPC
X_COORDINATE
 results.DPA.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.DPA.Y_COORDINATE float

Y_COORDINATE
地位
 results.DPA.STATUS string

地位
LOGICAL_STATUS_CODE
 results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE
 results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE
BLPU_STATE_CODE_DESCRIPTION
 results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.DPA.ENTRY_DATE string

ENTRY_DATE
BLPU_STATE_DATE
 results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE
LANGUAGE
 results.DPA.LANGUAGE string

LANGUAGE
MATCH
 results.DPA.MATCH float

MATCH
MATCH_DESCRIPTION
 results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION
UPRN
 results.LPI.UPRN string

UPRN
地址
 results.LPI.ADDRESS string

地址
USRN
 results.LPI.USRN string

USRN
LPI_KEY
 results.LPI.LPI_KEY string

LPI_KEY
PAO_START_NUMBER
 results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER
STREET_DESCRIPTION
 results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION
TOWN_NAME
 results.LPI.TOWN_NAME string

TOWN_NAME
ADMINISTRATIVE_AREA
 results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA
POSTCODE_LOCATOR
 results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR
RPC
 results.LPI.RPC string

RPC
X_COORDINATE
 results.LPI.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.LPI.Y_COORDINATE float

Y_COORDINATE
地位
 results.LPI.STATUS string

地位
LOGICAL_STATUS_CODE
 results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE_DESCRIPTION
 results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.LPI.ENTRY_DATE string

ENTRY_DATE
STREET_STATE_CODE
 results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE
STREET_STATE_CODE_DESCRIPTION
 results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION
STREET_CLASSIFICATION_CODE
 results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE
STREET_CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION
LPI_LOGICAL_STATUS_CODE
 results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
 results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
LANGUAGE
 results.LPI.LANGUAGE string

LANGUAGE
MATCH
 results.LPI.MATCH float

MATCH
MATCH_DESCRIPTION
 results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

最近的作

操作 ID:
Nearest

采用一对坐标（X 和 Y）作为输入来确定最接近的地址。

参数

名称 密钥 必需 类型 说明
一组逗号分隔坐标
 point True string

一个逗号分隔的坐标集，指定应找到直线中最接近记录的坐标。 搜索将尝试的最大距离为 1,000 米。 坐标的精度是两个小数位数（即 1 厘米精度）。
搜索半径
 radius integer

要在其中搜索的半径（以米为单位）。 最高为1000米。 如果半径超过该数量，则会返回错误消息（请参阅下文）。 距离的精度是两个小数位数（即 1 厘米精度）。 默认值：100。
结果格式
 format string

将返回响应的格式。 默认值：JSON。 接受的值：JSON、XML
地方当局（LPI）和/或皇家邮件（DPA）地址结果
 dataset string

要返回的地址数据集。 可以发送多个值，用逗号分隔。 默认值：DPA。 接受的值：DPA、LPI
语言
 lr string

要返回的地址语言。 有效语言为英语和威尔士语。 筛选器仅适用于 DPA 数据集。 默认值为两种语言。 默认值：EN、CY
过滤器
 fq string

允许按分类代码和/或逻辑状态代码筛选结果的筛选器。 筛选分类代码将接受通配符 \ 搜索。 可以对分类代码使用空格分离分类代码参数执行多个搜索。 可以使用参数多次运行分类代码筛选器：fq=classification_code：CI classification_code：RD&fq=LOGICAL_STATUS_CODE：6
输出空间引用系统
 output_srs string

预期的输出空间引用系统。 默认值：EPSG：27700。 接受的值：BNG、EPSG：27700、WGS84、EPSG：4326、EPSG：3857、EPSG：4258
输入空间引用系统
 srs string

输入坐标集的空间引用系统。 接受的值：“BNG”、“EPSG：27700”、“WGS84”、“EPSG：4326”、“EPSG：3857”、“EPSG：4258”

返回

名称 路径 类型 说明
uri
 header.uri string

uri
查询
 header.query string

查询
偏移
 header.offset integer

偏移
totalresults
 header.totalresults integer

totalresults
格式
 header.format string

格式
数据集
 header.dataset string

数据集
lr
 header.lr string

lr
maxresults
 header.maxresults integer

maxresults
matchprecision
 header.matchprecision integer

matchprecision
时代
 header.epoch string

时代
output_srs
 header.output_srs string

output_srs
results
 results array of object

results
UPRN
 results.DPA.UPRN string

UPRN
地址
 results.DPA.ADDRESS string

地址
ORGANISATION_NAME
 results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME
BUILDING_NUMBER
 results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER
THOROUGHFARE_NAME
 results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME
DEPENDENT_LOCALITY
 results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY
POST_TOWN
 results.DPA.POST_TOWN string

POST_TOWN
邮政编码
 results.DPA.POSTCODE string

邮政编码
RPC
 results.DPA.RPC string

RPC
X_COORDINATE
 results.DPA.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.DPA.Y_COORDINATE float

Y_COORDINATE
地位
 results.DPA.STATUS string

地位
LOGICAL_STATUS_CODE
 results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE
 results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE
BLPU_STATE_CODE_DESCRIPTION
 results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.DPA.ENTRY_DATE string

ENTRY_DATE
BLPU_STATE_DATE
 results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE
LANGUAGE
 results.DPA.LANGUAGE string

LANGUAGE
MATCH
 results.DPA.MATCH float

MATCH
MATCH_DESCRIPTION
 results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION
UPRN
 results.LPI.UPRN string

UPRN
地址
 results.LPI.ADDRESS string

地址
USRN
 results.LPI.USRN string

USRN
LPI_KEY
 results.LPI.LPI_KEY string

LPI_KEY
PAO_START_NUMBER
 results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER
STREET_DESCRIPTION
 results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION
TOWN_NAME
 results.LPI.TOWN_NAME string

TOWN_NAME
ADMINISTRATIVE_AREA
 results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA
POSTCODE_LOCATOR
 results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR
RPC
 results.LPI.RPC string

RPC
X_COORDINATE
 results.LPI.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.LPI.Y_COORDINATE float

Y_COORDINATE
地位
 results.LPI.STATUS string

地位
LOGICAL_STATUS_CODE
 results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE_DESCRIPTION
 results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.LPI.ENTRY_DATE string

ENTRY_DATE
STREET_STATE_CODE
 results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE
STREET_STATE_CODE_DESCRIPTION
 results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION
STREET_CLASSIFICATION_CODE
 results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE
STREET_CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION
LPI_LOGICAL_STATUS_CODE
 results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
 results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
LANGUAGE
 results.LPI.LANGUAGE string

LANGUAGE
MATCH
 results.LPI.MATCH float

MATCH
MATCH_DESCRIPTION
 results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

查找作

操作 ID:
Find

一种专为快速使用而设计的免费文本搜索，例如表单填充。

参数

名称 密钥 必需 类型 说明
地址查询。
 query True string

自由文本搜索参数。
结果格式
 format string

将返回响应的格式。 默认值：JSON。 接受的值：“JSON”、“XML”
限制结果
 maxresults integer

要返回的最大结果数。 默认值：100
偏移结果
 offset integer

偏移此金额返回的列表。
地方当局（LPI）和/或皇家邮件（DPA）地址结果
 dataset string

要返回的地址数据集。 可以发送多个值，用逗号分隔。 默认值：DPA。 接受的值：DPA、LPI
语言
 lr string

要返回的地址语言。 有效语言为英语和威尔士语。 筛选器仅适用于 DPA 数据集。 默认值为两种语言。 默认值：EN、CY。
根据地址匹配分数限制结果
 minmatch number

必须返回结果的最小匹配分数。 接受的值：0.1 - 1.0（含）
匹配分数精度
 matchprecision integer

要截断匹配分数值的十进制点位置。 接受的值：1-10
过滤器
 fq string

允许按分类代码和/或逻辑状态代码筛选结果的筛选器。 筛选分类代码将接受通配符 \ 搜索。 可以对分类代码使用空格分离分类代码参数执行多个搜索。 可以使用参数多次运行分类代码筛选器：fq=classification_code：CI classification_code：RD&fq=LOGICAL_STATUS_CODE：6
输出空间引用系统
 output_srs string

预期的输出空间引用系统。 默认值：EPSG：27700。 接受的值：BNG、EPSG：27700、WGS84、EPSG：4326、EPSG：3857、EPSG：4258

返回

名称 路径 类型 说明
uri
 header.uri string

uri
查询
 header.query string

查询
偏移
 header.offset integer

偏移
totalresults
 header.totalresults integer

totalresults
格式
 header.format string

格式
数据集
 header.dataset string

数据集
lr
 header.lr string

lr
maxresults
 header.maxresults integer

maxresults
matchprecision
 header.matchprecision integer

matchprecision
时代
 header.epoch string

时代
output_srs
 header.output_srs string

output_srs
results
 results array of object

results
UPRN
 results.DPA.UPRN string

UPRN
地址
 results.DPA.ADDRESS string

地址
ORGANISATION_NAME
 results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME
BUILDING_NUMBER
 results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER
THOROUGHFARE_NAME
 results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME
DEPENDENT_LOCALITY
 results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY
POST_TOWN
 results.DPA.POST_TOWN string

POST_TOWN
邮政编码
 results.DPA.POSTCODE string

邮政编码
RPC
 results.DPA.RPC string

RPC
X_COORDINATE
 results.DPA.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.DPA.Y_COORDINATE float

Y_COORDINATE
地位
 results.DPA.STATUS string

地位
LOGICAL_STATUS_CODE
 results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE
 results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE
BLPU_STATE_CODE_DESCRIPTION
 results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.DPA.ENTRY_DATE string

ENTRY_DATE
BLPU_STATE_DATE
 results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE
LANGUAGE
 results.DPA.LANGUAGE string

LANGUAGE
MATCH
 results.DPA.MATCH float

MATCH
MATCH_DESCRIPTION
 results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION
UPRN
 results.LPI.UPRN string

UPRN
地址
 results.LPI.ADDRESS string

地址
USRN
 results.LPI.USRN string

USRN
LPI_KEY
 results.LPI.LPI_KEY string

LPI_KEY
PAO_START_NUMBER
 results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER
STREET_DESCRIPTION
 results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION
TOWN_NAME
 results.LPI.TOWN_NAME string

TOWN_NAME
ADMINISTRATIVE_AREA
 results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA
POSTCODE_LOCATOR
 results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR
RPC
 results.LPI.RPC string

RPC
X_COORDINATE
 results.LPI.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.LPI.Y_COORDINATE float

Y_COORDINATE
地位
 results.LPI.STATUS string

地位
LOGICAL_STATUS_CODE
 results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE_DESCRIPTION
 results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.LPI.ENTRY_DATE string

ENTRY_DATE
STREET_STATE_CODE
 results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE
STREET_STATE_CODE_DESCRIPTION
 results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION
STREET_CLASSIFICATION_CODE
 results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE
STREET_CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION
LPI_LOGICAL_STATUS_CODE
 results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
 results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
LANGUAGE
 results.LPI.LANGUAGE string

LANGUAGE
MATCH
 results.LPI.MATCH float

MATCH
MATCH_DESCRIPTION
 results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

边界框作

操作 ID:
BBox

获取两个点并创建边界框。 然后返回此边界框中的所有地址。

参数

名称 密钥 必需 类型 说明
边界框
 bbox True string

一对逗号分隔的坐标，精度为两个小数位数或更少，指定边界框的左下角和右上方坐标。 边界框的最大大小为 1 km2。 如果边界框超出此范围，则返回一条错误消息。 坐标的精度是 8 米的精度。
结果格式
 format string

将返回响应的格式。 默认值：JSON。 接受的值：JSON、XML
限制结果
 maxresults integer

要返回的最大结果数。 默认值：100
偏移结果
 offset integer

偏移此金额返回的列表。
地方当局（LPI）和/或皇家邮件（DPA）地址结果
 dataset string

要返回的地址数据集。 可以发送多个值，用逗号分隔。 默认值：DPA。 接受的值：DPA、LPI
语言
 lr string

要返回的地址语言。 有效语言为英语和威尔士语。 筛选器仅适用于 DPA 数据集。 默认值为两种语言。 默认值：EN、CY。
过滤器
 fq string

允许按分类代码和/或逻辑状态代码筛选结果的筛选器。 筛选分类代码将接受通配符 \ 搜索。 可以对分类代码使用空格分离分类代码参数执行多个搜索。 可以使用参数多次运行分类代码筛选器：fq=classification_code：CI classification_code：RD&fq=LOGICAL_STATUS_CODE：6
输出空间引用系统
 output_srs string

预期的输出空间引用系统。 默认值：EPSG：27700。
输入坐标参考系统
 srs string

输入坐标集的空间引用系统。

返回

名称 路径 类型 说明
uri
 header.uri string

uri
查询
 header.query string

查询
偏移
 header.offset integer

偏移
totalresults
 header.totalresults integer

totalresults
格式
 header.format string

格式
数据集
 header.dataset string

数据集
lr
 header.lr string

lr
maxresults
 header.maxresults integer

maxresults
matchprecision
 header.matchprecision integer

matchprecision
时代
 header.epoch string

时代
output_srs
 header.output_srs string

output_srs
results
 results array of object

results
UPRN
 results.DPA.UPRN string

UPRN
地址
 results.DPA.ADDRESS string

地址
ORGANISATION_NAME
 results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME
BUILDING_NUMBER
 results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER
THOROUGHFARE_NAME
 results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME
DEPENDENT_LOCALITY
 results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY
POST_TOWN
 results.DPA.POST_TOWN string

POST_TOWN
邮政编码
 results.DPA.POSTCODE string

邮政编码
RPC
 results.DPA.RPC string

RPC
X_COORDINATE
 results.DPA.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.DPA.Y_COORDINATE float

Y_COORDINATE
地位
 results.DPA.STATUS string

地位
LOGICAL_STATUS_CODE
 results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE
 results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE
BLPU_STATE_CODE_DESCRIPTION
 results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.DPA.ENTRY_DATE string

ENTRY_DATE
BLPU_STATE_DATE
 results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE
LANGUAGE
 results.DPA.LANGUAGE string

LANGUAGE
MATCH
 results.DPA.MATCH float

MATCH
MATCH_DESCRIPTION
 results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION
UPRN
 results.LPI.UPRN string

UPRN
地址
 results.LPI.ADDRESS string

地址
USRN
 results.LPI.USRN string

USRN
LPI_KEY
 results.LPI.LPI_KEY string

LPI_KEY
PAO_START_NUMBER
 results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER
STREET_DESCRIPTION
 results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION
TOWN_NAME
 results.LPI.TOWN_NAME string

TOWN_NAME
ADMINISTRATIVE_AREA
 results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA
POSTCODE_LOCATOR
 results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR
RPC
 results.LPI.RPC string

RPC
X_COORDINATE
 results.LPI.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.LPI.Y_COORDINATE float

Y_COORDINATE
地位
 results.LPI.STATUS string

地位
LOGICAL_STATUS_CODE
 results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE_DESCRIPTION
 results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.LPI.ENTRY_DATE string

ENTRY_DATE
STREET_STATE_CODE
 results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE
STREET_STATE_CODE_DESCRIPTION
 results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION
STREET_CLASSIFICATION_CODE
 results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE
STREET_CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION
LPI_LOGICAL_STATUS_CODE
 results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
 results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
LANGUAGE
 results.LPI.LANGUAGE string

LANGUAGE
MATCH
 results.LPI.MATCH float

MATCH
MATCH_DESCRIPTION
 results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION

邮政编码作

操作 ID:
Postcode

基于属性的邮政编码进行搜索。 资源的最低值为区域和地区，例如 SO16，将接受由区域、地区、部门和单位组成的完整邮政编码，例如 SO16 0AS

参数

名称 密钥 必需 类型 说明
英国样式的邮政编码
 postcode True string

邮政编码搜索参数。
结果格式
 format string

将返回响应的格式。 默认值：JSON。 接受的值：“JSON”、“XML”
限制结果
 maxresults integer

要返回的最大结果数。 默认值：100
偏移结果
 offset integer

偏移此金额返回的列表。
地方当局（LPI）和/或皇家邮件（DPA）地址结果
 dataset string

要返回的地址数据集。 可以发送多个值，用逗号分隔。 默认值：DPA。 接受的值：DPA、LPI
语言
 lr string

要返回的地址语言。 有效语言为英语和威尔士语。 筛选器仅适用于 DPA 数据集。 默认值为两种语言。 默认值：EN、CY。
过滤器
 fq string

允许按分类代码和/或逻辑状态代码筛选结果的筛选器。 筛选分类代码将接受通配符 \ 搜索。 可以对分类代码使用空格分离分类代码参数执行多个搜索。 可以使用参数多次运行分类代码筛选器：fq=classification_code：CI classification_code：RD&fq=LOGICAL_STATUS_CODE：6
输出空间引用系统
 output_srs string

预期的输出空间引用系统。 默认值：EPSG：27700。 接受的值：BNG、EPSG：27700、WGS84、EPSG：4326、EPSG：3857、EPSG：4258

返回

名称 路径 类型 说明
uri
 header.uri string

uri
查询
 header.query string

查询
偏移
 header.offset integer

偏移
totalresults
 header.totalresults integer

totalresults
格式
 header.format string

格式
数据集
 header.dataset string

数据集
lr
 header.lr string

lr
maxresults
 header.maxresults integer

maxresults
matchprecision
 header.matchprecision integer

matchprecision
时代
 header.epoch string

时代
output_srs
 header.output_srs string

output_srs
results
 results array of object

results
UPRN
 results.DPA.UPRN string

UPRN
地址
 results.DPA.ADDRESS string

地址
ORGANISATION_NAME
 results.DPA.ORGANISATION_NAME string

ORGANISATION_NAME
BUILDING_NUMBER
 results.DPA.BUILDING_NUMBER string

BUILDING_NUMBER
THOROUGHFARE_NAME
 results.DPA.THOROUGHFARE_NAME string

THOROUGHFARE_NAME
DEPENDENT_LOCALITY
 results.DPA.DEPENDENT_LOCALITY string

DEPENDENT_LOCALITY
POST_TOWN
 results.DPA.POST_TOWN string

POST_TOWN
邮政编码
 results.DPA.POSTCODE string

邮政编码
RPC
 results.DPA.RPC string

RPC
X_COORDINATE
 results.DPA.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.DPA.Y_COORDINATE float

Y_COORDINATE
地位
 results.DPA.STATUS string

地位
LOGICAL_STATUS_CODE
 results.DPA.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.DPA.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.DPA.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.DPA.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.DPA.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE
 results.DPA.BLPU_STATE_CODE string

BLPU_STATE_CODE
BLPU_STATE_CODE_DESCRIPTION
 results.DPA.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.DPA.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.DPA.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.DPA.ENTRY_DATE string

ENTRY_DATE
BLPU_STATE_DATE
 results.DPA.BLPU_STATE_DATE string

BLPU_STATE_DATE
LANGUAGE
 results.DPA.LANGUAGE string

LANGUAGE
MATCH
 results.DPA.MATCH float

MATCH
MATCH_DESCRIPTION
 results.DPA.MATCH_DESCRIPTION string

MATCH_DESCRIPTION
UPRN
 results.LPI.UPRN string

UPRN
地址
 results.LPI.ADDRESS string

地址
USRN
 results.LPI.USRN string

USRN
LPI_KEY
 results.LPI.LPI_KEY string

LPI_KEY
PAO_START_NUMBER
 results.LPI.PAO_START_NUMBER string

PAO_START_NUMBER
STREET_DESCRIPTION
 results.LPI.STREET_DESCRIPTION string

STREET_DESCRIPTION
TOWN_NAME
 results.LPI.TOWN_NAME string

TOWN_NAME
ADMINISTRATIVE_AREA
 results.LPI.ADMINISTRATIVE_AREA string

ADMINISTRATIVE_AREA
POSTCODE_LOCATOR
 results.LPI.POSTCODE_LOCATOR string

POSTCODE_LOCATOR
RPC
 results.LPI.RPC string

RPC
X_COORDINATE
 results.LPI.X_COORDINATE float

X_COORDINATE
Y_COORDINATE
 results.LPI.Y_COORDINATE float

Y_COORDINATE
地位
 results.LPI.STATUS string

地位
LOGICAL_STATUS_CODE
 results.LPI.LOGICAL_STATUS_CODE string

LOGICAL_STATUS_CODE
CLASSIFICATION_CODE
 results.LPI.CLASSIFICATION_CODE string

CLASSIFICATION_CODE
CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.CLASSIFICATION_CODE_DESCRIPTION string

CLASSIFICATION_CODE_DESCRIPTION
LOCAL_CUSTODIAN_CODE
 results.LPI.LOCAL_CUSTODIAN_CODE integer

LOCAL_CUSTODIAN_CODE
LOCAL_CUSTODIAN_CODE_DESCRIPTION
 results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION string

LOCAL_CUSTODIAN_CODE_DESCRIPTION
POSTAL_ADDRESS_CODE
 results.LPI.POSTAL_ADDRESS_CODE string

POSTAL_ADDRESS_CODE
POSTAL_ADDRESS_CODE_DESCRIPTION
 results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION string

POSTAL_ADDRESS_CODE_DESCRIPTION
BLPU_STATE_CODE_DESCRIPTION
 results.LPI.BLPU_STATE_CODE_DESCRIPTION string

BLPU_STATE_CODE_DESCRIPTION
TOPOGRAPHY_LAYER_TOID
 results.LPI.TOPOGRAPHY_LAYER_TOID string

TOPOGRAPHY_LAYER_TOID
LAST_UPDATE_DATE
 results.LPI.LAST_UPDATE_DATE string

LAST_UPDATE_DATE
ENTRY_DATE
 results.LPI.ENTRY_DATE string

ENTRY_DATE
STREET_STATE_CODE
 results.LPI.STREET_STATE_CODE string

STREET_STATE_CODE
STREET_STATE_CODE_DESCRIPTION
 results.LPI.STREET_STATE_CODE_DESCRIPTION string

STREET_STATE_CODE_DESCRIPTION
STREET_CLASSIFICATION_CODE
 results.LPI.STREET_CLASSIFICATION_CODE string

STREET_CLASSIFICATION_CODE
STREET_CLASSIFICATION_CODE_DESCRIPTION
 results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION string

STREET_CLASSIFICATION_CODE_DESCRIPTION
LPI_LOGICAL_STATUS_CODE
 results.LPI.LPI_LOGICAL_STATUS_CODE string

LPI_LOGICAL_STATUS_CODE
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
 results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION string

LPI_LOGICAL_STATUS_CODE_DESCRIPTION
LANGUAGE
 results.LPI.LANGUAGE string

LANGUAGE
MATCH
 results.LPI.MATCH float

MATCH
MATCH_DESCRIPTION
 results.LPI.MATCH_DESCRIPTION string

MATCH_DESCRIPTION