Search Items

Search Item Types:

For most products, 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. (More information on the Lookup types can be found on the Lookups Page on the First Street Foundation API Data Dictionary)

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

2. Lat/Lng (tuple of float): 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)

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

Tiles Product:

In the case of the Tiles Product, there is a different type for the search items:

4. Coordinates (list of tuple): The input is a tuple of zoom, X and Y coordinate. The X and Y value is based on the Mercator Projection. Example: (12,932,1715), (12,942,1715)

Search Item Usage Format:

Depending on the method used to run the library and products, the format used to represent the types can be different. The examples below show how the search_items should be represented for different input methods. Different search item types can be freely mixed together in the same product call assuming that they have the same location type (if applicable).

ie: A list of both property addresses and county FSIDs will not work.

---

Example 1 (Python list of search items):

lst = [362493883, (40.792505, -73.951949), "1220 5th Ave, New York, NY"]

Example 2 (Command line argument for list of search items):

-s 362493883;(40.792505,-73.951949);"1220 5th Ave, New York, NY"

Example 3 (File of search items):

362493883
(40.792505, -73.951949)
1220 5th Ave, New York, NY

Example 4 (Python list of Tile search items):

lst = [(12,932,1715), (12,942,1715)]

Example 5 (Command line argument for list of Tile search items):

-s (12,932,1715);(12,942,1715)

Example 6 (File of Tile search items):

(12,932,1715)
(12,942,1715)