美国学校查询-SchoolDigger
专用API
【更新时间: 2024.06.05】
SchoolDigger的学校数据API可让您立即访问超过125000所美国K-12学校和相关数据,包括学校地址、电话号码、学生身体构成、免费午餐计划接受者、考试成绩和SchoolDigger排名。按名称、城市、邮...
|
相似API
- API详情
- 接口文档
- 使用指南
- 常见 FAQ
- 相关推荐
![<](https://static.explinks.com/hub/static/images/left.png)
产品介绍
![>](https://static.explinks.com/hub/static/images/right.png)
什么是美国学校查询-SchoolDigger?
服务详情
SchoolDigger的学校数据API可让您立即访问超过125000所美国K-12学校和相关数据,包括学校地址、电话号码、学生身体构成、免费午餐计划接受者、考试成绩和SchoolDigger排名。按名称、城市、邮政编码、纬度/经度等搜索学校和学区!
核心功能
- 获取单个学校的详细信息
- 获取多个学校的列表和基本信息
- 获取关于特定学区的信息
- 获取多个学区的列表
- 获取按排名排序的学校列表
- 搜索建议功能
核心优势
丰富的API
统一化管理
速度快捷
开发者友好
灵活的定价模式
开放性
什么是美国学校查询-SchoolDigger接口?
由服务使用方的应用程序发起,以Restful风格为主、通过公网HTTP协议调用美国学校查询-SchoolDigger,从而实现程序的自动化交互,提高服务效率。
![<](https://static.explinks.com/hub/static/images/left.png)
使用指南
![>](https://static.explinks.com/hub/static/images/right.png)
使用RapidAPI来搜索和集成API的步骤如下:
- 注册并登录帐户:访问RapidAPI.com,点击”开始”或“登录”,然后通过谷歌、Github或其他方式创建新账户。
- 查找所需的API:在主页面的搜索框中,输入你想要搜索的API关键词,然后点击Enter键进行搜索。
- 评估并选择API:在搜索结果列表中,点击你感兴趣的API查看其详细信息,包括端点(Endpoints)、参数(Parameters)、响应信息等。这些信息可以帮助你决定这个API是否适合你的需求。
- 测试API:在详细信息页面,你可以选择端点,填写参数,然后点击“Test Endpoint”按钮进行API测试。
- 集成API:如果你觉得这个API满足你的需要,可以点击"Subscribe"或者“Purchase API”按钮来购买或订阅这个API。然后你可以按照RapidAPI提供的代码片段(在各种编程语言下),直接把这个API集成到你的应用中。
- 管理API:在你的RapidAPI控制面板中,你可以查看和管理你订阅的所有API,也可以查看它们的使用情况、计费情况等。
相关接口示例代码请查看API文档:https://rapidapi.com/schooldigger-schooldigger-default/api/schooldigger-k-12-school-data-api/
![<](https://static.explinks.com/hub/static/images/left.png)
产品问答
![>](https://static.explinks.com/hub/static/images/right.png)
?
我的支付信息安全吗?
通过符合 PCI 标准的银行合作伙伴处理信用卡。
?
为什么免费API也需要提供信用卡?
我们与API提供商直接合作,为开发者实施清晰透明的定价。如果计划中有配额和超额费用,提供商可能需要信用卡。如果您不再想使用API,您可以随时在RapidAPI仪表板的计费部分点击“取消订阅”按钮取消订阅计划。
?
如果超出了我的订阅计划呢?
根据您的订阅计划详情,您将承担超额费用或被暂停服务。
?
我何时会被收费?
我们会在您订阅API计划时立即向您的信用卡收取费用,并在下一个循环周期收取费用。
?
如何处理退款?
退款,请通过 support@rapidapi.com 与我们联系。
API接口列表
完成功能
1.1 简要描述
返回一个简单快速的学校列表,用于客户端类型的自动补全
1.2 请求URL
https://schooldigger-k-12-school-data-api.p.rapidapi.com/v2.0/autocomplete/schools
1.3 请求方式
GET
1.4 入参
参数名 | 参数类型 | 默认值 | 是否必传 | 描述 |
---|---|---|---|---|
boxLongitudeNW | String | 否 | 在(BoxLatitudeNW/ boxlongitude enw)到(boxlongitude /BoxLatitudeSE)定义的“框”内搜索(可选)。仅限Ultra, Mega API级别。) | |
boxLongitudeSE | String | 否 | 在(BoxLatitudeNW/ boxlongitude enw)到(boxlongitude /BoxLatitudeSE)定义的“框”内搜索(可选)。仅限Ultra, Mega API级别。) | |
st | String | 否 | 两个字符状态(例如:'CA')(可选——留空搜索整个美国) | |
boxLatitudeSE | String | 否 | 在(BoxLatitudeNW/ boxlongitude enw)到(boxlongitude /BoxLatitudeSE)定义的“框”内搜索(可选)。仅限Ultra, Mega API级别。) | |
returnCount | String | 否 | 返校人数。取值范围:1 ~ 20。(默认值:10) | |
boxLatitudeNW | String | 否 | 在(BoxLatitudeNW/ boxlongitude enw)到(boxlongitude /BoxLatitudeSE)定义的“框”内搜索(可选)。仅限Ultra, Mega API级别。) | |
level | String | 否 | 仅搜索此级别的学校。有效值:'Elementary', 'Middle', 'High', 'Alt', 'Private'(可选-留空搜索所有学校) | |
q | String | 是 | 自动补全的搜索词(例如:“Lincol”)(必需) | |
qSearchCityStateName | String | 否 | 扩展搜索词以包括城市和州(例如:'Lincoln el paso'匹配Lincoln Middle School in el paso)(可选) |
1.5 出参
参数名 | 参数类型 | 默认值 | 描述 |
---|
1.6 错误码
错误码 | 错误信息 | 描述 |
---|
1.7 示例
获取多个学校的列表和基本信息
2.1 简要描述
从SchoolDigger数据库中检索学校记录
2.2 请求URL
https://schooldigger-k-12-school-data-api.p.rapidapi.com/v2.0/schools/{id}
2.3 请求方式
GET
2.4 入参
参数名 | 参数类型 | 默认值 | 是否必传 | 描述 |
---|---|---|---|---|
id | String | 是 | 12位学号(如064215006903) |
2.5 出参
参数名 | 参数类型 | 默认值 | 描述 |
---|
2.6 错误码
错误码 | 错误信息 | 描述 |
---|
2.7 示例
获取单个学校的详细信息
3.1 简要描述
在SchoolDigger数据库中搜索学校。您可以使用任何条件组合作为查询参数。
3.2 请求URL
https://schooldigger-k-12-school-data-api.p.rapidapi.com/v2.0/schools
3.3 请求方式
GET
3.4 入参
参数名 | 参数类型 | 默认值 | 是否必传 | 描述 |
---|---|---|---|---|
boxLongitudeSE | String | 否 | ||
nearLongitude | String | 否 | 搜索(nearLatitude)/(nearLongitude)范围内(distanceMiles)(例如-124.289185)(可选)的学校(仅限Ultra, Mega API级别)。 | |
isVirtual | String | 否 | True =只返回虚拟学校,False =只返回非虚拟学校(可选)(仅限Ultra, Mega API级别) | |
qSearchSchoolNameOnly | String | 否 | 对于参数“q”,只搜索学校名称,而不是学校和城市(可选) | |
page | String | 否 | 要检索的页码(可选,默认:1) | |
boxLatitudeSE | String | 否 | 搜索由(boxLatitudeNW/ boxlongitude)到(boxlongitude /boxLatitudeSE)定义的“框”内的学校(可选) | |
boxLatitudeNW | String | 否 | 搜索由(boxLatitudeNW/ boxlongitude)到(boxlongitude /boxLatitudeSE)定义的“框”内的学校(可选) | |
distanceMiles | String | 否 | 搜索(nearLatitude)/(nearLongitude)(默认5英里)范围内(distanceMiles)的学校(可选)(仅限Ultra, Mega API级别) | |
perPage | String | 否 | 在一个页面上检索的学校数量(最多50个)(可选,默认:10个) | |
sortBy | String | 否 | 对列表进行排序。值为:学校名称、距离、等级。如果按降序排列,前面加'-'即-schoolname(可选,默认:schoolname) | |
districtID | String | 否 | 搜寻区内学校(7位区号)(可选) | |
isTitleISchoolwide | String | 否 | True =只返回第一级学校,False =只返回非第一级学校(可选)(仅限Ultra, Mega API级别) | |
boxLongitudeNW | String | 否 | 搜索由(boxLatitudeNW/ boxlongitude)到(boxlongitude /boxLatitudeSE)定义的“框”内的学校(可选) | |
q | String | 否 | 搜索条件-注意:将匹配学校名称或城市(可选) | |
isCharter | String | 否 | True =只返回特许学校,False =只返回非特许学校(可选)(仅限Ultra, Mega API级别) | |
level | String | 否 | 搜索这个级别的学校。有效值:'Elementary', 'Middle', 'High', 'Alt', 'Public', 'Private'(可选)。“Public”返回所有小学、初中、高中和另类学校 | |
isTitleI | String | 否 | True =只返回Title I学校,False =只返回非Title I学校(可选)(仅限Ultra, Mega API级别) | |
st | String | 是 | 两个字符状态(例如:'CA') -必需的 | |
nearAddress | String | 否 | 搜索距离此地址(英里)以内的学校。示例:'123 Main St. AnyTown CA 90001'(可选)(仅限Ultra, Mega API级别)重要注意事项:如果您有地址的纬度/长度,请使用nearLatitude和nearLongitude代替,以获得更快的响应时间 | |
city | String | 否 | 搜索这个城市的学校(可选) | |
isMagnet | String | 否 | True =只返回磁石学校,False =只返回非磁石学校(可选)(仅限Ultra, Mega API级别) | |
includeUnrankedSchoolsInRankSort | String | 否 | 如果sortBy为'rank',则此布尔值确定结果中是否包含没有排名的学校(可选,默认:false) | |
nearLatitude | String | 否 | 搜索(nearLatitude)/(nearLongitude)(例如44.982560)(可选)范围内(distanceMiles)的学校(仅限Ultra, Mega API级别)。 | |
zip | String | 否 | 按此五位邮编搜寻学校(可选) |
3.5 出参
参数名 | 参数类型 | 默认值 | 描述 |
---|
3.6 错误码
错误码 | 错误信息 | 描述 |
---|
3.7 示例
获取按排名排序的学校列表
4.1 简要描述
返回SchoolDigger学校排名列表
4.2 请求URL
https://schooldigger-k-12-school-data-api.p.rapidapi.com/v2.0/rankings/schools/{st}
4.3 请求方式
GET
4.4 入参
参数名 | 参数类型 | 默认值 | 是否必传 | 描述 |
---|---|---|---|---|
perPage | String | 否 | 在一个页面上检索的学校数量(最多50个)(可选,默认:10个) | |
level | String | 否 | 排名等级:“初级”、“中级”或“高级” | |
page | String | 否 | 要检索的页码(可选,默认:1) | |
year | String | 否 | 排名年份(最近一年不填) | |
st | String | 是 | 两个字符状态(例如:“CA”) |
4.5 出参
参数名 | 参数类型 | 默认值 | 描述 |
---|
4.6 错误码
错误码 | 错误信息 | 描述 |
---|
4.7 示例
获取按排名排序的学区列表
5.1 简要描述
返回SchoolDigger地区排名列表
5.2 请求URL
https://schooldigger-k-12-school-data-api.p.rapidapi.com/v2.0/rankings/districts/{st}
5.3 请求方式
GET
5.4 入参
参数名 | 参数类型 | 默认值 | 是否必传 | 描述 |
---|---|---|---|---|
st | String | 是 | 两个字符状态(例如:“CA”) | |
perPage | String | 否 | 在一个页面上检索的地区数量(最多50个)(可选,默认:10个) | |
page | String | 否 | 要检索的页码(可选,默认:1) | |
year | String | 否 | 排名年份(最近一年不填) |
5.5 出参
参数名 | 参数类型 | 默认值 | 描述 |
---|
5.6 错误码
错误码 | 错误信息 | 描述 |
---|
5.7 示例
获取关于特定学区的信息
6.1 简要描述
从SchoolDigger数据库中检索单个地区记录
6.2 请求URL
https://schooldigger-k-12-school-data-api.p.rapidapi.com/v2.0/districts/{id}
6.3 请求方式
GET
6.4 入参
参数名 | 参数类型 | 默认值 | 是否必传 | 描述 |
---|---|---|---|---|
id | String | 是 | 7位区号(例如0642150) |
6.5 出参
参数名 | 参数类型 | 默认值 | 描述 |
---|
6.6 错误码
错误码 | 错误信息 | 描述 |
---|
6.7 示例
获取多个学区的列表
7.1 简要描述
在SchoolDigger数据库中搜索学区。您可以使用任何条件组合作为查询参数。
7.2 请求URL
https://schooldigger-k-12-school-data-api.p.rapidapi.com/v2.0/districts
7.3 请求方式
GET
7.4 入参
参数名 | 参数类型 | 默认值 | 是否必传 | 描述 |
---|---|---|---|---|
boxLatitudeSE | String | 否 | 搜索由(BoxLatitudeNW/ boxlongitude)到(boxlongitude /BoxLatitudeSE)定义的“框”内的地区(可选) | |
isInBoundaryOnly | String | 否 | 仅返回在其出席边界中包含给定位置(nearLatitude/nearLongitude)或(boundaryAddress)的地区(仅限Mega API级别) | |
boxLongitudeSE | String | 否 | 搜索由(BoxLatitudeNW/ boxlongitude)到(boxlongitude /BoxLatitudeSE)定义的“框”内的地区(可选) | |
sortBy | String | 否 | 对列表进行排序。取值为:地区名称、距离、等级。如果按降序排列,请在前面加上'-',即- distritname(可选,默认:distritname) | |
page | String | 否 | 要检索的页码(可选,默认:1) | |
includeUnrankedDistrictsInRankSort | String | 否 | 如果sortBy为'rank',则此布尔值确定结果中是否包含没有排名的地区(可选,默认:false) | |
boundaryAddress | String | 否 | 完整的美国地址:包含此地址的选区。示例:“123 Main St. AnyTown CA 90001”(可选)(仅限Mega API级别) | |
perPage | String | 否 | 在一个页面上检索的地区数量(最多50个)(可选,默认:10个) | |
boxLongitudeNW | String | 否 | 搜索由(BoxLatitudeNW/ boxlongitude)到(boxlongitude /BoxLatitudeSE)定义的“框”内的地区(可选) | |
zip | String | 否 | 以此五位邮编搜寻地区(可选) | |
q | String | 否 | 搜索词-注意:将匹配地区名称或城市(可选) | |
distanceMiles | String | 否 | 搜索(nearLatitude)/(nearLongitude)(默认50英里)范围内(distanceMiles)的地区(可选)(仅限Ultra, Mega API级别) | |
boxLatitudeNW | String | 否 | 搜索由(BoxLatitudeNW/ boxlongitude)到(boxlongitude /BoxLatitudeSE)定义的“框”内的地区(可选) | |
nearLongitude | String | 否 | 搜索(nearLatitude)/(nearLongitude)(例如-124.289185)(可选)范围内(distanceMiles)的地区(仅限Ultra, Mega API级别)。大型空气污染指数级别会在其出勤范围内标记包括晚/长在内的地区。) | |
nearLatitude | String | 否 | 搜索(nearLatitude)/(nearLongitude)(例如44.982560)(可选)范围内(distanceMiles)的地区(仅限Ultra, Mega API级别)。大型空气污染指数级别会在其出勤范围内标记包括晚/长在内的地区。) | |
city | String | 否 | 搜索该城市的地区(可选) | |
st | String | 是 | 两个字符状态(例如:'CA') -必需的 |
7.5 出参
参数名 | 参数类型 | 默认值 | 描述 |
---|
7.6 错误码
错误码 | 错误信息 | 描述 |
---|
7.7 示例
![<](https://static.explinks.com/hub/static/images/left.png)
使用指南
![>](https://static.explinks.com/hub/static/images/right.png)
使用RapidAPI来搜索和集成API的步骤如下:
- 注册并登录帐户:访问RapidAPI.com,点击”开始”或“登录”,然后通过谷歌、Github或其他方式创建新账户。
- 查找所需的API:在主页面的搜索框中,输入你想要搜索的API关键词,然后点击Enter键进行搜索。
- 评估并选择API:在搜索结果列表中,点击你感兴趣的API查看其详细信息,包括端点(Endpoints)、参数(Parameters)、响应信息等。这些信息可以帮助你决定这个API是否适合你的需求。
- 测试API:在详细信息页面,你可以选择端点,填写参数,然后点击“Test Endpoint”按钮进行API测试。
- 集成API:如果你觉得这个API满足你的需要,可以点击"Subscribe"或者“Purchase API”按钮来购买或订阅这个API。然后你可以按照RapidAPI提供的代码片段(在各种编程语言下),直接把这个API集成到你的应用中。
- 管理API:在你的RapidAPI控制面板中,你可以查看和管理你订阅的所有API,也可以查看它们的使用情况、计费情况等。
相关接口示例代码请查看API文档:https://rapidapi.com/schooldigger-schooldigger-default/api/schooldigger-k-12-school-data-api/
![<](https://static.explinks.com/hub/static/images/left.png)
依赖服务
![>](https://static.explinks.com/hub/static/images/right.png)
![<](https://static.explinks.com/hub/static/images/left.png)
产品问答
![>](https://static.explinks.com/hub/static/images/right.png)
?
我的支付信息安全吗?
通过符合 PCI 标准的银行合作伙伴处理信用卡。
?
为什么免费API也需要提供信用卡?
我们与API提供商直接合作,为开发者实施清晰透明的定价。如果计划中有配额和超额费用,提供商可能需要信用卡。如果您不再想使用API,您可以随时在RapidAPI仪表板的计费部分点击“取消订阅”按钮取消订阅计划。
?
如果超出了我的订阅计划呢?
根据您的订阅计划详情,您将承担超额费用或被暂停服务。
?
我何时会被收费?
我们会在您订阅API计划时立即向您的信用卡收取费用,并在下一个循环周期收取费用。
?
如何处理退款?
退款,请通过 support@rapidapi.com 与我们联系。