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

Commit 0b427d1

Browse files
committed
Modify readme
1 parent d09971b commit 0b427d1

File tree

2 files changed

+20
-16
lines changed

2 files changed

+20
-16
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ The First Street Foundation API Access (Python) is a wrapper used to bulk extrac
132132

133133
Example: ```-l False```
134134

135+
- `[-e/--extra_param EXTRA_PARAM]`: [OPTIONAL] Adds the argument to the end of the endpoint call
136+
137+
Example: ```-e extra_param```
138+
135139
- `[-f/--file FILE]`: [OPTIONAL] A file of Search Items (one per line) to search for with the product
136140

137141
Example: ```-f sample.txt```
@@ -246,8 +250,8 @@ The Location API provides `Detail` and `Summary` data for the given SearchItems.
246250
location.<method>
247251
```
248252

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
251255

252256
<a name="probability"></a>
253257
#### [Probability](#toc)
@@ -260,11 +264,11 @@ The Probability API provides `Depth`, `Chance`, `Cumulative`, `Count` data for t
260264
probability.<method>
261265
```
262266

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
268272

269273
<a name="historic"></a>
270274
#### [Historic](#toc)
@@ -277,9 +281,9 @@ The Historic API provides `Summary` and `Event` data for the given SearchItems.
277281
historic.<method>
278282
```
279283

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
283287

284288
<a name="adaptation"></a>
285289
#### [Adaptation](#toc)
@@ -292,9 +296,9 @@ The Adaptation API provides `Summary` and `Project` data for the given SearchIte
292296
adaptation.<method>
293297
```
294298

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
298302

299303
<a name="fema"></a>
300304
#### [Fema](#toc)
@@ -307,7 +311,7 @@ The Fema API provides `NFIP` data for the given SearchItems.
307311
fema.<method>
308312
```
309313

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
311315

312316
<a name="environmental"></a>
313317
#### [Environmental](#toc)
@@ -320,7 +324,7 @@ The Environmental API provides `Precipitation` data for the given SearchItems.
320324
environmental.<method>
321325
```
322326

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
324328

325329
<a name="examples"></a>
326330
# [Examples](#toc)

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
setup(
1313
name='fsf-api-access_python',
14-
version='1.2.0',
14+
version='1.3.1',
1515
description='A Python API Access Client for the First Street Foundation API',
1616
url='https://github.com/FirstStreet/fsf_api_access_python',
1717
project_urls={

0 commit comments

Comments
 (0)