Skip to content

Query Format

Jump to bottom Edit New page
godfoder edited this page Oct 8, 2014 · 28 revisions

iDigBio Query Format

The iDigBio query format is intended to be an easy to write query format for our APIs. Its basic structure consists of a JSON dictionary, with one or more top-level keys that reference fields in our indexes (See: Index Fields)

A basic multi-field query looks like this:

{
    "scientificname": {
        "type": "exists"
    },
    "family": "asteraceae"
}

All Fields

Searching for a field being present in the record

{
  "scientificname": {
    "type": "exists"
  }
}

Full text searching

{
  "data": {
    "type": "fulltext",
    "value": "aster"
  }
}

Searching for a value within a field

{
  "family": "asteraceae"
}

Searching for multiple values within a field

{
  "family": [
    "asteraceae",
    "fagaceae"
  ]
}

Boolean Fields

Searching for a boolean value

{
  "hasImage": true
}

Numeric Fields

Searching within a range for a numeric field

{
  "minelevation": {
    "type": "range",
    "gte": "100",
    "lte": "200"
  }
}

Date Fields

Searching within a range on a date field

{
  "type": "range",
  "gte": "1800-01-01",
  "lte": "1900-01-01"
}

Geographic Point Fields

Searching within a bounding box on a point field

{
  "geopoint": {
    "type": "geo_bounding_box",
    "top_left": {
      "lat": 19.23,
      "lon": -130
    },
    "bottom_right": {
      "lat": -45.1119,
      "lon": 179.99999
    }
  }
}
Add a custom footer
Add a custom sidebar
Clone this wiki locally