The European Space Agency
ESASky URL Parameters - ESDC
ESASky URL Parameters
URL parameters can be added to your embedded iFrame or link to ESASky to customize the interface. URL parameters are added at the end of the URL following a question mark, i.e. https://sky.esa.int/esasky?lang=en.
You can chain multiple URL parameters by separating them with &: https://sky.esa.int/esasky?lang=en&projection=TAN
If you want to embed ESASky in an IFrame, a good starting point for you to customize might look something like this:
or for outreach:
To fully control ESASky, you may also want to use the JavaScript API. Additional information on How to Use ESASky in Your Application.
List of commonly used URL parameters
parameter: hide_welcome
values: true, false
default: false
description: Prevents the welcome dialog from showing when ESASky loads
example: https://sky.esa.int/esasky?hide_welcome=true
parameter: hide_banner_info
values: true, false
default: false
description: Prevents the banner, that is sometimes used by the ESASky team to display informational messages to its users, from being displayed.
example: https://sky.esa.int/esasky?hide_banner=true
parameter: lang
values: en, es, zh
default: en
description: The language of the website content.
example: https://sky.esa.int/esasky?lang=es
parameter: target
values: <ra> <dec> or target name
default: A random target
description: The starting position in the sky
example:
https://sky.esa.int/esasky?target=75.50 -7.91
https://sky.esa.int/esasky?target=m31
parameter: fov
values: 0-360 (depending on projection)
default: ~1
description: The starting FoV
example: https://sky.esa.int/esasky?fov=180
parameter: hips
values: Any available HiPS in ESASky
default: DSS2 color
description: The starting HiPS.
To get the full list of available HiPS, you can query the API with {event:'getAvailableHips', content:{}} or use browse ESASky UI to find the HiPS you want.
example: https://sky.esa.int/esasky?hips=XMM-Newton+EPIC+color
parameter: sci
values: true, false
default: The last used mode by the user
description: Start ESASky in science mode. sci=false starts in outreach mode
example: https://sky.esa.int/esasky?sci=false
parameter: projection
values: SIN, TAN, MER etc
default: SIN
description: The starting projection (Note: Outreach mode has a limited set of projections available)
example: https://sky.esa.int/esasky?projection=TAN
parameter: cooframe
values: J2000, GALACTIC
default: J2000
description: The starting coordinate frame
example: https://sky.esa.int/esasky?cooframe=GALACTIC
parameter: simbad_author
values: any author name string
default: none
description: Load publications and sources for the given SIMBAD author on startup
example: https://sky.esa.int/esasky?simbad_author=HUBBLE+E.
parameter: bibcode
values: any valid bibcode string
default: none
description: Load the sources associated with the given bibcode on startup
example: https://sky.esa.int/esasky?bibcode=1850CDT..1784..227M
parameter: hst_image
values: any valid Hubble Space Telescope image ID string
default: none
description: Load the given HST outreach image on startup
example: https://sky.esa.int/esasky?hst_image=heic0406a
parameter: jwst_image
values: any valid James Webb Space Telescope image ID string
default: none
description: Load the given JWST outreach image on startup
example: https://sky.esa.int/esasky?jwst_image=weic2311a
parameter: euclid_image
values: any valid Euclid image ID string
default: none
description: Load the given Euclid outreach image on startup
example: https://sky.esa.int/esasky?euclid_image=Abell2764