Skip to content

Prototype Search API

eightysteele edited this page Sep 8, 2011 · 5 revisions

Prototype Search API

The prototype search API supports searching VertNet records by Darwin Core names and short names, full text, or a combination of the two. It also supports paging using standard limit/offset parameters.

Parameter Description Example
{name} Any number of Darwin Core name or short name value pairs year=1920&stateprovince=california
q Full text keywords separated by commas (",") q=bufo,alameda
limit Paging limit of results returned (default=10, max=100). limit=100
offset Paging offset that is provided as the next_offset property in each response offset=E9oBbJphdmVzAIuS
bb Return records within a bounding box (miny,minx,maxy,maxx) bb=-180,-90,180,90

###Example

GET /api/search?genus=calidris&country=usa&q=biogeomancer&limit=1

{
  "records":[
    {
      "georeferenceprotocol":"MaNIS/HerpNet/ORNIS Georeferencing Guidelines, GBIF Best Practices",
      "stateprovince":"California",
      "year":1904,
      "month":4,
      "county":"Alameda",
      "georeferencedby":"Kevin Epperly (UWBM)",
      "catalognumber":"07-248",
      "specificepithet":"jamaicensis",
      "locality":"Warm Springs, California",
      "institutioncode":"CRCM",
      "day":19,
      "verbatimcoordinatesystem":"decimal degrees",
      "scientificname":"Buteo jamaicensis",
      "recordedby":"Unknown",
      "georeferencesources":"BioGeomancer",
      "class":"Aves",
      "decimallongitude":-121.9183731,
      "decimallatitude":37.4833722,
      "occurrenceid":"CRCM:Birds:07-248",
      "country":"United States",
      "georeferenceverificationstatus":"requires verification",
      "collectioncode":"Birds",
      "eventdate":"1904-04-19",
      "verbatimeventdate":"19-Apr-1904",
      "genus":"Buteo",
      "coordinateuncertaintyinmeters":2993,
      "geodeticdatum":"WGS84"
    }
  ],
  "next_offset":"E9oBbJphdmVzAIuSUHVibGlzaGVyAKJtdnoAjIuSQ29sbGVjdGlvbgCiYmlyZHMAjIuSUmVjb3JkAKJjcmNtOmJpcmRzOjA3LTI0OACMi5JSZWNvcmRJbmRleACiY3JjbTpiaXJkczowNy0yNDgAjBQ="
}
Clone this wiki locally