Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

Commit 3ae342d

Browse files
committed
Update README with lat/lng and address information
1 parent 08bcf54 commit 3ae342d

File tree

1 file changed

+39
-17
lines changed

1 file changed

+39
-17
lines changed

README.md

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -197,10 +197,32 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
197197
<a name="products"></a>
198198
# [Products](#toc)
199199

200-
**NOTE**: As of the current release, only direct FSID lookups are available through this wrapper. Lat/lng and address query will be in a later release
201-
202200
More information on each product can be found at the [First Street Foundation API Data Dictionary](https://docs.firststreet.dev/docs)
203201

202+
<a name="Search Item"></a>
203+
#### [Search Item](#toc)
204+
205+
For every product, a list or file of `search items` must be provided to the product call. There are 3 types of `search items` corresponding to the 3 types of lookups.
206+
207+
1. FSID (`int`): The simplest type of lookup is a fsid lookup. If you know the fsid of the specific location, you can navigate directly to the specific product's information using the location's fsid. Example FSID: `18`
208+
209+
2. Lat/Lng (`tuple of int`): Provide a tuple of latitude, longitude pairs will check to see if that point intersects within a boundary of a parcel from the database. Example lat/lng: `(40.7079652311, -74.0021455387)`
210+
211+
3. Address (`string`): Pass the address in your request to retrieve a reverse geocode location lookup. LocationType is required for address lookup. An address can be a city name, home address, or business address. City and State need to be included within the address query. Example Address: `New York, NY`
212+
213+
Example list of `search items`:
214+
215+
```python
216+
lst = [362493883, (40.792505, -73.951949), "1220 5th Ave, New York, NY"]
217+
```
218+
219+
Example file of `search items`:
220+
```text
221+
362493883
222+
(40.792505, -73.951949)
223+
1220 5th Ave, New York, NY
224+
```
225+
204226
<a name="location"></a>
205227
#### [Location](#toc)
206228

@@ -210,8 +232,8 @@ The Location API provides `Detail` and `Summary` data for the given FSIDs.
210232
location.<method>
211233
```
212234

213-
* `get_detail`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Location Detail` product for the given IDs, location_type, and optionally creates a csv file
214-
* `get_summary`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Location Summary` product for the given IDs, location_type, and optionally creates a csv file
235+
* `get_detail`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Location Detail` product for the given IDs, location_type, and optionally creates a csv file
236+
* `get_summary`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Location Summary` product for the given IDs, location_type, and optionally creates a csv file
215237

216238
<a name="probability"></a>
217239
#### [Probability](#toc)
@@ -222,11 +244,11 @@ The Probability API provides `Depth`, `Chance`, `Cumulative`, `Count` data for t
222244
probability.<method>
223245
```
224246

225-
* `get_depth`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Depth` product for the given IDs, and optionally creates a csv file
226-
* `get_chance`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Chance` product for the given IDs, and optionally creates a csv file
227-
* `get_count_summary`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Count-Summary` product for the given IDs, and optionally creates a csv file
228-
* `get_cumulative`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Cumulative` product for the given IDs, and optionally creates a csv file
229-
* `get_count`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Count` product for the given IDs, location_type, and optionally creates a csv file
247+
* `get_depth`(search_items `list/file`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Depth` product for the given IDs, and optionally creates a csv file
248+
* `get_chance`(search_items `list/file`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Chance` product for the given IDs, and optionally creates a csv file
249+
* `get_count_summary`(search_items `list/file`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Count-Summary` product for the given IDs, and optionally creates a csv file
250+
* `get_cumulative`(search_items `list/file`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Cumulative` product for the given IDs, and optionally creates a csv file
251+
* `get_count`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Probability Count` product for the given IDs, location_type, and optionally creates a csv file
230252

231253
<a name="historic"></a>
232254
#### [Historic](#toc)
@@ -237,9 +259,9 @@ The Historic API provides `Summary` and `Event` data for the given FSIDs.
237259
historic.<method>
238260
```
239261

240-
* `get_event`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Historic Event` product for the given historic IDs, and optionally creates a csv file
241-
* `get_events_by_location`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Historic Detail` product for the given IDs, location_type, and optionally creates a csv file
242-
* `get_summary`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Historic Summary` product for the given IDs, location_type, and optionally creates a csv file
262+
* `get_event`(search_items `list/file`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Historic Event` product for the given historic IDs, and optionally creates a csv file
263+
* `get_events_by_location`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Historic Detail` product for the given IDs, location_type, and optionally creates a csv file
264+
* `get_summary`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Historic Summary` product for the given IDs, location_type, and optionally creates a csv file
243265

244266
<a name="adaptation"></a>
245267
#### [Adaptation](#toc)
@@ -250,9 +272,9 @@ The Adaptation API provides `Summary` and `Project` data for the given FSIDs.
250272
adaptation.<method>
251273
```
252274

253-
* `get_project`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Adaptation Project` product for the given adaptation IDs, and optionally creates a csv file
254-
* `get_details_by_location`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Adaptation Project` product for the given IDs, location_type, and optionally creates a csv file
255-
* `get_summary`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Adaptation Summary` product for the given IDs, location_type, and optionally creates a csv file
275+
* `get_project`(search_items `list/file`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Adaptation Project` product for the given adaptation IDs, and optionally creates a csv file
276+
* `get_details_by_location`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Adaptation Project` product for the given IDs, location_type, and optionally creates a csv file
277+
* `get_summary`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Adaptation Summary` product for the given IDs, location_type, and optionally creates a csv file
256278

257279
<a name="fema"></a>
258280
#### [Fema](#toc)
@@ -263,7 +285,7 @@ The Fema API provides `NFIP` data for the given FSIDs.
263285
fema.<method>
264286
```
265287

266-
* `get_nfip`(fsids `list`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Fema NFIP` product for the given IDs, location_type, and optionally creates a csv file
288+
* `get_nfip`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Fema NFIP` product for the given IDs, location_type, and optionally creates a csv file
267289

268290
<a name="environmental"></a>
269291
#### [Environmental](#toc)
@@ -274,7 +296,7 @@ The Environmental API provides `Precipitation` data for the given FSIDs.
274296
environmental.<method>
275297
```
276298

277-
* `get_precipitation`(fsids `list`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Environmental Precipitation` product for the given county IDs, and optionally creates a csv file
299+
* `get_precipitation`(search_items `list/file`, csv `bool`, [core_limit `int=100`]) - Returns an array of `Environmental Precipitation` product for the given county IDs, and optionally creates a csv file
278300

279301
<a name="examples"></a>
280302
# [Examples](#toc)

0 commit comments

Comments
 (0)