Documentation Powered by ReDoc

SkyPortal (0.9.dev0+git20200708.c50e6d8)

Download OpenAPI specification:Download

SkyPortal API

Authentication

token

Header should be in the format 'token abcd-efgh-0000-1234'

Security Scheme Type API Key
Header parameter name: Authorization

Retrieve a candidate

Retrieve a candidate

path Parameters
obj_id
required
integer

Responses

200
400
get/api/candidates/obj_id
/api/candidates/obj_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update a candidate

Update a candidate

path Parameters
obj_id
required
string
Request Body schema: application/json
ra
number <float> Nullable
dec
number <float> Nullable
ra_dis
number <float> Nullable
dec_dis
number <float> Nullable
ra_err
number <float> Nullable
dec_err
number <float> Nullable
offset
number <float> Nullable
redshift
number <float> Nullable
altdata
any Nullable
dist_nearest_source
number <float> Nullable
mag_nearest_source
number <float> Nullable
e_mag_nearest_source
number <float> Nullable
transient
boolean Nullable
varstar
boolean Nullable
is_roid
boolean Nullable
score
number <float> Nullable
origin
string Nullable
detect_photometry_count
integer <int32> Nullable

Responses

200
400
patch/api/candidates/obj_id
/api/candidates/obj_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ra": 0,
  • "dec": 0,
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "score": 0,
  • "origin": "string",
  • "detect_photometry_count": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve all candidates

Retrieve all candidates

query Parameters
numPerPage
integer

Number of candidates to return per paginated request. Defaults to 25

pageNumber
integer

Page number for paginated query results. Defaults to 1

totalMatches
integer

Used only in the case of paginating query results - if provided, this allows for avoiding a potentially expensive query.count() call.

unsavedOnly
boolean

Boolean indicating whether to return only unsaved candidates

startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by last_detected >= startDate

endDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by last_detected <= endDate

groupIDs
Array of integers

Comma-separated string of group IDs (e.g. "1,2"). Defaults to all of user's groups if filterIDs is not provided.

filterIDs
Array of integers

Comma-separated string of filter IDs (e.g. "1,2"). Defaults to all of user's groups' filters if groupIDs is not provided.

Responses

200
400
get/api/candidates
/api/candidates

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

POST a new candidate.

POST a new candidate.

Request Body schema: application/json
id
required
string
ra
number <float> Nullable
dec
number <float> Nullable
ra_dis
number <float> Nullable
dec_dis
number <float> Nullable
ra_err
number <float> Nullable
dec_err
number <float> Nullable
offset
number <float> Nullable
redshift
number <float> Nullable
altdata
any Nullable
dist_nearest_source
number <float> Nullable
mag_nearest_source
number <float> Nullable
e_mag_nearest_source
number <float> Nullable
transient
boolean Nullable
varstar
boolean Nullable
is_roid
boolean Nullable
score
number <float> Nullable
origin
string Nullable
detect_photometry_count
integer <int32> Nullable
filter_ids
required
Array of integers

List of associated filter IDs

passing_alert_id
integer Nullable

ID of associated filter that created candidate

passed_at
string Nullable

Arrow-parseable datetime string indicating when passed filter.

Responses

200
post/api/candidates
/api/candidates

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "ra": 0,
  • "dec": 0,
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "score": 0,
  • "origin": "string",
  • "detect_photometry_count": 0,
  • "filter_ids":
    [
    ],
  • "passing_alert_id": 0,
  • "passed_at": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve a comment

Retrieve a comment

path Parameters
comment_id
required
integer

Responses

200
400
get/api/comment/comment_id
/api/comment/comment_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update a comment

Update a comment

path Parameters
comment_id
required
integer
Request Body schema: application/json
text
required
string
ctype
string <= 14 characters Nullable
Enum: "text" "redshift" "classification"
attachment_name
string Nullable
attachment_type
string Nullable
attachment_bytes
string Nullable
origin
string Nullable
author
required
string
obj_id
required
string
group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view comment.

Responses

200
400
put/api/comment/comment_id
/api/comment/comment_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "text": "string",
  • "ctype": "text",
  • "attachment_name": "string",
  • "attachment_type": "string",
  • "attachment_bytes": "string",
  • "origin": "string",
  • "author": "string",
  • "obj_id": "string",
  • "group_ids":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete a comment

Delete a comment

path Parameters
comment_id
required
integer

Responses

200
delete/api/comment/comment_id
/api/comment/comment_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Post a comment

Post a comment

Request Body schema: application/json
obj_id
required
string
text
required
string
group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view comment. Defaults to all of requesting user's groups.

attachment
object

Responses

200
post/api/comment
/api/comment

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj_id": "string",
  • "text": "string",
  • "group_ids":
    [
    ],
  • "attachment":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Download comment attachment

Download comment attachment

path Parameters
comment_id
required
integer

Responses

200
get/api/comment/comment_id/attachment
/api/comment/comment_id/attachment

Retrieve a filter

Retrieve a filter

path Parameters
filter_id
required
integer

Responses

200
400
get/api/filters/filter_id
/api/filters/filter_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Delete a filter

Delete a filter

path Parameters
filter_id
required
integer

Responses

200
delete/api/filters/filter_id
/api/filters/filter_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Update a filter

Update a filter

path Parameters
filter_id
required
integer
Request Body schema: application/json
query_string
required
string
group_id
integer <int32> Nullable

Responses

200
400
patch/api/filters/filter_id
/api/filters/filter_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "query_string": "string",
  • "group_id": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve all filters

Retrieve all filters

Responses

200
400
get/api/filters
/api/filters

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    [
    ],
  • "message": "string"
}

POST a new filter.

POST a new filter.

Request Body schema: application/json
query_string
required
string
group_id
integer <int32> Nullable

Responses

200
post/api/filters
/api/filters

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "query_string": "string",
  • "group_id": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Update a follow-up request

Update a follow-up request

path Parameters
request_id
required
string
Request Body schema: application/json
requester_id
required
integer <int32>
obj_id
required
string
instrument_id
required
integer <int32>
start_date
required
string <date-time>
end_date
required
string <date-time>
filters
Array of strings Nullable
exposure_time
string Nullable
priority
string <= 1 characters Nullable
Enum: "1" "2" "3" "4" "5"
editable
boolean
status
string

Responses

200
400
put/api/followup_request/request_id
/api/followup_request/request_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requester_id": 0,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "start_date": "2020-07-08T16:34:27Z",
  • "end_date": "2020-07-08T16:34:27Z",
  • "filters":
    [
    ],
  • "exposure_time": "string",
  • "priority": "1",
  • "editable": true,
  • "status": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete follow-up request.

Delete follow-up request.

path Parameters
request_id
required
string

Responses

200
delete/api/followup_request/request_id
/api/followup_request/request_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Submit follow-up request.

Submit follow-up request.

Request Body schema: application/json
requester_id
required
integer <int32>
obj_id
required
string
instrument_id
required
integer <int32>
start_date
required
string <date-time>
end_date
required
string <date-time>
filters
Array of strings Nullable
exposure_time
string Nullable
priority
string <= 1 characters Nullable
Enum: "1" "2" "3" "4" "5"
editable
boolean
status
string

Responses

200
post/api/followup_request
/api/followup_request

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requester_id": 0,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "start_date": "2020-07-08T16:34:27Z",
  • "end_date": "2020-07-08T16:34:27Z",
  • "filters":
    [
    ],
  • "exposure_time": "string",
  • "priority": "1",
  • "editable": true,
  • "status": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Add a group user

Add a group user

path Parameters
group_id
required
integer
username
required
string
Request Body schema: application/json
admin
required
boolean

Responses

200
post/api/groups/group_id/users/username
/api/groups/group_id/users/username

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "admin": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Delete a group user

Delete a group user

path Parameters
group_id
required
integer
username
required
string

Responses

200
delete/api/groups/group_id/users/username
/api/groups/group_id/users/username

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve a group

Retrieve a group

path Parameters
group_id
required
integer

Responses

200
400
get/api/groups/group_id
/api/groups/group_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Update a group

Update a group

path Parameters
group_id
required
integer
Request Body schema: application/json
name
required
string

Responses

200
400
put/api/groups/group_id
/api/groups/group_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete a group

Delete a group

path Parameters
group_id
required
integer

Responses

200
delete/api/groups/group_id
/api/groups/group_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve all groups

Retrieve all groups

Responses

200
400
get/api/groups
/api/groups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Create a new group

Create a new group

Request Body schema: application/json
name
required
string
group_admins
Array of strings

List of emails of users to be group admins. Current user will automatically be added as a group admin.

Responses

200
post/api/groups
/api/groups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "group_admins":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve an instrument

Retrieve an instrument

path Parameters
instrument_id
required
integer

Responses

200
400
get/api/instrument/instrument_id
/api/instrument/instrument_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update instrument

Update instrument

path Parameters
instrument_id
required
integer
Request Body schema: application/json
name
required
string
type
string Nullable
band
string Nullable
telescope_id
required
integer <int32>
filters
Array of any

Responses

200
400
put/api/instrument/instrument_id
/api/instrument/instrument_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "type": "string",
  • "band": "string",
  • "telescope_id": 0,
  • "filters":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete an instrument

Delete an instrument

path Parameters
instrument_id
required
integer

Responses

200
400
delete/api/instrument/instrument_id
/api/instrument/instrument_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve all instruments

Retrieve all instruments

Responses

200
400
get/api/instrument
/api/instrument

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    [
    ],
  • "message": "string"
}

Add a new instrument

Add a new instrument

Request Body schema: application/json
name
required
string
type
string Nullable
band
string Nullable
telescope_id
required
integer <int32>
filters
Array of strings
Default: []
Items Enum: "bessellux" "bessellb" "bessellv" "bessellr" "besselli" "standard::u" "standard::b" "standard::v" "standard::r" "standard::i" "desg" "desr" "desi" "desz" "desy" "sdssu" "sdssg" "sdssr" "sdssi" "sdssz" "f435w" "f475w" "f555w" "f606w" "f625w" "f775w" "f850lp" "nicf110w" "nicf160w" "f098m" "f105w" "f110w" "f125w" "f127m" "f139m" "f140w" "f153m" "f160w" "f218w" "f225w" "f275w" "f300x" "f336w" "f350lp" "f390w" "f689m" "f763m" "f845m" "f438w" "uvf475w" "uvf555w" "uvf606w" "uvf625w" "uvf775w" "uvf814w" "uvf850lp" "kepler" "cspb" "csphs" "csphd" "cspjs" "cspjd" "cspv3009" "cspv3014" "cspv9844" "cspys" "cspyd" "cspg" "cspi" "cspk" "cspr" "cspu" "f070w" "f090w" "f115w" "f150w" "f200w" "f277w" "f356w" "f444w" "f140m" "f162m" "f182m" "f210m" "f250m" "f300m" "f335m" "f360m" "f410m" "f430m" "f460m" "f480m" "f560w" "f770w" "f1000w" "f1130w" "f1280w" "f1500w" "f1800w" "f2100w" "f2550w" "f1065c" "f1140c" "f1550c" "f2300c" "lsstu" "lsstg" "lsstr" "lssti" "lsstz" "lssty" "keplercam::us" "keplercam::b" "keplercam::v" "keplercam::r" "keplercam::i" "4shooter2::us" "4shooter2::b" "4shooter2::v" "4shooter2::r" "4shooter2::i" "ztfg" "ztfr" "ztfi"

List of filters on the instrument. If the instrument has no filters (e.g., because it is a spectrograph), leave blank or pass the empty list.

Responses

200
400
post/api/instrument
/api/instrument

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "type": "string",
  • "band": "string",
  • "telescope_id": 0,
  • "filters":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve summary of recent activity

Retrieve summary of recent activity

Responses

200
400
get/api/newsfeed
/api/newsfeed

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    [
    ]
}

Retrieve photometry

Retrieve photometry

path Parameters
photometry_id
required
integer
query Parameters
format
string
Enum: "mag" "flux"

Return the photometry in flux or magnitude space? If a value for this query parameter is not provided, the result will be returned in magnitude space.

magsys
string
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude or zeropoint system of the output. (Default AB)

Responses

200
400
get/api/photometry/photometry_id
/api/photometry/photometry_id

Response samples

Content type
application/json
Example
SinglePhotometryFlux
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update photometry

Update photometry

path Parameters
photometry_id
required
integer
Request Body schema: application/json
One of
  • PhotometryMag
  • PhotometryFlux
alert_id
integer <int32> Nullable
Default: null

Corresponding alert ID. If a record is already present with identical alert ID, only the groups list will be updated (other alert data assumed identical). Defaults to None.

limiting_mag
required
number

Limiting magnitude of the image in the magnitude system magsys.

mag
number Nullable
Default: null

Magnitude of the observation in the magnitude system magsys. Can be null in the case of a non-detection.

instrument_id
required
integer <int32>

ID of the instrument with which the observation was carried out.

magsys
required
any
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude system to which the flux and the zeropoint are tied.

dec
number Nullable
Default: null

ICRS Declination of the centroid of the photometric aperture [deg].

obj_id
required
string

ID of the Object to which the photometry will be attached.

filter
required
any
Enum: "bessellux" "bessellb" "bessellv" "bessellr" "besselli" "standard::u" "standard::b" "standard::v" "standard::r" "standard::i" "desg" "desr" "desi" "desz" "desy" "sdssu" "sdssg" "sdssr" "sdssi" "sdssz" "f435w" "f475w" "f555w" "f606w" "f625w" "f775w" "f850lp" "nicf110w" "nicf160w" "f098m" "f105w" "f110w" "f125w" "f127m" "f139m" "f140w" "f153m" "f160w" "f218w" "f225w" "f275w" "f300x" "f336w" "f350lp" "f390w" "f689m" "f763m" "f845m" "f438w" "uvf475w" "uvf555w" "uvf606w" "uvf625w" "uvf775w" "uvf814w" "uvf850lp" "kepler" "cspb" "csphs" "csphd" "cspjs" "cspjd" "cspv3009" "cspv3014" "cspv9844" "cspys" "cspyd" "cspg" "cspi" "cspk" "cspr" "cspu" "f070w" "f090w" "f115w" "f150w" "f200w" "f277w" "f356w" "f444w" "f140m" "f162m" "f182m" "f210m" "f250m" "f300m" "f335m" "f360m" "f410m" "f430m" "f460m" "f480m" "f560w" "f770w" "f1000w" "f1130w" "f1280w" "f1500w" "f1800w" "f2100w" "f2550w" "f1065c" "f1140c" "f1550c" "f2300c" "lsstu" "lsstg" "lsstr" "lssti" "lsstz" "lssty" "keplercam::us" "keplercam::b" "keplercam::v" "keplercam::r" "keplercam::i" "4shooter2::us" "4shooter2::b" "4shooter2::v" "4shooter2::r" "4shooter2::i" "ztfg" "ztfr" "ztfi"

The bandpass of the observation.

magerr
number Nullable
Default: null

Magnitude error of the observation in the magnitude system magsys. Can be null in the case of a non-detection.

mjd
required
number

MJD of the observation.

altdata
object Nullable
Default: null

Misc. alternative metadata.

ra_unc
number Nullable
Default: null

Uncertainty on RA [arcsec].

dec_unc
number Nullable
Default: null

Uncertainty on dec [arcsec].

ra
number Nullable
Default: null

ICRS Right Ascension of the centroid of the photometric aperture [deg].

Responses

200
400
put/api/photometry/photometry_id
/api/photometry/photometry_id

Request samples

Content type
application/json
Example
PhotometryMag
Copy
 Expand all Collapse all
{
  • "alert_id": null,
  • "limiting_mag": 0,
  • "mag": null,
  • "instrument_id": 0,
  • "magsys": "jla1",
  • "dec": null,
  • "obj_id": "string",
  • "filter": "bessellux",
  • "magerr": null,
  • "mjd": 0,
  • "altdata": null,
  • "ra_unc": null,
  • "dec_unc": null,
  • "ra": null
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete photometry

Delete photometry

path Parameters
photometry_id
required
integer

Responses

200
400
delete/api/photometry/photometry_id
/api/photometry/photometry_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Upload photometry

Upload photometry

Request Body schema: application/json
One of
  • PhotMagFlexible
  • PhotFluxFlexible
limiting_mag_nsigma
any
Default: 5

Number of standard deviations above the background that the limiting magnitudes correspond to. Null values not allowed. Default = 5.

alert_id
any

Corresponding alert ID. If a record is already present with identical alert ID, only the groups list will be updated (other alert data assumed identical). Defaults to None.

limiting_mag
required
any

Limiting magnitude of the image in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed.

mag
any Nullable
Default: null

Magnitude of the observation in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed for non-detections. If mag is null, the corresponding magerr must also be null.

instrument_id
required
any

ID of the Instrument(s) with which the photometry was acquired. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values are not allowed.

group_ids
required
Array of integers <int32>

List of group IDs to which photometry points will be visible.

dec
any Nullable
Default: null

ICRS Declination of the centroid of the photometric aperture [deg]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

obj_id
required
any

ID of the Obj(s) to which the photometry will be attached. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values are not allowed.

magsys
required
any

The magnitude system to which the magnitude, magnitude error, and limiting magnitude are tied. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed. Allowed values: jla1, ab, vega, bd17, csp, ab-b12

filter
required
any

The bandpass of the observation(s). Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed. Allowed values: bessellux, bessellb, bessellv, bessellr, besselli, standard::u, standard::b, standard::v, standard::r, standard::i, desg, desr, desi, desz, desy, sdssu, sdssg, sdssr, sdssi, sdssz, f435w, f475w, f555w, f606w, f625w, f775w, f850lp, nicf110w, nicf160w, f098m, f105w, f110w, f125w, f127m, f139m, f140w, f153m, f160w, f218w, f225w, f275w, f300x, f336w, f350lp, f390w, f689m, f763m, f845m, f438w, uvf475w, uvf555w, uvf606w, uvf625w, uvf775w, uvf814w, uvf850lp, kepler, cspb, csphs, csphd, cspjs, cspjd, cspv3009, cspv3014, cspv9844, cspys, cspyd, cspg, cspi, cspk, cspr, cspu, f070w, f090w, f115w, f150w, f200w, f277w, f356w, f444w, f140m, f162m, f182m, f210m, f250m, f300m, f335m, f360m, f410m, f430m, f460m, f480m, f560w, f770w, f1000w, f1130w, f1280w, f1500w, f1800w, f2100w, f2550w, f1065c, f1140c, f1550c, f2300c, lsstu, lsstg, lsstr, lssti, lsstz, lssty, keplercam::us, keplercam::b, keplercam::v, keplercam::r, keplercam::i, 4shooter2::us, 4shooter2::b, 4shooter2::v, 4shooter2::r, 4shooter2::i, ztfg, ztfr, ztfi

magerr
any Nullable
Default: null

Magnitude of the observation in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed for non-detections. If magerr is null, the corresponding mag must also be null.

mjd
required
any

MJD of the observation(s). Can be a given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed.

altdata
any Nullable
Default: null

Misc. alternative metadata.

ra_unc
any Nullable
Default: null

Uncertainty on RA [arcsec]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

dec_unc
any Nullable
Default: null

Uncertainty on dec [arcsec]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

ra
any Nullable
Default: null

ICRS Right Ascension of the centroid of the photometric aperture [deg]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

Responses

200
post/api/photometry
/api/photometry

Request samples

Content type
application/json
Example
PhotMagFlexible
Copy
 Expand all Collapse all
{
  • "limiting_mag_nsigma": 5,
  • "alert_id": null,
  • "limiting_mag": null,
  • "mag": null,
  • "instrument_id": null,
  • "group_ids":
    [
    ],
  • "dec": null,
  • "obj_id": null,
  • "magsys": null,
  • "filter": null,
  • "magerr": null,
  • "mjd": null,
  • "altdata": null,
  • "ra_unc": null,
  • "dec_unc": null,
  • "ra": null
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Delete bulk-uploaded photometry set

Delete bulk-uploaded photometry set

path Parameters
upload_id
required
string

Responses

200
400
delete/api/photometry/bulk_delete/upload_id
/api/photometry/bulk_delete/upload_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve all photometry associated with an Object

Retrieve all photometry associated with an Object

path Parameters
obj_id
required
string

ID of the object to retrieve photometry for

query Parameters
format
string
Enum: "mag" "flux"

Return the photometry in flux or magnitude space? If a value for this query parameter is not provided, the result will be returned in magnitude space.

magsys
string
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude or zeropoint system of the output. (Default AB)

Responses

200
400
get/api/sources/obj_id/photometry
/api/sources/obj_id/photometry

Response samples

Content type
application/json
Example
ArrayOfPhotometryFluxs
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    [
    ],
  • "message": "string"
}

Retrieve offset stars to aid in spectroscopy

Retrieve offset stars to aid in spectroscopy

path Parameters
obj_id
required
string
query Parameters
facility
string
Enum: "Keck" "Shane" "P200"

Which facility to generate the starlist for

how_many
integer [ 0 .. 10 ]

Requested number of offset stars (set to zero to get starlist of just the source itself)

obstime
string

datetime of observation in isoformat (e.g. 2020-12-30T12:34:10)

Responses

200
400
get/api/sources/obj_id/offsets
/api/sources/obj_id/offsets

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Generate a PDF finding chart to aid in spectroscop

Generate a PDF finding chart to aid in spectroscopy

path Parameters
obj_id
required
string
query Parameters
imsize
float [ 2 .. 15 ]

Image size in arcmin (square)

facility
string
Enum: "Keck" "Shane" "P200"
image_source
string
Enum: "desi" "dss" "ztfref"

Source of the image used in the finding chart

obstime
string

datetime of observation in isoformat (e.g. 2020-12-30T12:34:10)

Responses

200

A PDF finding chart file

400
get/api/sources/obj_id/finder
/api/sources/obj_id/finder

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "error",
  • "data": { },
  • "message": "string"
}

Retrieve a source

Retrieve a source

path Parameters
obj_id
required
integer

Responses

200
400
get/api/sources/obj_id
/api/sources/obj_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update a source

Update a source

path Parameters
obj_id
required
string
Request Body schema: application/json
ra
number <float> Nullable
dec
number <float> Nullable
ra_dis
number <float> Nullable
dec_dis
number <float> Nullable
ra_err
number <float> Nullable
dec_err
number <float> Nullable
offset
number <float> Nullable
redshift
number <float> Nullable
altdata
any Nullable
dist_nearest_source
number <float> Nullable
mag_nearest_source
number <float> Nullable
e_mag_nearest_source
number <float> Nullable
transient
boolean Nullable
varstar
boolean Nullable
is_roid
boolean Nullable
score
number <float> Nullable
origin
string Nullable
detect_photometry_count
integer <int32> Nullable

Responses

200
400
put/api/sources/obj_id
/api/sources/obj_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ra": 0,
  • "dec": 0,
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "score": 0,
  • "origin": "string",
  • "detect_photometry_count": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete a source

Delete a source

path Parameters
obj_id
required
string
group_id
required
string

Responses

200
delete/api/sources/obj_id
/api/sources/obj_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve all sources

Retrieve all sources

query Parameters
ra
number

RA for spatial filtering

dec
number

Declination for spatial filtering

radius
number

Radius for spatial filtering if ra & dec are provided

sourceID
string

Portion of ID to filter on

simbadClass
string

Simbad class to filter on

hasTNSname
boolean

If true, return only those matches with TNS names

numPerPage
integer

Number of sources to return per paginated request. Defaults to 100. Max 1000.

pageNumber
integer

Page number for paginated query results. Defaults to 1

totalMatches
integer

Used only in the case of paginating query results - if provided, this allows for avoiding a potentially expensive query.count() call.

startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by last_detected >= startDate

endDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by last_detected <= endDate

Responses

200
400
get/api/sources
/api/sources

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Add a new source

Add a new source

Request Body schema: application/json
id
required
string
ra
number <float> Nullable
dec
number <float> Nullable
ra_dis
number <float> Nullable
dec_dis
number <float> Nullable
ra_err
number <float> Nullable
dec_err
number <float> Nullable
offset
number <float> Nullable
redshift
number <float> Nullable
altdata
any Nullable
dist_nearest_source
number <float> Nullable
mag_nearest_source
number <float> Nullable
e_mag_nearest_source
number <float> Nullable
transient
boolean Nullable
varstar
boolean Nullable
is_roid
boolean Nullable
score
number <float> Nullable
origin
string Nullable
detect_photometry_count
integer <int32> Nullable
group_ids
Array of integers

List of associated group IDs. If not specified, all of the user or token's groups will be used.

Responses

200
post/api/sources
/api/sources

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "ra": 0,
  • "dec": 0,
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "score": 0,
  • "origin": "string",
  • "detect_photometry_count": 0,
  • "group_ids":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve a spectrum

Retrieve a spectrum

path Parameters
spectrum_id
required
integer

Responses

200
400
get/api/spectrum/spectrum_id
/api/spectrum/spectrum_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update spectrum

Update spectrum

path Parameters
spectrum_id
required
integer
Request Body schema: application/json
wavelengths
required
Array of numbers <float>
fluxes
required
Array of numbers <float>
errors
Array of numbers <float> Nullable
obj_id
required
string
observed_at
required
string <date-time>
origin
string Nullable
instrument_id
required
integer <int32>

Responses

200
400
put/api/spectrum/spectrum_id
/api/spectrum/spectrum_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "errors":
    [
    ],
  • "obj_id": "string",
  • "observed_at": "2020-07-08T16:34:27Z",
  • "origin": "string",
  • "instrument_id": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete a spectrum

Delete a spectrum

path Parameters
spectrum_id
required
integer

Responses

200
400
delete/api/spectrum/spectrum_id
/api/spectrum/spectrum_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Upload spectrum

Upload spectrum

Request Body schema: application/json
wavelengths
required
Array of numbers <float>
fluxes
required
Array of numbers <float>
errors
Array of numbers <float> Nullable
obj_id
required
string
observed_at
required
string <date-time>
origin
string Nullable
instrument_id
required
integer <int32>

Responses

200
400
post/api/spectrum
/api/spectrum

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "errors":
    [
    ],
  • "obj_id": "string",
  • "observed_at": "2020-07-08T16:34:27Z",
  • "origin": "string",
  • "instrument_id": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve system info

Retrieve system info

Responses

200
get/api/sysinfo
/api/sysinfo

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data": { }
}

Retrieve a taxonomy

Retrieve a taxonomy

path Parameters
taxonomy_id
required
integer

Responses

200
400
get/api/taxonomy/taxonomy_id
/api/taxonomy/taxonomy_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Delete a taxonomy

Delete a taxonomy

path Parameters
taxonomy_id
required
integer

Responses

200
delete/api/taxonomy/taxonomy_id
/api/taxonomy/taxonomy_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Post new taxonomy

Post new taxonomy

Request Body schema: application/json
name
required
string

Short string to make this taxonomy memorable to end users.

hierarchy
required
object

Nested JSON describing the taxonomy which should be validated against a schema before entry

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view comment. Defaults to all of requesting user's groups.

version
required
string

Semantic version of this taxonomy name

provenance
string

Identifier (e.g., URL or git hash) that uniquely ties this taxonomy back to an origin or place of record

isLatest
boolean

Consider this version of the taxonomy with this name the latest? Defaults to True.

Responses

200
post/api/taxonomy
/api/taxonomy

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "hierarchy": { },
  • "group_ids":
    [
    ],
  • "version": "string",
  • "provenance": "string",
  • "isLatest": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve a telescope

Retrieve a telescope

path Parameters
telescope_id
required
integer

Responses

200
400
get/api/telescope/telescope_id
/api/telescope/telescope_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update telescope

Update telescope

path Parameters
telescope_id
required
integer
Request Body schema: application/json
name
required
string
nickname
required
string
lat
number <float> Nullable

Latitude in deg.

lon
number <float> Nullable

Longitude in deg.

elevation
number <float> Nullable

Elevation in meters.

diameter
required
number <float>

Diameter in meters.

skycam_link
string Nullable

Link to the telescope's sky camera.

Responses

200
400
put/api/telescope/telescope_id
/api/telescope/telescope_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "nickname": "string",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "diameter": 0,
  • "skycam_link": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete a telescope

Delete a telescope

path Parameters
telescope_id
required
integer

Responses

200
400
delete/api/telescope/telescope_id
/api/telescope/telescope_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Create telescopes

Create telescopes

Request Body schema: application/json
name
required
string
nickname
required
string
lat
number <float> Nullable

Latitude in deg.

lon
number <float> Nullable

Longitude in deg.

elevation
number <float> Nullable

Elevation in meters.

diameter
required
number <float>

Diameter in meters.

skycam_link
string Nullable

Link to the telescope's sky camera.

Responses

200
400
post/api/telescope
/api/telescope

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "nickname": "string",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "diameter": 0,
  • "skycam_link": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve a thumbnail

Retrieve a thumbnail

path Parameters
thumbnail_id
required
integer

Responses

200
400
get/api/thumbnail/thumbnail_id
/api/thumbnail/thumbnail_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Update thumbnail

Update thumbnail

path Parameters
thumbnail_id
required
integer
Request Body schema: application/json
type
string <= 6 characters Nullable
Enum: "new" "ref" "sub" "sdss" "dr8" "new_gz" "ref_gz" "sub_gz"

Thumbnail type (e.g., ref, new, sub, dr8, ...)

file_uri
string Nullable
public_url
string Nullable
origin
string Nullable
photometry_id
required
integer <int32>

Responses

200
400
put/api/thumbnail/thumbnail_id
/api/thumbnail/thumbnail_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "new",
  • "file_uri": "string",
  • "public_url": "string",
  • "origin": "string",
  • "photometry_id": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Delete a thumbnail

Delete a thumbnail

path Parameters
thumbnail_id
required
integer

Responses

200
400
delete/api/thumbnail/thumbnail_id
/api/thumbnail/thumbnail_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Upload thumbnails

Upload thumbnails

Request Body schema: application/json
obj_id
string

ID of object associated with thumbnails. If specified, without photometry_id, the first photometry point associated with specified object will be associated with thumbnail(s).

photometry_id
integer

ID of photometry to be associated with thumbnails. If omitted, obj_id must be specified, in which case the first photometry entry associated with object will be used.

data
required
string <byte>

base64-encoded PNG image file contents. Image size must be between 16px and 500px on a side.

ttype
required
string

Thumbnail type. Must be one of 'new', 'ref', 'sub', 'sdss', 'dr8', 'new_gz', 'ref_gz', 'sub_gz'

Responses

200
400
post/api/thumbnail
/api/thumbnail

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj_id": "string",
  • "photometry_id": 0,
  • "data": "string",
  • "ttype": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Retrieve a user

Retrieve a user

path Parameters
user_id
required
integer

Responses

200
400
get/api/user/user_id
/api/user/user_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "data":
    {
    },
  • "message": "string"
}

Delete a user

Delete a user

path Parameters
user_id
required
integer

Responses

200
400
delete/api/user/user_id
/api/user/user_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Generate new token

Generate new token

Request Body schema: application/json
id
string
created_by_id
integer <int32> Nullable
name
string

Responses

200
post/api/internal/tokens
/api/internal/tokens

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "created_by_id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Delete a token

Delete a token

path Parameters
token_id
required
integer

Responses

200
400
delete/api/internal/tokens/token_id
/api/internal/tokens/token_id

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Retrieve user profile

Retrieve user profile

Responses

200
get/api/internal/profile
/api/internal/profile

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}

Update user preferences

Update user preferences

Request Body schema: application/json
preferences
object (UserPreferences)

Responses

200
400
put/api/internal/profile
/api/internal/profile

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "preferences":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string"
}

Determine whether sources table is empy.

Determine whether sources table is empy.

Responses

200
get/api/internal/dbinfo
/api/internal/dbinfo

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "success",
  • "message": "string",
  • "data":
    {
    }
}