GET

/visibility_plots

show/hide

Description

Provides an assessment of the visiblity for the next month according to the source coordinates and observer position.

For an introduction to the visibility plot check our YouTube tutorial.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
pos	None	List	?pos=[98.8,35.2]	True	Position of the source in ra (degree), dec(degree)
pos_obs	[-23.27,16.5,1835], i.e. H.E.S.S.	List	&pos_obs=[98.8,35.2,1100]	False	Position of the observer/observatory in lattitude (degree), longitude (degree) and altitude (m)
date	current date	String	&date=2019-08-29	False	date of the visibility assessment

Response fields

Field	Type	Description
img_url	String	Link to the monthly visibility plot image
storage_url	String	Link to the monthly visibility plot image
url	String	Url giving informations on the next month visibility (plot and summary) of the source on MPIK website

JSON response

{
"img_url": "string",
"storage_url": "string",
"url": "string"
}

Usage example

https://astro-colibri.science/visibility_plots?pos=[44.54,-8.96]&pos_obs=[-23.27,16.5,1835]&date=2019-08-29

GET

/visibility_plots_detailed

show/hide

Description

Gives the visibility plot for the next night according to the source coordinates and observer position. Time resolution is 1min. For an introduction to the visibility plot check our YouTube tutorial.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
pos_src	None	List	?pos=[98.8,35.2]	True	Position of the source in ra (degree), dec (degree)
pos_obs	[-23.27,16.5,1835], i.e. H.E.S.S.	List	&pos_obs=[98.8,35.2,1100]	False	Position of the observer/observatory in lattitude (degree), longitude (degree) and altitude (m)
twilight_level	2	String	&twilight_level=2	False	twilight_level=0 or 1 or 2. Note: 0 means no twilight will be drawn, 1 means twilight will be drawn, 2 means civil, naval and astronomical twilight will be drawn respectively
date	current date	String	&date=2019-08-29	False	date of the visibility assessment
source_name	""	String	&source_name=GRB 190829A	False	name of the source

Response fields

Field	Type	Description
img_url	String	Link to the next night visibility plot

JSON response

{
"img_url": "string",
}

Usage example

https://astro-colibri.science/visibility_plots_detailed?pos_src=%5B44.54,-8.96%5D&pos_obs=%5B-23.27,16.5,1835%5D&source_name=GRB%20190829A&date=2019-08-29

GET

/multi_observatory_visibility_plot

show/hide

Description

Gives the daily visibility at multiple observatories for the next night according to the source coordinates and observatories positions. Time resolution is 10min.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
pos_src	None	List	?pos=[98.8,35.2]	True	Position of the source in ra (degree), dec (degree)
source_name	""	String	?source_name=GRB 190829A	False	name of the source
date	current date	String	?date=2019-08-29	False	date of the visibility assessment
observers	""	String	?observers=[OHP,ASKAP,ATCA]	False	List of observatories for which we want to compute the visibility plot.

Response fields

Field	Type	Description
img_url	String	Link to the visibility plot at multiple observatories

JSON response

{
"img_url": "string",
}

Usage example

https://astro-colibri.science/multi_observatory_visibility_plot?pos_src=%5B44.54,-8.96%5D&&source_name=GRB%20190829A&date=2019-08-29&observers=%5BH.E.S.S.,MAGIC,ATCA,VLT%20Paranal%5D

POST

/cone_search

show/hide

Description

Returns a list of cataloqued sources and transients events within a cone of given radius around a position and within a given time window. All arguments should be put in a json body. You can play with our notebook to learn how to use the cone search endpoint.

Rate limits: to keep the API availalbe for everybody we limit the usage of this endpoint to registered Astro-COLIBRI users. Check this short tutorial about how to register. You'll find your user-id in your account settings in our interfaces. Copy it as "uid" parameter into the body of your API request. At the moment, each user is granted 100 request per day. If this is not sufficient for your use-case, please get in contact with us.

Body Parameters

Level 1 parameter	Level 2 parameter	Level 3 parameter	Default	Type	Required	Description
properties	position	ra	None	Float	True	Position of the center of the search region in RA
properties	position	dec	None	Float	True	Position of the center of the search region in Dec
properties	radius		None	Float	True	Radius of the search region
time_range	min		None	String	True	Minimum date in isoformat
time_range	max		None	String	True	Maximum date in isoformat
filter			None	JSON	False	The filter structure (see interactive notebook for details). If the 'filter' parameter is not specified, the application will use your 'uid' to retrieve the filter configuration from your member space in the Astro-COLIBRI application
uid			None	String	False	Your Astro-COLIBRI user id
return_format			json	String	False	"json" or "url", the latter providing an url to the json results

Response fields

sources

show/hide

catalogued sources (see documentation for details about the used catalogs); most of the field refer to the Fermi-LAT 4FGL-DR3 catalog

Field	Type	Description
analysis_flags	Integer	analysis flags to indicate possible issues noted in the detection or characterization of the source. A value of 0 indicates no known problem.
assoc	String	The designation of the identified or likely associated source.
assoc_4fgl	String	identifier in the 4FGL catalog
assoc_fgl	String	identifier in the previous FGL catalog
assoc_fhl	String	identifier in the FHL catalog
assoc_gam1	String	Most recent correspondence to previous FGL source catalogs, if any.
assoc_gam2	String	Most recent correspondence to previous FHL source catalogs, if any.
assoc_gam3	String	Name of likely corresponding source from AGL source catalogs, if any.
assoc_prob_bay	Float	The probability of association according to the Bayesian method. It is set to NULL for extended sources (which do not enter that calculation) and to 0 for point sources that did not reach 0.8, the threshold for declaring associations.
assoc_prob_lr	Float	The probability of association according to the Likelihood Ratio method. It is set to NULL for extended sources (which do not enter that calculation) and to 0 for point sources that did not reach 0.8, the threshold for declaring associations.
assoc_tev	String	The designation of the likely corresponding source from the TeVCat catalog, if any.
conf_95_major	Float	The semi-major axis of the error ellipse at 95% confidence [deg]
conf_95_minor	Float	The semi-minor axis of the error ellipse at 95% confidence [deg]
date	Date	Date of the event (typically empty)
dec	Float	Dec position [deg]
detection_significance	Float	The source detection significance, in Gaussian sigma units, over the 100 MeV to 1 TeV band.
energy_flux100	Float	The integral photon flux for 1 - 100 GeV [photons/cm2/s]
energy_flux100_err	Float	The 1-sigma uncertainty in the integral photon flux for 1 - 100 GeV [photons/cm2/s]
flux_peak	Float	peak integral photon flux from 100 MeV to 100 GeV [photon/cm2/s]
flux_peak_error	Float	1-sigma uncertainty in the peak integral photon flux from 100 MeV to 100 GeV [photon/cm2/s]
frac_variability	Float	The fractional variability computed from the fluxes in each year.
frac_variability_error	Float	1-sigma error on the fractional variability computed from the fluxes in each year.
latest_lc_url	String (url)	URL pointing to the latest light curve (typically FLaapLUC, access restricted to H.E.S.S. members)
longterm_lc_url	String (url)	URL pointing to the longterm light curve (typically FLaapLUC, access restricted to H.E.S.S. members)
pivot_energy	Float	The energy, in MeV, at which the error in the differential photon flux is minimal (i.e., the decorrelation energy for the power-law fit). This is derived from the likelihood analysis for 100 MeV - 1 TeV.
ra	Float	RA position of the source [deg]
redshift	Float	redshift of the source
sep	Float	Separation from the center of the cone search
simbad_link	String (url)	Link to the source in Simbad database
source_class	String	Class of the source
source_name	String	Name of the source
source_type	String	The primary class designation of the identification or likely associated source.
spectrum_type	String	The spectral type in the global model (PowerLaw, LogParabola, PLSuperExpCutoff).
tevcat_flag	String	lag parameter indicates a possible association with the TeVCat. The flag values have the following meanings: N = No TeV association; P = Small TeV source; E = Extended TeV source (diameter > 40 arcminutes)
tevcat_url	String (url)	URL to the TeVCat interface of the source
time_peak	Float	Time of center of interval in which peak flux was measured [MJD]
time_peak_interval	Float	Length of interval in which peak flux was measured, in seconds.
variability_index	Float	The sum of the log(likelihood) difference between the flux fitted in each time interval and the average flux over the full catalog interval; a value greater than 18.48 over 12 intervals indicates <1% chance of being a steady source. See the accompanying paper for details.

voevents

show/hide

transient events (see documentation for details about source classes, etc.)

Field	Type	Description
alert_type	String	type of the notice (GWs: EarlyWarning, Preliminary, Initial, Update, Retraction; GBM: Gnd_Pos, Fin_Pos, etc.) /td>
archive	dict	dictionary of {archive_id : last_modified} that lists all previous versions of this event
archive_id	String	identifier of the event in the Astro-COLIBRI archive
assoc	String	Associated sources of the event (if known)
broker	String	Name of the broker/classifier that characterized or submitted the event (if known)
classification	String	classification of the transient; can be seen as sub-class of the "type" field (e.g. classification of the type of a SN, etc.)
comment	String	comment about the event/source
constellation	String	astronomical constellation in which the event is located
dec	Float	Dec position [deg]
discoverer_internal_name	String	name used by the discovery observatory
dm	String	Dispersion measure (mainly for FRBs); string because it contains units
energy	String	Energy of the event [GeV]
energy_time_url	String (url)	2D distribution of Fermi-LAT photons in the “energy vs time” plane
err	Float	Uncertainty of the event position [deg]
extinction_ebv	Float	E(B-V): redding to Galactic dust absorption
far	String	False-Alarm-Rate [year^-1]
follow_up	Array	list of observatories participating in follow up observations (if known)
gw_BBH	String	GW event classification: probability of being a binary black hole merger event [0..1]
gw_BNS	String	GW event classification: probability of being a binary neutron star merger event [0..1]
gw_MassGap	String	GW event classification: probability that at least one compact object with a mass in the hypothetical “mass gap” between neutron stars and black holes (3-5 solar masses) [0..1]
gw_NSBH	String	GW event classification: probability of being a merger of a system composed of one neutron star and one black hole [0..1]
gw_Noise	String	GW event classification: terrestrial noise [0..1]
gw_contours	Array	GW event localisation contours: 50% and 90% containement
gw_hasNS	Boolean	GW events: flag to indicate the presence of a component with a mass compatible with a neutron star
gw_pipeline	String	GW events: name of the pipeline used to derive the event parameters
instrument	String	Name of the instrument providing the parameters of the event (e.g. XRT or BAT for Swift detected events, etc.)
ivorn	String	Unique IVOA identifiers for event
ivorn_time	String	Time of the creation of the VoEvent
last_modified	String	Time of the modification of this event in Astro-COLIBRI
latest_lc_url	String (url)	Latest lightcurve url
lc_url	String (url)	lightcurve url (typically FLaapLUC, access restricted to H.E.S.S. members)
longterm_lc_url	String (url)	Longterm lightcurve url (typically FLaapLUC, access restricted to H.E.S.S. members)
map_areas	Dict	dict with credible levels and the contained area in a localisation map
observatory	String	Observatory at the orign of the event
pkt_ser_num	Float	A number that increments by 1 each time a new revision is issued for this event
ra	Float	RA position of the source [deg]
redshift	Float	redshift of the event
reference	String	Reference to original VoEvent in case of updates (if available)
sed_url	String (url)	Link to SED (typically FLaapLUC, access restricted to H.E.S.S. members)
sep	Float	Separation from the center of the cone search [deg]
signalness	String	Probability of being of astrophysical origin (mainly for IceCube events)
significance	Float	significance of the detected emission [sigma]
simbad_link	String (url)	Link to the source in Simbad database
slew	Boolean	Flag to indicate that the event triggered a slew of the spacecraft (typically SVOM)
source_name	String	Name of the source
sun_distance	Float	angular distance of the source to the sun at the time of the event [deg]
timestamp	Datetime	Time of the event ([UTC], unix timestamp in milliseconds)
transient_flux	Float	flux of the detected transient
transient_flux_error	Float	uncertainty on the flux of the detected transient
transient_flux_units	String	units of the flux of the detected transient
trigger_id	String	Trigger ID of the event (internal to Astro-COLIBRI)
type	String	type of event (see documentation for details )
url	String (url)	URL to additional ressource (typically the GCN circular or ATEL for manually added information)
url_name	String	name of the URL to additional ressources

xsources

show/hide

catalogued SGR and AXPs (see documentation for details about the used catalogs)

Field	Type	Description
B	Float	surface B-field [10^14 G]
Period	Float	period P [s]
age	Float	characteristic age (tau_c = P / 2 dP/dt; P being the period) [kyr]
assoc	String	associated sources (if known)
dec	Float	Dec position [deg]
dedt	Float	energy loss (dE/dt = 4pi^2 I dP/dt / P^3; with the moment of inertia assumed to be 10^45 g cm^2) [10^33 erg/s]
distance	Float	distance [kpc]
dpdt	Float	period derivative dP/dt [10^-11 s/s]
latest_lc_url	String (url)	Latest light curve url (typically FLaapLUC, access restricted to H.E.S.S. members)
longterm_lc_url	String (url)	Longterm light curve url (typically FLaapLUC, access restricted to H.E.S.S. members)
ra	Float	RA position of the source [deg]
sep	Float	Separation from the cone search center
simbad_link	String (url)	Link to the source in Simbad database
source_name	String	Name of the source
type	String	type of event (see documentation for details )

icecat

show/hide

catalogued high-energy neutrinos (see documentation for details about the used catalogs)

Field	Type	Description
amon_id	Float	global ID build from run_id and event_id
run_id	Float	ID of the IceCube run
event_id	Float	ID of the event within a run
trigger_id	String	trigger_id of the event ('IceCat1_' + amon_id)
source_name	String	Unique name given to each alert, in form ICYYMMDDA
ra	Float	RA position of the source in J2000 equatorial coordinates [deg]
dec	Float	Dec position in J2000 equatorial coordinates [deg]
sep	Float	Separation from the cone search center
ra_err_minus	Float	Uncertainty in the RA position of the source, 90% CL [deg]
ra_err_plus	Float	Uncertainty in the RA position of the source, 90% CL [deg]
dec_err_minus	Float	Uncertainty in the Dec position of the source, 90% CL [deg]
dec_err_plus	Float	Uncertainty in the Dec position of the source, 90% CL [deg]
err	Float	Average uncertainty of the position of the source, 90% CL [deg]
time	String	Date and time of the event detection ("YYYY-MM-DD HH-MM-SS")
event_mjd	Float	Modified Julian Date of the time of the event detection
alert_type	String	Identification of event selection type (see supporting paper publication for details). gfu-gold, gfu-bronze, ehe-gold, hese-gold, or hese-bronze types
energy	Float	Most probable neutrino energy that would have produced this event. Calculated assuming an E^(-2.19) astrophysical neutrino power law flux. [TeV]
far	Float	Rate of background events expected for alert events at this energy and sky location. [yr^(-1)]
signalness	Float	Probability event is of astrophysical origin, calculated assuming an E^(-2.19) astrophysical neutrino power law flux. [probability]
cascade_scr	Float	Primary event vertex is inside the instrumented volume and a shower (non-muon-like track) is observed [probability]
skimming_scr	Float	Primary event vertex outside is the detector and little or no energy deposited within instrumented volume [probability]
start_scr	Float	Primary event vertex is inside the instrumented volume and a muon-like track is seen [probability]
stop_scr	Float	Primary event vertex outside is the detector and a muon-like track is observed stopping in the instrumented volume [probability]
thrgoing_scr	Float	Primary event vertex outside is the detector and a muon-like track is observed passing through the instrumented volume [probability]
cr_veto	Boolean	Significant in-time cosmic-ray shower activity detected in the surface IceTop array, indicating this event is likely a background event.

JSON response

source : [{ "assoc": "string", "comment": "string", "dec": 0, "dm": "string", "energy": "string", "energy_time_url": "string", "err": 0, "far": "string", "ivorn": "string", "ivorn_time": "string", "lc_url": "string", "observatory": "string", "pkt_ser_num": 0, "ra": 0, "reference": "string", "sed_url": "string", "sep": 0, "signalness": "string", "simbad_link": "string", "source_name": "string", "timestamp": 0, "trigger_id": "string", "type": "string" }, ...]

POST

/latest_transients

show/hide

Description

Returns a list transients events within a given time window. All arguments should be put in a json body. You can play with our notebook to learn how to use the latest transients endpoint.

Rate limits: to keep the API availalbe for everybody we limit the usage of this endpoint to registered Astro-COLIBRI users. Check this short tutorial about how to register. You'll find your user-id in your account settings in our interfaces. Copy it as "uid" parameter into the body of your API request. At the moment, each user is granted 100 request per day. If this is not sufficient for your use-case, please get in contact with us.

Body Parameters

Level 1 parameter	Level 2 parameter	Default	Type	Required	Description
time_range	min	None	String	True	Minimum date in isoformat
time_range	max	None	String	True	Maximum date in isoformat
filter		None	JSON	False	The filter structure (see the interactive notebook for details). If the 'filter' parameter is not specified, the application will use your 'uid' to retrieve the filter configuration from your member space in the Astro-COLIBRI application
uid		None	String	True	Your Astro-COLIBRI user id
return_format		json	String	False	"json" or "url", the latter providing an url to the json results

Response fields:

voevents

show/hide

transient events (see documentation for details about source classes, etc.)

Field	Type	Description
alert_type	String	type of the notice (GWs: EarlyWarning, Preliminary, Initial, Update, Retraction; GBM: Gnd_Pos, Fin_Pos, etc.) /td>
archive	dict	dictionary of {archive_id : last_modified} that lists all previous versions of this event
archive_id	String	identifier of the event in the Astro-COLIBRI archive
assoc	String	Associated sources of the event (if known)
broker	String	Name of the broker/classifier that characterized or submitted the event (if known)
classification	String	classification of the transient; can be seen as sub-class of the "type" field (e.g. classification of the type of a SN, etc.)
comment	String	comment about the event/source
constellation	String	astronomical constellation in which the event is located
dec	Float	Dec position [deg]
discoverer_internal_name	String	name used by the discovery observatory
dm	String	Dispersion measure (mainly for FRBs); string because it contains units
energy	String	Energy of the event [GeV]
energy_time_url	String (url)	2D distribution of Fermi-LAT photons in the “energy vs time” plane
err	Float	Uncertainty of the event position [deg]
extinction_ebv	Float	E(B-V): redding to Galactic dust absorption
far	String	False-Alarm-Rate [year^-1]
follow_up	Array	list of observatories participating in follow up observations (if known)
gw_BBH	String	GW event classification: probability of being a binary black hole merger event [0..1]
gw_BNS	String	GW event classification: probability of being a binary neutron star merger event [0..1]
gw_MassGap	String	GW event classification: probability that at least one compact object with a mass in the hypothetical “mass gap” between neutron stars and black holes (3-5 solar masses) [0..1]
gw_NSBH	String	GW event classification: probability of being a merger of a system composed of one neutron star and one black hole [0..1]
gw_Noise	String	GW event classification: terrestrial noise [0..1]
gw_contours	Array	GW event localisation contours: 50% and 90% containement
gw_hasNS	Boolean	GW events: flag to indicate the presence of a component with a mass compatible with a neutron star
gw_pipeline	String	GW events: name of the pipeline used to derive the event parameters
instrument	String	Name of the instrument providing the parameters of the event (e.g. XRT or BAT for Swift detected events, etc.)
ivorn	String	Unique IVOA identifiers for event
ivorn_time	String	Time of the creation of the VoEvent
last_modified	String	Time of the modification of this event in Astro-COLIBRI
latest_lc_url	String (url)	Latest lightcurve url
lc_url	String (url)	lightcurve url (typically FLaapLUC, access restricted to H.E.S.S. members)
longterm_lc_url	String (url)	Longterm lightcurve url (typically FLaapLUC, access restricted to H.E.S.S. members)
map_areas	Dict	dict with credible levels and the contained area in a localisation map
observatory	String	Observatory at the orign of the event
pkt_ser_num	Float	A number that increments by 1 each time a new revision is issued for this event
ra	Float	RA position of the source [deg]
redshift	Float	redshift of the event
reference	String	Reference to original VoEvent in case of updates (if available)
sed_url	String (url)	Link to SED (typically FLaapLUC, access restricted to H.E.S.S. members)
sep	Float	Separation from the center of the cone search [deg]
signalness	String	Probability of being of astrophysical origin (mainly for IceCube events)
significance	Float	significance of the detected emission [sigma]
simbad_link	String (url)	Link to the source in Simbad database
slew	Boolean	Flag to indicate that the event triggered a slew of the spacecraft (typically SVOM)
source_name	String	Name of the source
sun_distance	Float	angular distance of the source to the sun at the time of the event [deg]
timestamp	Datetime	Time of the event ([UTC], unix timestamp in milliseconds)
transient_flux	Float	flux of the detected transient
transient_flux_error	Float	uncertainty on the flux of the detected transient
transient_flux_units	String	units of the flux of the detected transient
trigger_id	String	Trigger ID of the event (internal to Astro-COLIBRI)
type	String	type of event (see documentation for details )
url	String (url)	URL to additional ressource (typically the GCN circular or ATEL for manually added information)
url_name	String	name of the URL to additional ressources

GET

/known_sources

show/hide

Field	Type	Description
source	List	List of String corresponding to all sources names

GET

/atels

show/hide

Description

Provides a list of Astronomers Telegrams associated with a given source. The search relies on the Astrophysics Data System (ADS), which introduces a delay of ~2weeks between publication and availability of new ATELs.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
source	None	integer	?source=TXS 0506+056	True	the name of an astrophysical source

Response fields

Field	Type	Description
date	String	date of the ATEL
title	String	title of the found ATEL
url	String	url to the ATEL

JSON response

{
"date": "string",
"title": "string",
"url": "string",
}

Usage example

https://astro-colibri.science/atels?source=TXS%200506+056

GET

/lightcurve

show/hide

Description

Produces a figure showing the lightcurve of the event identified by its trigger_id as recorded by a number of optical survey instrumeents. Currently we support data from ATLAS, ASAS-SN, and ZTF (via the Fink broker). By default, the requested time range is starting 5 days before and up to 30 days after the detection of the event. The actual range shown in the produced plot may vary depending on the availability of data. The requested time range can be configured using the optional parameters 'start' and 'end'. Each parameter configuration is producing one figure each day. If the requested plot is not found in the archive, a new one is produced. The calculation of a new lightcurve figure is affecting the daily rate limits of each user (see "Cone search and latest transients" above). Details can be found here: lightcurve documentation.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
trigger_id	None	string	trigger_id=TNS2024igg	False	Provide a valid Astro-COLIBRI trigger_id to identify a transient event (or provide RA/Dec)
ra	None	string	ra=64.35	False	Provide a right ascension in degrees
dec	None	string	dec=64.35	False	Provide a declination in degrees
uid	None	string	uid=0bLAEeOfGaf6QeZBpVGaB6XSYuX2	True	Your Astro-COLIBRI user id (see Menu/Account/Account details)
start	trigger_id: 5 days before the selected event RA/Dec: 30d before today	string	start=2024-05-02	False	Start of the requested time window
end	trigger_id: 30d after the selected event RA/Dec: today	string	end=2024-06-06	False	End of the requested time window

Response fields

Field	Type	Description
url	String	Link to the lightcurve

JSON response

{
"url": "string",
}

Usage example

https://astro-colibri.science/lightcurve?trigger_id=TNS2024igg&uid=0bLAEeOfGaf6QeZBpVGaB6XSYuX2&start=2024-05-02&end=2024-06-06

GET

/swift_xrt_lightcurve

show/hide

Description

Produces a figure showing the Swift-XRT lightcurve of the event identified by its trigger_id in context of archival Swift detected GRBs. A few bursts detected in VHE gamma-ray are shown for reference. By default (force=False), the figure is created once every hour, but an update can be requested by setting force=True. The highlight of GRBs detected at VHE energies (vhe=True) can be disabled by setting vhe=False.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
trigger_id	None	integer	?trigger_id=1126853	True	Provide a Swift trigger_id
force	false	boolean	?force=true	False	Forces an update of the plot
vhe	false	boolean	?vhe=true	False	Highlight of VHE detected GRBs.

Response fields

Field	Type	Description
img_url	String	Link to the lightcurve

JSON response

{
"img_url": "string",
}

Usage example

https://astro-colibri.science/swift_xrt_lightcurve?trigger_id=1126853&force=false&vhe=true

GET

/get_obs_list

show/hide

Field	Type	Description
code	String	IAU code
lat	Float	latitude
long	Float	longitude
name	String	Name of the observatory

GET

/event

show/hide

Description

Allows to retrieve the full set of parameters we store for a given transient event.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
trigger_id	None	string	?trigger_id=1126853	True	Provide a trigger id. You can request multiple events by chaining together mulitple trigger_id (e.g. ?trigger_id=S240422ed&trigger_id=922968). In this case the return will be a list of the individual events.

Response fields

Field	Type	Description
archive	dict	dictionary of {archive_id : last_modified} that lists all previous versions of this event
archive_id	String	identifier of the event in the Astro-COLIBRI archive
assoc	String	Associated sources of the event (if known)
broker	String	Name of the broker/classifier that characterized or submitted the event (if known)
classification	String	classification of the transient; can be seen as sub-class of the "type" field (e.g. classification of the type of a SN, etc.)
comment	String	comment about the event/source
constellation	String	astronomical constellation in which the event is located
dec	Float	Dec position [deg]
discoverer_internal_name	String	name used by the discovery observatory
dm	String	Dispersion measure (mainly for FRBs); string because it contains units
energy	String	Energy of the event [GeV]
energy_time_url	String (url)	2D distribution of Fermi-LAT photons in the “energy vs time” plane
err	Float	Uncertainty of the event position [deg]
extinction_ebv	Float	E(B-V): redding to Galactic dust absorption
far	String	False-Alarm-Rate [year^-1]
follow_up	Array	list of observatories participating in follow up observations (if known)
gw_BBH	String	GW event classification: probability of being a binary black hole merger event [0..1]
gw_BNS	String	GW event classification: probability of being a binary neutron star merger event [0..1]
gw_MassGap	String	GW event classification: probability that at least one compact object with a mass in the hypothetical “mass gap” between neutron stars and black holes (3-5 solar masses) [0..1]
gw_NSBH	String	GW event classification: probability of being a merger of a system composed of one neutron star and one black hole [0..1]
gw_Noise	String	GW event classification: terrestrial noise [0..1]
alert_type	String	type of the notice (GWs: EarlyWarning, Preliminary, Initial, Update, Retraction; GBM: Gnd_Pos, Fin_Pos, etc.) /td>
gw_contours	Array	GW event localisation contours: 50% and 90% containement
gw_hasNS	Boolean	GW events: flag to indicate the presence of a component with a mass compatible with a neutron star
gw_pipeline	String	GW events: name of the pipeline used to derive the event parameters
instrument	String	Name of the instrument providing the parameters of the event (e.g. XRT or BAT for Swift detected events, etc.)
ivorn	String	Unique IVOA identifiers for event
ivorn_time	String	Time of the creation of the VoEvent
last_modified	String	Time of the modification of this event in Astro-COLIBRI
latest_lc_url	String (url)	Latest lightcurve url
lc_url	String (url)	lightcurve url (typically FLaapLUC, access restricted to H.E.S.S. members)
longterm_lc_url	String (url)	Longterm lightcurve url (typically FLaapLUC, access restricted to H.E.S.S. members)
map_areas	Dict	dict with credible levels and the contained area in a localisation map
observatory	String	Observatory at the orign of the event
pkt_ser_num	Float	A number that increments by 1 each time a new revision is issued for this event
ra	Float	RA position of the source [deg]
redshift	Float	redshift of the event
reference	String	Reference to original VoEvent in case of updates (if available)
sed_url	String (url)	Link to SED (typically FLaapLUC, access restricted to H.E.S.S. members)
sep	Float	Separation from the center of the cone search [deg]
signalness	String	Probability of being of astrophysical origin (mainly for IceCube events)
significance	Float	significance of the detected emission [sigma]
simbad_link	String (url)	Link to the source in Simbad database
slew	Boolean	Flag to indicate that the event triggered a slew of the spacecraft (typically SVOM)
source_name	String	Name of the source
sun_distance	Float	angular distance of the source to the sun at the time of the event [deg]
timestamp	Datetime	Time of the event ([UTC], unix timestamp in milliseconds)
transient_flux	Float	flux of the detected transient
transient_flux_error	Float	uncertainty on the flux of the detected transient
transient_flux_units	String	units of the flux of the detected transient
trigger_id	String	Trigger ID of the event (internal to Astro-COLIBRI)
type	String	type of event (see documentation for details )
url	String (url)	URL to additional ressource (typically the GCN circular or ATEL for manually added information)
url_name	String	name of the URL to additional ressources
map_areas	Dict	dict with credible levels and the contained area in a localisation map
alert_type	String	'EarlyWarning', 'Preliminary', 'Initial', 'Update', 'Retraction', 'coincidence' not supported yet
distance	Int	luminosity distance of the source [Mpc]
distance_error	Int	uncertainty of the luminosity distance of the source [Mpc]
classification	String	classification of the event type
confidential_observatory	String
ivorn_history	Array	list of (encoded) ivorns of revisions of the same event
event_display_url	String	url pointing to an event-display or similar figure (e.g. IceCube)
event_url	String	url pointing to generic information about the event (e.g. GBM analysis results)

JSON response

{
"assoc": "",
"classification": "",
"comment": "new bright X-ray and optical transient; Swift J1913.1+1946",
"constellation": "Sagitta",
"dec": 19.7712,
"discoverer_internal_name": "",
"dm": "",
"energy": -1.0,
"energy_time_url": "",
"err": 0.0015,
"far": -1.0,
"gw_BBH": -1.0,
"gw_BNS": -1.0,
"gw_MassGap": -1.0,
"gw_NSBH": -1.0,
"gw_Noise": -1.0,
"gw_alert_type": "",
"gw_contours": {},
"gw_hasNS": -1.0,
"gw_pipeline": "",
"instrument": "xrt",
"ivorn": "ivo://nasa.gsfc.gcn/SWIFT#XRT_Pos_1126853-388",
"ivorn_time": "2022/10/09 14:13:30",
"latest_lc_url": "",
"lc_url": "",
"longterm_lc_url": "",
"observatory": "swift",
"pkt_ser_num": 5.0,
"ra": 288.2643,
"redshift": 0.151,
"reference": "ivo://nasa.gsfc.gcn/SWIFT#BAT_GRB_Pos_1126853-379",
"sed_url": "",
"signalness": -1.0,
"significance": -1.0,
"simbad_link": "",
"slew": false,
"source_name": "GRB 221009A",
"timestamp": 1665324788590.0,
"transient_flux": -1.0,
"transient_flux_units": "",
"trigger_id": "1126853",
"type": "grb",
"url": "https://gcn.gsfc.nasa.gov/gcn3/32632.gcn3",
"url_name": "GCN #32632"
}

Usage example

https://astro-colibri.science/event?trigger_id=1126853

GET

/archive

show/hide

Parameter	Default	Type	Usage	Required	Description
archive_id	None	string	?archive_id=S240705at_2	True	Provide a archive id. These can be found in each event since v2.14.0 (see \event endpoint above).

GET

/voevent

show/hide

Description

Allows to retrieve the VoEvent in the original IVOA XML and a JSON format. This is the original data provided by the various observatories. The content of the alerts is defined by each scientific collaboration and is not homogenous.

Query Parameters

Parameter	Default	Type	Usage	Required	Description
trigger_id	None	string	?trigger_id=607642221	trigger_id or ivorn is required	Astro-COLIBRI trigger ID of the event
ivorn	None	string	?ivorn=ivo%3A%2F%2Fnasa.gsfc.gcn%2FFermi%23GBM_Fin_Pos2020-03-11T15%3A16%3A12.93_605632577_0-302	trigger_id or ivorn is required	Unique IVOA identifier for event.
json	json=0	int	?json=0	False	Specify the desired format (XML -> json=0 / JSON -> json=1)

JSON response

{ "voe:VOEvent": { "xmlns:voe": "http://www.ivoa.net/xml/VOEvent/v2.0", "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", "ivorn": "ivo://nasa.gsfc.gcn/Fermi#GBM_Fin_Pos2022-10-09T13:16:59.99_687014224_0-969", "role": "observation", "version": "2.0", "xsi:schemaLocation": "http://www.ivoa.net/xml/VOEvent/v2.0 http://www.ivoa.net/xml/VOEvent/VOEvent-v2.0.xsd", "Who": { "AuthorIVORN": "ivo://nasa.gsfc.tan/gcn", "Author": { "shortName": "Fermi (via VO-GCN)", "contactName": "Julie McEnery", "contactPhone": "+1-301-286-1632", "contactEmail": "Julie.E.McEnery@nasa.gov" }, "Date": "2022-10-09T21:56:40", "Description": "This VOEvent message was created with GCN VOE version: 15.08 17jun22" }, "What": { "Param": [ { "name": "Packet_Type", "value": "115" }, { "name": "Pkt_Ser_Num", "value": "5" }, { "name": "TrigID", "value": "687014224", "ucd": "meta.id" }, { "name": "Sequence_Num", "value": "0", "ucd": "meta.id.part" }, { "name": "Burst_TJD", "value": "19861", "unit": "days", "ucd": "time" }, { "name": "Burst_SOD", "value": "47819.99", "unit": "sec", "ucd": "time" }, { "name": "Burst_Inten", "value": "0", "unit": "cts", "ucd": "phot.count" }, { "name": "Data_Integ", "value": "0.000", "unit": "sec", "ucd": "time.interval" }, { "name": "Burst_Signif", "value": "0.00", "unit": "sigma", "ucd": "stat.snr" }, { "name": "Phi", "value": "256.53", "unit": "deg", "ucd": "pos.az.azi" }, { "name": "Theta", "value": "64.91", "unit": "deg", "ucd": "pos.az.zd" }, { "name": "Algorithm", "value": "415", "unit": "dn" }, { "name": "Lo_Energy", "value": "50000", "unit": "keV" }, { "name": "Hi_Energy", "value": "300000", "unit": "keV" }, { "name": "Trigger_ID", "value": "0x00000000" }, { "name": "Misc_flags", "value": "0x40000001" }, { "name": "LightCurve_URL", "value": "http://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2022/bn221009553/quicklook/glg_lc_medres34_bn221009553.gif", "ucd": "meta.ref.url" }, { "name": "LocationMap_URL", "value": "http://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2022/bn221009553/quicklook/glg_locplot_all_bn221009553.png", "ucd": "meta.ref.url" }, { "name": "Coords_Type", "value": "1", "unit": "dn" }, { "name": "Coords_String", "value": "source_object" } ], "Group": [ { "name": "Trigger_ID", "Param": [ { "name": "Def_NOT_a_GRB", "value": "false" }, { "name": "Target_in_Blk_Catalog", "value": "false" }, { "name": "Human_generated", "value": "false" }, { "name": "Robo_generated", "value": "true" }, { "name": "Spatial_Prox_Match", "value": "false" }, { "name": "Temporal_Prox_Match", "value": "false" }, { "name": "Test_Submission", "value": "false" } ] }, { "name": "Misc_Flags", "Param": [ { "name": "Values_Out_of_Range", "value": "false" }, { "name": "Flt_Generated", "value": "false" }, { "name": "Gnd_Generated", "value": "true" }, { "name": "CRC_Error", "value": "false" } ] }, { "name": "Obs_Support_Info", "Description": "The Sun and Moon values are valid at the time the VOEvent XML message was created.", "Param": [ { "name": "Sun_RA", "value": "195.29", "unit": "deg", "ucd": "pos.eq.ra" }, { "name": "Sun_Dec", "value": "-6.52", "unit": "deg", "ucd": "pos.eq.dec" }, { "name": "Sun_Distance", "value": "97.40", "unit": "deg", "ucd": "pos.angDistance" }, { "name": "Sun_Hr_Angle", "value": "-6.36", "unit": "hr" }, { "name": "Moon_RA", "value": "16.56", "unit": "deg", "ucd": "pos.eq.ra" }, { "name": "Moon_Dec", "value": "4.61", "unit": "deg", "ucd": "pos.eq.dec" }, { "name": "MOON_Distance", "value": "84.49", "unit": "deg", "ucd": "pos.angDistance" }, { "name": "Moon_Illum", "value": "100.00", "unit": "%", "ucd": "arith.ratio" }, { "name": "Galactic_Long", "value": "56.08", "unit": "deg", "ucd": "pos.galactic.lon" }, { "name": "Galactic_Lat", "value": "3.71", "unit": "deg", "ucd": "pos.galactic.lat" }, { "name": "Ecliptic_Long", "value": "296.55", "unit": "deg", "ucd": "pos.ecliptic.lon" }, { "name": "Ecliptic_Lat", "value": "43.83", "unit": "deg", "ucd": "pos.ecliptic.lat" } ] } ], "Description": "The Fermi-GBM location of a transient." }, "WhereWhen": { "ObsDataLocation": { "ObservatoryLocation": { "id": "GEOLUN" }, "ObservationLocation": { "AstroCoordSystem": { "id": "UTC-FK5-GEO" }, "AstroCoords": { "coord_system_id": "UTC-FK5-GEO", "Time": { "unit": "s", "TimeInstant": { "ISOTime": "2022-10-09T13:16:59.99" } }, "Position2D": { "unit": "deg", "Name1": "RA", "Name2": "Dec", "Value2": { "C1": "290.3900", "C2": "22.2500" }, "Error2Radius": "1.0000" } } } }, "Description": "The RA,Dec coordinates are of the type: source_object." }, "How": { "Description": "Fermi Satellite, GBM Instrument", "Reference": { "uri": "http://gcn.gsfc.nasa.gov/fermi.html", "type": "url" } }, "Why": { "importance": "0.95", "Inference": { "probability": "1.0", "Concept": "process.variation.burst;em.gamma" } }, "Description": null } }

Usage example

https://astro-colibri.science/voevent?trigger_id=687014224&json=1

Visibility Plots

/visibility_plots

Description

Query Parameters

Response fields

JSON response

Usage example

/visibility_plots_detailed

Description

Query Parameters

Response fields

JSON response

Usage example

/multi_observatory_visibility_plot

Description

Query Parameters

Response fields

JSON response

Usage example

Cone search and latest transients

/cone_search

Description

Body Parameters

Response fields

sources

voevents

xsources

icecat

JSON response

/latest_transients

Description

Body Parameters

Response fields:

voevents

Other endpoints

/known_sources

Description

Query Parameters

Response fields

JSON response

Usage example

/atels

Description

Query Parameters

Response fields

JSON response

Usage example

/lightcurve

Description

Query Parameters

Response fields

JSON response

Usage example

/swift_xrt_lightcurve

Description

Query Parameters

Response fields

JSON response

Usage example

/get_obs_list

Description

Query Parameters

Response fields

JSON response

Usage example

/event

Description

Query Parameters

Response fields

JSON response

Usage example

Information archive and provenance

/archive

Description

Query Parameters

Response fields

/voevent

Description

Query Parameters

JSON response