You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 18, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -132,6 +132,10 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
132
132
133
133
Example: ```-l False```
134
134
135
+
- `[-e/--extra_param EXTRA_PARAM]`: [OPTIONAL] Adds the argument to the end of the endpoint call
136
+
137
+
Example: ```-e extra_param```
138
+
135
139
- `[-f/--file FILE]`: [OPTIONAL] A file of Search Items (one per line) to search for with the product
136
140
137
141
Example: ```-f sample.txt```
@@ -246,8 +250,8 @@ The Location API provides `Detail` and `Summary` data for the given SearchItems.
246
250
location.<method>
247
251
```
248
252
249
-
*`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
250
-
*`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
253
+
*`get_detail`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Location Detail` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
254
+
*`get_summary`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Location Summary` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
251
255
252
256
<a name="probability"></a>
253
257
#### [Probability](#toc)
@@ -260,11 +264,11 @@ The Probability API provides `Depth`, `Chance`, `Cumulative`, `Count` data for t
260
264
probability.<method>
261
265
```
262
266
263
-
*`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
264
-
*`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
265
-
*`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
266
-
*`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
267
-
*`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
267
+
*`get_depth`(search_items `list/file`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Probability Depth` product for the given IDs, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
268
+
*`get_chance`(search_items `list/file`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Probability Chance` product for the given IDs, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
269
+
*`get_count_summary`(search_items `list/file`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Probability Count-Summary` product for the given IDs, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
270
+
*`get_cumulative`(search_items `list/file`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Probability Cumulative` product for the given IDs, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
271
+
*`get_count`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Probability Count` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
268
272
269
273
<a name="historic"></a>
270
274
#### [Historic](#toc)
@@ -277,9 +281,9 @@ The Historic API provides `Summary` and `Event` data for the given SearchItems.
277
281
historic.<method>
278
282
```
279
283
280
-
*`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
281
-
*`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
282
-
*`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
284
+
*`get_event`(search_items `list/file`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Historic Event` product for the given historic IDs, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
285
+
*`get_events_by_location`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Historic Detail` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
286
+
*`get_summary`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Historic Summary` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
283
287
284
288
<a name="adaptation"></a>
285
289
#### [Adaptation](#toc)
@@ -292,9 +296,9 @@ The Adaptation API provides `Summary` and `Project` data for the given SearchIte
292
296
adaptation.<method>
293
297
```
294
298
295
-
*`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
296
-
*`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
297
-
*`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
299
+
*`get_project`(search_items `list/file`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Adaptation Project` product for the given adaptation IDs, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
300
+
*`get_details_by_location`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Adaptation Project` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
301
+
*`get_summary`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Adaptation Summary` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
298
302
299
303
<a name="fema"></a>
300
304
#### [Fema](#toc)
@@ -307,7 +311,7 @@ The Fema API provides `NFIP` data for the given SearchItems.
307
311
fema.<method>
308
312
```
309
313
310
-
*`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
314
+
*`get_nfip`(search_items `list/file`, location_type `string`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Fema NFIP` product for the given IDs, location_type, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
311
315
312
316
<a name="environmental"></a>
313
317
#### [Environmental](#toc)
@@ -320,7 +324,7 @@ The Environmental API provides `Precipitation` data for the given SearchItems.
320
324
environmental.<method>
321
325
```
322
326
323
-
*`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
327
+
*`get_precipitation`(search_items `list/file`, csv `bool`, [core_limit `int=100`], [extra_param `str=None`]) - Returns an array of `Environmental Precipitation` product for the given county IDs, and optionally creates a csv file. Arguments provided to `extra_param` will be appened to the end of the endpoint call
0 commit comments