postcodes.io api的python包装器
postcodes-io-api的Python项目详细描述
邮政编码API
为邮政编码api提供python接口的库。
项目URL
示例
import postcodes_io_api
api = postcodes_io_api.Api(debug_http=True)
data = api.get_postcode('SW112EF')
APIApi(self,debug_http=False,timeout=None,base_url=None)
邮政编码是否有效
Api.is_postcode_valid(self,postcode)
此方法验证post_代码
- ：param postcode-要检查的邮政编码，即“sw112ef”
- ：返回-如果邮政编码有效则返回true如果邮政编码无效则返回false
is_valid = api.is_postcode_valid('SW112EF')
邮政编码是否终止
Api.is_postcode_terminated(self,postcode)
- ：param postcode-要检查的邮政编码，即“sw112zw”
- ：如果邮政编码终止，则返回true；否则返回false
is_terminated = api.is_postcode_terminated('SW112EF')
获取邮政编码
Api.get_postcode(self,postcode)
此方法返回Post_代码的数据
- ：param postcode-要检查的邮政编码，即“sw112ef”
- ：：返回-邮政编码详细数据
data = api.get_postcode('SW112EF')
获取最近的邮政编码以获取邮政编码
Api.get_nearest_postcodes_for_postcode(self,**kwargs)
- kwargs
- ：参数邮政编码-邮政编码
- ：param limit-（非必需）限制要返回的邮政编码匹配数。默认为10。必须小于100。
- ：param radius-（不是必需的）限制要返回的邮政编码匹配数。默认为100米。需要小于2000米。
- ：返回：-最近邮政编码数据列表
data = api.get_nearest_postcodes_for_postcode(postcode='SW112EF',limit=2)
获取最近的邮政编码以获取坐标
Api.get_nearest_postcodes_for_coordinates(self,**kwargs)
- kwargs
- ：参数纬度-（必需）纬度
- ：参数经度-（必需）经度
- ：param limit-（非必需）限制要返回的邮政编码匹配数。默认为10。必须小于100。
- ：param radius-（不是必需的）限制要返回的邮政编码匹配数。默认值为100米。需要小于
- ：返回：-最近邮政编码数据列表
data = api.get_nearest_postcodes_for_coordinates(latitude=51.466324,longitude=-0.173606,limit=2)
获取“批量”邮政编码
Api.get_bulk_postcodes(self,postcodes_list)
- ：参数邮政编码列表-包含邮政编码的列表
- ：返回-邮政编码数据列表
postcode_list = ["SW112EF","HA97QP"]
data = api.get_bulk_postcodes(postcode_list)
获取“批量”和“反向”地理代码
Api.get_bulk_reverse_geocode(self,payload_data)
- ：param payload_data-带cordinates的dict，例如
payload_data = {
"geolocations":
[
{
"longitude": 0.629834723775309,
"latitude": 51.7923246977375
},
{
"longitude": -2.49690382054704,
"latitude": 53.5351312861402,
"radius": 1000,
"limit": 5
}
]
}
- ：返回-邮政编码数据列表
data = api.get_bulk_reverse_geocode(payload_data)
获取“随机”邮政编码
Api.get_random_postcode(self)
- ：返回-随机邮政编码
data = api.get_random_postcode()
获取“自动完成”邮政编码
Api.get_autocomplete_postcode(self,**kwargs)
- kwargs
- ：参数邮政编码-部分邮政编码
- ：param limit-（非必需）限制要返回的邮政编码匹配数。默认为10。必须小于100。
- ：返回-可能的邮政编码列表
data = api.get_autocomplete_postcode(postcode='SW18',limit=2)
获取输出代码
Api.get_outcode(self,outcode)
此方法返回Post_代码的数据
- ：param outcode-要检查的邮政编码外部代码，即“kt1”
- ：返回-邮政编码详细数据
data = api.get_outcode('KT1')
获取最近的输出代码以获取输出代码
Api.get_nearest_outcodes_for_outcode(self,**kwargs)
- kwargs
- ：param outcode-外部代码
- ：param limit-（非必需）限制要返回的邮政编码匹配数。默认为10。必须小于100。
- ：param radius-（不是必需的）限制要返回的邮政编码匹配数。默认为100米。需要小于2000米。
- ：返回：-最近邮政编码数据列表
data = api.get_nearest_outcodes_for_outcode(outcode='KT1',limit=2)
获取坐标的“最接近”输出代码
Api.get_nearest_outcodes_for_coordinates(self,**kwargs)
- kwargs
- ：参数纬度-（必需）纬度
- ^{结构1}$：参数经度-（必需）经度
- ：param limit-（非必需）限制要返回的邮政编码匹配数。默认为10。必须小于100。
- ：param radius-（不是必需的）限制要返回的邮政编码匹配数。默认值为100米。需要小于
- ：返回：-最近的outcode数据列表
data = api.get_nearest_outcodes_for_coordinates(latitude=51.466324,longitude=-0.173606,limit=2)
更改日志-邮政编码API
为邮政编码api提供python接口的库。
0.0.4（2019年1月12日）
- 修复了python 2的打包问题
0.0.3（2019年1月12日）
- 为python 2添加了支持
0.0.2（2019年1月7日）
- 固定要求和设置文件
0.0.1（2019年1月7日）
- 初始版本
欢迎加入QQ群-->： 979659372
