Query filters

These filters can be applied by providing key-value pairs as part of the query string in your HTTP request, where the key is equal to the querystring_key entry below, and the value is formatted like one of the example_values. See Narrowing your query for examples.

class voeventdb.server.restapi.v1.filters.AuthoredSince[source]

Return only VOEvents with a Who.Date entry dated after the given time.

(Time-range is inclusive, i.e. >=)

Date-time strings passed should be in a format parseable by the iso8601.parse_date() function (see example_values).

querystring_key = 'authored_since'
example_values = ['2015-10-09T21:34:19', '2015-10-09', '2015-10']
class voeventdb.server.restapi.v1.filters.AuthoredUntil[source]

Return only VOEvents with a Who.Date entry dated before the given time.

(Time-range is inclusive, i.e. <=)

Date-time strings passed should be in a format parseable by the iso8601.parse_date() function (see example_values).

querystring_key = 'authored_until'
example_values = ['2015-10-09T21:34:19', '2015-10-09', '2015-10']
class voeventdb.server.restapi.v1.filters.CitedByAny[source]

Return only VOEvents which are cited by another VOEvent in the database.

Applied via query-strings cited=true or cited=false

querystring_key = 'cited'
example_values = ['true', 'false']
class voeventdb.server.restapi.v1.filters.ConeSearch[source]

Return only VOEvents with co-ords in the given cone.

Cone specified as a 3-element list in JSON format:

[ra,dec,radius]

(values in decimal degrees).

querystring_key = 'cone'
example_values = ['[10,20,5]', '[359.9,-30,5]']
class voeventdb.server.restapi.v1.filters.CoordsAny[source]

Return only VOEvents which have / do not have associated co-ord positions.

Applied via query-strings coord=true or coord=false

querystring_key = 'coord'
example_values = ['true', 'false']
class voeventdb.server.restapi.v1.filters.DecGreaterThan[source]

Return VOEvents with position with Dec greater than given value.

Dec should be specified in decimal degrees.

querystring_key = 'dec_gt'
example_values = ['0', '-45.123']
class voeventdb.server.restapi.v1.filters.DecLessThan[source]

Return VOEvents with position with Dec less than given value.

Dec should be specified in decimal degrees.

querystring_key = 'dec_lt'
example_values = ['0', '-45.123']
class voeventdb.server.restapi.v1.filters.IvornContains[source]

Return only VOEvents which have the given substring in their IVORN.

querystring_key = 'ivorn_contains'
example_values = ['BAT_GRB_Pos', 'XRT']
combinator(filters)[source]

AND

class voeventdb.server.restapi.v1.filters.IvornPrefix[source]

Return only VOEvents where the IVORN begins with the given value.

Note that the value passed should be URL-encoded if it contains the # character e.g.:

quote_plus('ivo://nvo.caltech/voeventnet/catot#1404')
querystring_key = 'ivorn_prefix'
example_values = ['ivo://nasa.gsfc.gcn', 'ivo%3A%2F%2Fnvo.caltech%2Fvoeventnet%2Fcatot%231404']
combinator(filters)[source]

OR

class voeventdb.server.restapi.v1.filters.RefAny[source]

Return only VOEvents which make / don’t make reference to any other VOEvents.

Applied via query-strings ref_any=true or ref_any=false. NB ‘true’/’false’ string-values are case-insensitive, so e.g. ‘true’, ‘True’, ‘TRUE’, ‘tRUe’ are all valid.

querystring_key = 'ref_any'
example_values = ['true', 'True', 'false']
class voeventdb.server.restapi.v1.filters.RefContains[source]

Return VOEvents which reference an IVORN containing the given substring.

querystring_key = 'ref_contains'
example_values = ['BAT_GRB_Pos', 'GBM_Alert']
combinator(filters)[source]

OR

class voeventdb.server.restapi.v1.filters.RefExact[source]

Return only VOEvents which contain a ref to the given (url-encoded) IVORN.

querystring_key = 'ref_exact'
example_values = ['ivo%3A%2F%2Fnasa.gsfc.gcn%2FSWIFT%23BAT_GRB_Pos_649113-680', 'ivo%3A%2F%2Fnasa.gsfc.gcn%2FFermi%23GBM_Alert_2015-08-10T14%3A49%3A38.83_460910982_1-814']
combinator(filters)[source]

OR

class voeventdb.server.restapi.v1.filters.RoleEquals[source]
querystring_key = 'role'
example_values = ['observation', 'utility', 'test']
combinator(filters)[source]

OR

class voeventdb.server.restapi.v1.filters.StreamEquals[source]
querystring_key = 'stream'
example_values = ['nasa.gsfc.gcn#SWIFT', 'nvo.caltech/voeventnet/catot']
combinator(filters)[source]

OR