/** * This file was auto-generated on 2023-10-24T15:44:49.834Z * flickr.photos.search * Return a list of photos matching some criteria. Only photos visible to the calling user will be returned. To return private or semi-private photos, the caller must be authenticated with 'read' permissions, and have permission to view the photos. Unauthenticated calls will only return public photos. * Permissions required: none */ export type FlickrPhotosSearchParams = { /** * The NSID of the user who's photo to search. If this parameter isn't passed then everybody's public photos will be searched. A value of "me" will search against the calling user's photos for authenticated calls. */ user_id?: string; /** * A comma-delimited list of tags. Photos with one or more of the tags listed will be returned. You can exclude results that match a term by prepending it with a - character. */ tags?: string; /** * Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified. */ tag_mode?: string; /** * A free text search. Photos who's title, description or tags contain the text will be returned. You can exclude results that match a term by prepending it with a - character. */ text?: string; /** * Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date can be in the form of a unix timestamp or mysql datetime. */ min_upload_date?: string; /** * Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date can be in the form of a unix timestamp or mysql datetime. */ max_upload_date?: string; /** * Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date can be in the form of a mysql datetime or unix timestamp. */ min_taken_date?: string; /** * Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date can be in the form of a mysql datetime or unix timestamp. */ max_taken_date?: string; /** * The license id for photos (for possible values see the flickr.photos.licenses.getInfo method). Multiple licenses may be comma-separated. */ license?: string; /** * The order in which to sort returned photos. Defaults to date-posted-desc (unless you are doing a radial geo query, in which case the default sorting is by ascending distance from the point specified). The possible values are: date-posted-asc, date-posted-desc, date-taken-asc, date-taken-desc, interestingness-desc, interestingness-asc, and relevance. */ sort?: string; /** * Return photos only matching a certain privacy level. This only applies when making an authenticated call to view photos you own. Valid values are: */ privacy_filter?: string; /** * A comma-delimited list of 4 values defining the Bounding Box of the area that will be searched.

The 4 values represent the bottom-left corner of the box and the top-right corner, minimum_longitude, minimum_latitude, maximum_longitude, maximum_latitude.

Longitude has a range of -180 to 180 , latitude of -90 to 90. Defaults to -180, -90, 180, 90 if not specified.

Unlike standard photo queries, geo (or bounding box) queries will only return 250 results per page.

Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component.

A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future). */ bbox?: string; /** * Recorded accuracy level of the location information. Current range is 1-16 : Defaults to maximum value if not specified. */ accuracy?: string; /** * Safe search setting: (Please note: Un-authed calls can only see Safe content.) */ safe_search?: string; /** * Comma-separated list of content types to return. If used in conjunction with video_content_types, this is applied to only photos. If video_content_types is not specified, this filter will apply to all media types */ content_types?: string; /** * Comma-separated list of video content types to return. If specified without content_types, ensure that the media argument is not set to 'photos' or no results will be returned */ video_content_types?: string; /** * Aside from passing in a fully formed machine tag, there is a special syntax for searching on specific properties : Multiple machine tags may be queried by passing a comma-separated list. The number of machine tags you can pass in a single query depends on the tag mode (AND or OR) that you are querying with. "AND" queries are limited to (16) machine tags. "OR" queries are limited to (8). */ machine_tags?: string; /** * Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified. */ machine_tag_mode?: string; /** * The id of a group who's pool to search. If specified, only matching photos posted to the group's pool will be returned. */ group_id?: string; /** * Search your contacts. Either 'all' or 'ff' for just friends and family. */ contacts?: string; /** * A 32-bit identifier that uniquely represents spatial entities. (not used if bbox argument is present).

Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component.

A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future). */ woe_id?: string; /** * A Flickr place id. (not used if bbox argument is present).

Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component.

A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future). */ place_id?: string; /** * Filter results by media type. Possible values are all (default), photos or videos */ media?: string; /** * Any photo that has been geotagged, or if the value is "0" any photo that has not been geotagged.

Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component.

A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future). */ has_geo?: string; /** * Geo context is a numeric value representing the photo's geotagginess beyond latitude and longitude. For example, you may wish to search for photos that were taken "indoors" or "outdoors".

The current list of context IDs is :



Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component.

A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future). */ geo_context?: string; /** * A valid latitude, in decimal format, for doing radial geo queries.

Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component.

A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future). */ lat?: string; /** * A valid longitude, in decimal format, for doing radial geo queries.

Geo queries require some sort of limiting agent in order to prevent the database from crying. This is basically like the check against "parameterless searches" for queries without a geo component.

A tag, for instance, is considered a limiting agent as are user defined min_date_taken and min_date_upload parameters — If no limiting factor is passed we return only photos added in the last 12 hours (though we may extend the limit in the future). */ lon?: string; /** * A valid radius used for geo queries, greater than zero and less than 20 miles (or 32 kilometers), for use with point-based geo queries. The default value is 5 (km). */ radius?: string; /** * The unit of measure when doing radial geo queries. Valid options are "mi" (miles) and "km" (kilometers). The default is "km". */ radius_units?: string; /** * Limit the scope of the search to only photos that are part of the Flickr Commons project. Default is false. */ is_commons?: string; /** * Limit the scope of the search to only photos that are in a gallery? Default is false, search all photos. */ in_gallery?: string; /** * Limit the scope of the search to only photos that are for sale on Getty. Default is false. */ is_getty?: string; /** * DEPRECATED. Use content_types instead. Content Type setting: */ content_type?: string; /** * A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o */ extras?: string; /** * Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500. */ per_page?: string; /** * The page of results to return. If this argument is omitted, it defaults to 1. */ page?: string; };