From 9bc23fde9570958de38891943d38507e60c6a5f8 Mon Sep 17 00:00:00 2001 From: Theodlz Date: Sat, 29 Jun 2024 14:55:03 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20main=20from=20@=20fritz-marsha?= =?UTF-8?q?l/fritz@32e6ba4b4b1908fd22abec63ee31026de577d4ec=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api.html | 758 +++++++++++++++++++++++++++---------------------------- 1 file changed, 379 insertions(+), 379 deletions(-) diff --git a/api.html b/api.html index 8f718f2..dd4fc36 100644 --- a/api.html +++ b/api.html @@ -187,7 +187,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

Fritz: SkyPortal API (0.9.dev0+git20240620.ccb3052)

Download OpenAPI specification:Download

SkyPortal provides an API to access most of its underlying + " fill="currentColor">

Fritz: SkyPortal API (0.9.dev0+git20240629.764515a)

Download OpenAPI specification:Download

SkyPortal provides an API to access most of its underlying functionality. To use it, you will need an API token. This can be generated via the web application from your profile page or, if you are an admin, you may use the system provisioned token stored @@ -316,10 +316,10 @@

Pagination

Responses

200
400
get/api/allocation/report/instrument_id
https://fritz.science/api/allocation/report/instrument_id

Response samples

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

Retrieve observation plans associated with an allo

Retrieve observation plans associated with an allocation

path Parameters
allocation_id
required
integer
query Parameters
numPerPage
integer

Number of observation plans to return per paginated request. Defaults to 10. Can be no larger than {MAX_OBSERVATION_PLANS}.

pageNumber
integer

Page number for paginated query results. Defaults to 1

-

Responses

200
400
get/api/allocation/observation_plans/allocation_id
https://fritz.science/api/allocation/observation_plans/allocation_id

Response samples

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

Retrieve an allocation

Retrieve an allocation

+

Responses

200
400
get/api/allocation/observation_plans/allocation_id
https://fritz.science/api/allocation/observation_plans/allocation_id

Response samples

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

Retrieve an allocation

Retrieve an allocation

path Parameters
allocation_id
required
integer
query Parameters
numPerPage
integer

Number of followup requests to return per paginated request. Defaults to 10. Can be no larger than {MAX_FOLLOWUP_REQUESTS}.

pageNumber
integer

Page number for paginated query results. Defaults to 1

-

Responses

200
400
get/api/allocation/allocation_id
https://fritz.science/api/allocation/allocation_id

Response samples

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

Update an allocation on a robotic instrument

Update an allocation on a robotic instrument

+

Responses

200
400
get/api/allocation/allocation_id
https://fritz.science/api/allocation/allocation_id

Response samples

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

Update an allocation on a robotic instrument

Update an allocation on a robotic instrument

path Parameters
allocation_id
required
integer
Request Body schema: application/json
requests
Array of any
default_requests
Array of any
default_observation_plans
Array of any
catalog_queries
Array of any
observation_plans
Array of any
group
any Nullable

The Group the allocation is associated with.

instrument
any Nullable

The Instrument the allocation is associated with.

allocation_users
Array of any
gcn_triggers
Array of any
pi
string Nullable

The PI of the allocation's proposal.

@@ -330,10 +330,10 @@

Pagination

default_share_group_ids
any Nullable
types
Array of any

The type of allocation.

group_id
required
integer

The ID of the Group the allocation is associated with.

instrument_id
required
integer

The ID of the Instrument the allocation is associated with.

-
_altdata
string Nullable

Responses

200
400
put/api/allocation/allocation_id
https://fritz.science/api/allocation/allocation_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requests":
    [
    ],
  • "default_requests":
    [
    ],
  • "default_observation_plans":
    [
    ],
  • "catalog_queries":
    [
    ],
  • "observation_plans":
    [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users":
    [
    ],
  • "gcn_triggers":
    [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2024-06-29T14:41:21Z",
  • "end_date": "2024-06-29T14:41:21Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "types":
    [
    ],
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

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

Delete allocation.

Delete allocation.

+
_altdata
string Nullable

Responses

200
400
put/api/allocation/allocation_id
https://fritz.science/api/allocation/allocation_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requests":
    [
    ],
  • "default_requests":
    [
    ],
  • "default_observation_plans":
    [
    ],
  • "catalog_queries":
    [
    ],
  • "observation_plans":
    [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users":
    [
    ],
  • "gcn_triggers":
    [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2024-06-29T14:54:57Z",
  • "end_date": "2024-06-29T14:54:57Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "types":
    [
    ],
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

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

Delete allocation.

Delete allocation.

path Parameters
allocation_id
required
string

Responses

200
delete/api/allocation/allocation_id
https://fritz.science/api/allocation/allocation_id

Response samples

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

Retrieve all allocations

Retrieve all allocations

query Parameters
instrument_id
number

Instrument ID to retrieve allocations for

-

Responses

200
400
get/api/allocation
https://fritz.science/api/allocation

Response samples

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

Post new allocation on a robotic instrument

Post new allocation on a robotic instrument

+

Responses

200
400
get/api/allocation
https://fritz.science/api/allocation

Response samples

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

Post new allocation on a robotic instrument

Post new allocation on a robotic instrument

Request Body schema: application/json
requests
Array of any
default_requests
Array of any
default_observation_plans
Array of any
catalog_queries
Array of any
observation_plans
Array of any
group
any Nullable

The Group the allocation is associated with.

instrument
any Nullable

The Instrument the allocation is associated with.

allocation_users
Array of any
gcn_triggers
Array of any
pi
string Nullable

The PI of the allocation's proposal.

@@ -344,25 +344,25 @@

Pagination

default_share_group_ids
any Nullable
types
Array of any

The type of allocation.

group_id
required
integer

The ID of the Group the allocation is associated with.

instrument_id
required
integer

The ID of the Instrument the allocation is associated with.

-
_altdata
string Nullable

Responses

200
post/api/allocation
https://fritz.science/api/allocation

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requests":
    [
    ],
  • "default_requests":
    [
    ],
  • "default_observation_plans":
    [
    ],
  • "catalog_queries":
    [
    ],
  • "observation_plans":
    [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users":
    [
    ],
  • "gcn_triggers":
    [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2024-06-29T14:41:21Z",
  • "end_date": "2024-06-29T14:41:21Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "types":
    [
    ],
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

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

Retrieve all observation analyses

Retrieve all observation analyses

+
_altdata
string Nullable

Responses

200
post/api/allocation
https://fritz.science/api/allocation

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requests":
    [
    ],
  • "default_requests":
    [
    ],
  • "default_observation_plans":
    [
    ],
  • "catalog_queries":
    [
    ],
  • "observation_plans":
    [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users":
    [
    ],
  • "gcn_triggers":
    [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2024-06-29T14:54:57Z",
  • "end_date": "2024-06-29T14:54:57Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "types":
    [
    ],
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

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

Retrieve all observation analyses

Retrieve all observation analyses

query Parameters
gcnevent_id
number

GcnEvent ID to retrieve observation efficiency analyses for

-

Responses

200
400
get/api/survey_efficiency/observations
https://fritz.science/api/survey_efficiency/observations

Response samples

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

Retrieve all observation plan efficiency analyses

Retrieve all observation plan efficiency analyses

+

Responses

200
400
get/api/survey_efficiency/observations
https://fritz.science/api/survey_efficiency/observations

Response samples

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

Retrieve all observation plan efficiency analyses

Retrieve all observation plan efficiency analyses

query Parameters
observation_plan_id
number

EventObservationPlan ID to retrieve observation plan efficiency analyses for

-

Responses

200
400
get/api/survey_efficiency/observation_plan
https://fritz.science/api/survey_efficiency/observation_plan

Response samples

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

observation_plans

Retrieve observation plans associated with an allo

Retrieve observation plans associated with an allocation

+

Responses

200
400
get/api/survey_efficiency/observation_plan
https://fritz.science/api/survey_efficiency/observation_plan

Response samples

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

observation_plans

Retrieve observation plans associated with an allo

Retrieve observation plans associated with an allocation

path Parameters
allocation_id
required
integer
query Parameters
numPerPage
integer

Number of observation plans to return per paginated request. Defaults to 10. Can be no larger than {MAX_OBSERVATION_PLANS}.

pageNumber
integer

Page number for paginated query results. Defaults to 1

-

Responses

200
400
get/api/allocation/observation_plans/allocation_id
https://fritz.science/api/allocation/observation_plans/allocation_id

Response samples

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

Verify that an Observation Plan name exists

Verify that an Observation Plan name exists

+

Responses

200
400
get/api/allocation/observation_plans/allocation_id
https://fritz.science/api/allocation/observation_plans/allocation_id

Response samples

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

Verify that an Observation Plan name exists

Verify that an Observation Plan name exists

query Parameters
name
string

The name of the Observation Plan

Responses

200
400
get/api/observation_plan/plan_names
https://fritz.science/api/observation_plan/plan_names

Response samples

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

Get all Observation Plan names

Get all Observation Plan names

Responses

200
400
get/api/observation_plan
https://fritz.science/api/observation_plan

Response samples

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

Retrieve a default analysis

Retrieve a default analysis

path Parameters
analysis_service_id
required
any

Analysis service ID

default_analysis_id
required
any

Default analysis ID

-

Responses

200
400
get/api/analysis_service/analysis_service_id/default_analysis/default_analysis_id
https://fritz.science/api/analysis_service/analysis_service_id/default_analysis/default_analysis_id

Response samples

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

Delete a default analysis

Delete a default analysis

+

Responses

200
400
get/api/analysis_service/analysis_service_id/default_analysis/default_analysis_id
https://fritz.science/api/analysis_service/analysis_service_id/default_analysis/default_analysis_id

Response samples

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

Delete a default analysis

Delete a default analysis

path Parameters
analysis_service_id
required
integer

Analysis service ID

default_analysis_id
required
integer

Default analysis ID

Responses

200
400
delete/api/analysis_service/analysis_service_id/default_analysis/default_analysis_id
https://fritz.science/api/analysis_service/analysis_service_id/default_analysis/default_analysis_id

Response samples

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

Retrieve all default analyses

Retrieve all default analyses

path Parameters
analysis_service_id
required
any

Analysis service ID, if not provided, return all default analyses for all analysis services

-

Responses

200
400
get/api/analysis_service/analysis_service_id/default_analysis
https://fritz.science/api/analysis_service/analysis_service_id/default_analysis

Response samples

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

Get Swift LSXPS objects and post them as sources. +

Responses

200
400
get/api/analysis_service/analysis_service_id/default_analysis
https://fritz.science/api/analysis_service/analysis_service_id/default_analysis

Response samples

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

Get Swift LSXPS objects and post them as sources.

Get Swift LSXPS objects and post them as sources. Repeated posting will skip the existing source.

Request Body schema: application/json
telescope_name
integer

Name of telescope to assign this catalog to. @@ -378,7 +378,7 @@

Pagination

groupIDs
object

If provided, save to these group IDs.

startDate
str

Arrow parsable string. Filter by start date.

endDate
str

Arrow parsable string. Filter by end date.

-

Responses

200
400
post/api/catalogs/gaia_alerts
https://fritz.science/api/catalogs/gaia_alerts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "telescope_name": "string",
  • "groupIDs": { },
  • "startDate": null,
  • "endDate": null
}

Response samples

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

<no summary>

Responses

200
400
get/api/earthquake/event_id
https://fritz.science/api/earthquake/event_id

Response samples

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

get Gaia parallax and magnitudes and post them as

get Gaia parallax and magnitudes and post them as an annotation, +

Responses

200
400
post/api/catalogs/gaia_alerts
https://fritz.science/api/catalogs/gaia_alerts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "telescope_name": "string",
  • "groupIDs": { },
  • "startDate": null,
  • "endDate": null
}

Response samples

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

<no summary>

Responses

200
400
get/api/earthquake/event_id
https://fritz.science/api/earthquake/event_id

Response samples

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

get Gaia parallax and magnitudes and post them as

get Gaia parallax and magnitudes and post them as an annotation, based on cross-match to the Gaia DR3.

path Parameters
obj_id
required
string

ID of the object to retrieve Gaia colors for

Request Body schema: application/json
catalog
string

The name of the catalog key, associated with a @@ -455,7 +455,7 @@

Pagination

numPerPage
integer

The number of results per page, defaults to 100

include_payload
boolean

Whether to include the payload in the response

include_response
boolean

Whether to include the response in the response

-

Responses

200
400
get/api/tns_robot/tnsrobot_id/submissions
https://fritz.science/api/tns_robot/tnsrobot_id/submissions

Response samples

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

Generate a PDF/PNG finding chart for a position or

Generate a PDF/PNG finding chart for a position or Gaia ID

+

Responses

200
400
get/api/tns_robot/tnsrobot_id/submissions
https://fritz.science/api/tns_robot/tnsrobot_id/submissions

Response samples

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

Generate a PDF/PNG finding chart for a position or

Generate a PDF/PNG finding chart for a position or Gaia ID

query Parameters
location_type
required
string
Enum: "gaia_dr3" "gaia_dr2" "pos"

What is the type of the search? From gaia or by position? If pos then ra and dec should be given. If otherwise, the catalog is queried for id catalog_id and the position information is @@ -476,10 +476,10 @@

Pagination

type
string
Enum: "png" "pdf"

Output datafile type. Defaults to pdf.

num_offset_stars
integer [ 0 .. 4 ]

Number of offset stars to determine and show [0,4] (default: 3)

Responses

200

A PDF/PNG finding chart file

-
400
get/api/unsourced_finder
https://fritz.science/api/unsourced_finder

Response samples

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

analysis_services

Retrieve an Analysis Service by id

Retrieve an Analysis Service by id

-
path Parameters
analysis_service_id
required
integer

Responses

200
400
get/api/analysis_service/analysis_service_id
https://fritz.science/api/analysis_service/analysis_service_id

Response samples

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

Delete an Analysis Service.

Delete an Analysis Service.

+
400
get/api/unsourced_finder
https://fritz.science/api/unsourced_finder

Response samples

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

analysis_services

Retrieve an Analysis Service by id

Retrieve an Analysis Service by id

+
path Parameters
analysis_service_id
required
integer

Responses

200
400
get/api/analysis_service/analysis_service_id
https://fritz.science/api/analysis_service/analysis_service_id

Response samples

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

Delete an Analysis Service.

Delete an Analysis Service.

path Parameters
analysis_service_id
required
integer

Responses

200
delete/api/analysis_service/analysis_service_id
https://fritz.science/api/analysis_service/analysis_service_id

Response samples

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

Retrieve all Analysis Services

Retrieve all Analysis Services

-

Responses

200
400
get/api/analysis_service
https://fritz.science/api/analysis_service

Response samples

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

analysis

Upload an upload_only analysis result

Upload an upload_only analysis result

+

Responses

200
400
get/api/analysis_service
https://fritz.science/api/analysis_service

Response samples

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

analysis

Upload an upload_only analysis result

Upload an upload_only analysis result

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

resource_id
required
string

The ID of the underlying data. @@ -507,9 +507,9 @@

Pagination

Defaults to false.

includeFilename
boolean

Boolean indicating whether to include the filename of the data associated with the analysis in the response. Defaults to false.

-

Responses

200
400
get/api/analysis_resource_type/analysis_id/analysis
https://fritz.science/api/analysis_resource_type/analysis_id/analysis

Response samples

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

Delete an Analysis.

Delete an Analysis.

+

Responses

200
400
get/api/analysis_resource_type/analysis_id/analysis
https://fritz.science/api/analysis_resource_type/analysis_id/analysis

Response samples

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

Delete an Analysis.

Delete an Analysis.

path Parameters
analysis_id
required
integer

Responses

200
delete/api/analysis_resource_type/analysis_id/analysis
https://fritz.science/api/analysis_resource_type/analysis_id/analysis

Response samples

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

Retrieve all Analyses

Retrieve all Analyses

-

Responses

200
400
get/api/analysis_resource_type/analysis_id
https://fritz.science/api/analysis_resource_type/analysis_id

Response samples

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

Begin an analysis run

Begin an analysis run

+

Responses

200
400
get/api/analysis_resource_type/analysis_id
https://fritz.science/api/analysis_resource_type/analysis_id

Response samples

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

Begin an analysis run

Begin an analysis run

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

resource_id
required
string

The ID of the underlying data. @@ -538,9 +538,9 @@

Pagination

Defaults to false.

includeFilename
boolean

Boolean indicating whether to include the filename of the data associated with the analysis in the response. Defaults to false.

-

Responses

200
400
get/api/analysis_resource_type/analysis/analysis_id
https://fritz.science/api/analysis_resource_type/analysis/analysis_id

Response samples

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

Delete an Analysis.

Delete an Analysis.

+

Responses

200
400
get/api/analysis_resource_type/analysis/analysis_id
https://fritz.science/api/analysis_resource_type/analysis/analysis_id

Response samples

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

Delete an Analysis.

Delete an Analysis.

path Parameters
analysis_id
required
integer

Responses

200
delete/api/analysis_resource_type/analysis/analysis_id
https://fritz.science/api/analysis_resource_type/analysis/analysis_id

Response samples

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

Retrieve all Analyses

Retrieve all Analyses

-

Responses

200
400
get/api/analysis_resource_type/analysis
https://fritz.science/api/analysis_resource_type/analysis

Response samples

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

Begin an analysis run

Begin an analysis run

+

Responses

200
400
get/api/analysis_resource_type/analysis
https://fritz.science/api/analysis_resource_type/analysis

Response samples

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

Begin an analysis run

Begin an analysis run

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

resource_id
required
string

The ID of the underlying data. @@ -567,7 +567,7 @@

Pagination

if new plots are to be generated (e.g. with corner plots)

Responses

200

Requested analysis file

400
get/api/analysis_resource_type/analysis/analysis_id/product_type/plot_number
https://fritz.science/api/analysis_resource_type/analysis/analysis_id/product_type/plot_number

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "download": null,
  • "plot_kwargs":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

assignments

Retrieve an observing run assignment

Retrieve an observing run assignment

-
path Parameters
assignment_id
required
integer

Responses

200
400
get/api/assignment/assignment_id
https://fritz.science/api/assignment/assignment_id

Response samples

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

Update an assignment

Update an assignment

+
path Parameters
assignment_id
required
integer

Responses

200
400
get/api/assignment/assignment_id
https://fritz.science/api/assignment/assignment_id

Response samples

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

Update an assignment

Update an assignment

path Parameters
assignment_id
required
integer
Request Body schema: application/json
requester
any Nullable

The User who created this assignment.

last_modified_by
any Nullable
obj
any Nullable

The assigned Obj.

spectra
Array of any
photometry
Array of any
photometric_series
Array of any
run
any Nullable

The ObservingRun this target was assigned to.

@@ -579,15 +579,15 @@

Pagination

run_id
required
integer

ID of the ObservingRun this target was assigned to.

Responses

200
400
put/api/assignment/assignment_id
https://fritz.science/api/assignment/assignment_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requester": null,
  • "last_modified_by": null,
  • "obj": null,
  • "spectra":
    [
    ],
  • "photometry":
    [
    ],
  • "photometric_series":
    [
    ],
  • "run": null,
  • "requester_id": 0,
  • "obj_id": "string",
  • "comment": "string",
  • "status": "string",
  • "priority": "1",
  • "run_id": 0
}

Response samples

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

Delete assignment.

Delete assignment.

path Parameters
assignment_id
required
string

Responses

200
delete/api/assignment/assignment_id
https://fritz.science/api/assignment/assignment_id

Response samples

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

Retrieve all observing run assignments

Retrieve all observing run assignments

-

Responses

200
400
get/api/assignment
https://fritz.science/api/assignment

Response samples

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

Post new target assignment to observing run

Post new target assignment to observing run

-
Request Body schema: application/json
comment
string

An optional comment describing the request.

+

Responses

200
400
get/api/assignment
https://fritz.science/api/assignment

Response samples

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

Post new target assignment to observing run

Post new target assignment to observing run

+
Request Body schema: application/json
priority
required
any
Enum: "1" "2" "3" "4" "5"

Priority of the request, (lowest = 1, highest = 5).

run_id
required
integer
status
string

The status of the request

-
priority
required
any
Enum: "1" "2" "3" "4" "5"

Priority of the request, (lowest = 1, highest = 5).

+
comment
string

An optional comment describing the request.

obj_id
required
string

The ID of the object to observe.

-

Responses

200
post/api/assignment
https://fritz.science/api/assignment

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "comment": "string",
  • "run_id": 0,
  • "status": "string",
  • "priority": "1",
  • "obj_id": "string"
}

Response samples

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

candidates

Retrieve a candidate

Retrieve a candidate

+

Responses

200
post/api/assignment
https://fritz.science/api/assignment

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "priority": "1",
  • "run_id": 0,
  • "status": "string",
  • "comment": "string",
  • "obj_id": "string"
}

Response samples

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

candidates

Retrieve a candidate

Retrieve a candidate

path Parameters
obj_id
required
string
query Parameters
includeComments
boolean

Boolean indicating whether to include associated comments. Defaults to false.

includeAlerts
boolean

Boolean indicating whether to include associated alerts. Defaults to false.

-

Responses

200
400
get/api/candidates/obj_id
https://fritz.science/api/candidates/obj_id

Response samples

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

Check if a Candidate exists

Check if a Candidate exists

+

Responses

200
400
get/api/candidates/obj_id
https://fritz.science/api/candidates/obj_id

Response samples

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

Check if a Candidate exists

Check if a Candidate exists

path Parameters
obj_id
required
string

Responses

200
404
head/api/candidates/obj_id
https://fritz.science/api/candidates/obj_id

Response samples

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

Delete candidate(s)

Delete candidate(s)

path Parameters
obj_id
required
string
filter_id
required
integer

Responses

200
delete/api/candidates/obj_id
https://fritz.science/api/candidates/obj_id

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. @@ -719,17 +719,17 @@

Pagination

passed_at
required
string Nullable

Arrow-parseable datetime string indicating when passed filter.

Responses

200
post/api/candidates/
https://fritz.science/api/candidates/

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "host": null,
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "comments_on_spectra":
    [
    ],
  • "reminders_on_spectra":
    [
    ],
  • "annotations":
    [
    ],
  • "annotations_on_spectra":
    [
    ],
  • "annotations_on_photometry":
    [
    ],
  • "classifications":
    [
    ],
  • "photometry":
    [
    ],
  • "photstats":
    [
    ],
  • "photometric_series":
    [
    ],
  • "spectra":
    [
    ],
  • "thumbnails":
    [
    ],
  • "followup_requests":
    [
    ],
  • "assignments":
    [
    ],
  • "obj_notifications":
    [
    ],
  • "obj_analyses":
    [
    ],
  • "sources_in_gcns":
    [
    ],
  • "tns_submissions":
    [
    ],
  • "id": "string",
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "gcn_crossmatch": null,
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "healpix": 0,
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates":
    [
    ],
  • "sources":
    [
    ],
  • "users":
    [
    ],
  • "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":
    {
    }
}

Delete candidate(s)

Delete candidate(s)

path Parameters
obj_id
required
string
filter_id
required
integer

Responses

200
delete/api/candidates/obj_id/filter_id
https://fritz.science/api/candidates/obj_id/filter_id

Response samples

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

catalog_queries

Submit catalog queries

Submit catalog queries

-
Request Body schema: application/json
target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

+
Request Body schema: application/json
status
string
Default: "pending submission"

The status of the request.

payload
any

Content of the catalog query request.

-
allocation_id
required
integer

Catalog query request allocation ID.

-
status
string
Default: "pending submission"

The status of the request.

-

Responses

200
400
post/api/catalog_queries
https://fritz.science/api/catalog_queries

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group_ids":
    [
    ],
  • "payload": null,
  • "allocation_id": 0,
  • "status": "pending submission"
}

Response samples

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

classifications

Vote for a classification.

Vote for a classification.

+
target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

+
allocation_id
required
integer

Catalog query request allocation ID.

+

Responses

200
400
post/api/catalog_queries
https://fritz.science/api/catalog_queries

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "pending submission",
  • "payload": null,
  • "target_group_ids":
    [
    ],
  • "allocation_id": 0
}

Response samples

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

classifications

Vote for a classification.

Vote for a classification.

path Parameters
classification_id
required
string

ID of classification to indicate the vote for

Request Body schema: application/json
vote
required
integer

Upvote or downvote a classification

Responses

200
post/api/classification/votes/classification_id
https://fritz.science/api/classification/votes/classification_id

Request samples

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

Response samples

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

Delete classification vote.

Delete classification vote.

path Parameters
classification_id
required
string

Responses

200
delete/api/classification/votes/classification_id
https://fritz.science/api/classification/votes/classification_id

Response samples

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

Retrieve a classification

Retrieve a classification

path Parameters
classification_id
required
integer
query Parameters
includeTaxonomy
boolean

Return associated taxonomy.

-

Responses

200
400
get/api/classification/classification_id
https://fritz.science/api/classification/classification_id

Response samples

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

Update a classification

Update a classification

+

Responses

200
400
get/api/classification/classification_id
https://fritz.science/api/classification/classification_id

Response samples

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

Update a classification

Update a classification

path Parameters
classification
required
integer
Request Body schema: application/json
taxonomy
any Nullable

Taxonomy in which this Classification was made.

author
any Nullable

The User that made this classification.

obj
any Nullable

The Classification's Obj.

@@ -765,7 +765,7 @@

Pagination

vote
boolean Nullable

Add vote associated with classification.

label
boolean Nullable

Add label associated with classification.

Responses

200
post/api/classification
https://fritz.science/api/classification

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj_id": "string",
  • "classification": "string",
  • "origin": "string",
  • "taxonomy_id": 0,
  • "probability": null,
  • "group_ids":
    [
    ],
  • "vote": true,
  • "label": true
}

Response samples

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

Retrieve an object's classifications

Retrieve an object's classifications

-
path Parameters
obj_id
required
string

Responses

200
400
get/api/sources/obj_id/classifications
https://fritz.science/api/sources/obj_id/classifications

Response samples

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

Delete all of an object's classifications

Delete all of an object's classifications

+
path Parameters
obj_id
required
string

Responses

200
400
get/api/sources/obj_id/classifications
https://fritz.science/api/sources/obj_id/classifications

Response samples

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

Delete all of an object's classifications

Delete all of an object's classifications

path Parameters
classification_id
required
integer
Request Body schema: application/json
label
boolean Nullable

Add label associated with classification.

Responses

200
delete/api/sources/obj_id/classifications
https://fritz.science/api/sources/obj_id/classifications

Request samples

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

Response samples

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

classification_votes

Vote for a classification.

Vote for a classification.

path Parameters
classification_id
required
string

ID of classification to indicate the vote for

@@ -781,15 +781,15 @@

Pagination

Responses

200
get/api/enum_types
https://fritz.science/api/enum_types

Response samples

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

Retrieve basic DB statistics

Retrieve basic DB statistics

Responses

200
get/api/db_stats
https://fritz.science/api/db_stats

Response samples

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

Retrieve system/deployment info

Retrieve system/deployment info

Responses

200
get/api/sysinfo
https://fritz.science/api/sysinfo

Response samples

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

default_followup_requests

Retrieve a single default follow-up request

Retrieve a single default follow-up request

-
path Parameters
default_followup_request_id
required
integer

Responses

200
400
get/api/default_followup_request/default_followup_request_id
https://fritz.science/api/default_followup_request/default_followup_request_id

Response samples

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

filters

Delete a default follow-up request

Delete a default follow-up request

+
path Parameters
default_followup_request_id
required
integer

Responses

200
400
get/api/default_followup_request/default_followup_request_id
https://fritz.science/api/default_followup_request/default_followup_request_id

Response samples

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

filters

Delete a default follow-up request

Delete a default follow-up request

path Parameters
default_followup_request_id
required
integer

Responses

200
delete/api/default_followup_request/default_followup_request_id
https://fritz.science/api/default_followup_request/default_followup_request_id

Response samples

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

Retrieve all default follow-up requests

Retrieve all default follow-up requests

-

Responses

200
400
get/api/default_followup_request
https://fritz.science/api/default_followup_request

Response samples

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

Retrieve all default gcn tags

Retrieve all default gcn tags

-

Responses

200
400
get/api/default_gcn_tag
https://fritz.science/api/default_gcn_tag

Response samples

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

Delete a default observation plan

Delete a default observation plan

+

Responses

200
400
get/api/default_followup_request
https://fritz.science/api/default_followup_request

Response samples

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

Retrieve all default gcn tags

Retrieve all default gcn tags

+

Responses

200
400
get/api/default_gcn_tag
https://fritz.science/api/default_gcn_tag

Response samples

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

Delete a default observation plan

Delete a default observation plan

path Parameters
default_observation_plan_id
required
integer

Responses

200
delete/api/default_observation_plan/default_observation_plan_id
https://fritz.science/api/default_observation_plan/default_observation_plan_id

Response samples

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

Retrieve all default observation plans

Retrieve all default observation plans

-

Responses

200
400
get/api/default_observation_plan
https://fritz.science/api/default_observation_plan

Response samples

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

Delete a default survey efficiency

Delete a default survey efficiency

+

Responses

200
400
get/api/default_observation_plan
https://fritz.science/api/default_observation_plan

Response samples

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

Delete a default survey efficiency

Delete a default survey efficiency

path Parameters
default_survey_efficiency_id
required
integer

Responses

200
delete/api/default_survey_efficiency/default_survey_efficiency_id
https://fritz.science/api/default_survey_efficiency/default_survey_efficiency_id

Response samples

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

Retrieve all default survey efficiencies

Retrieve all default survey efficiencies

-

Responses

200
400
get/api/default_survey_efficiency
https://fritz.science/api/default_survey_efficiency

Response samples

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

Retrieve a filter

Retrieve a filter

-
path Parameters
filter_id
required
integer

Responses

200
400
get/api/filters/filter_id
https://fritz.science/api/filters/filter_id

Response samples

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

Delete a filter

Delete a filter

+

Responses

200
400
get/api/default_survey_efficiency
https://fritz.science/api/default_survey_efficiency

Response samples

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

Retrieve a filter

Retrieve a filter

+
path Parameters
filter_id
required
integer

Responses

200
400
get/api/filters/filter_id
https://fritz.science/api/filters/filter_id

Response samples

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

Delete a filter

Delete a filter

path Parameters
filter_id
required
integer

Responses

200
delete/api/filters/filter_id
https://fritz.science/api/filters/filter_id

Response samples

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

Update filter name

Update filter name

path Parameters
filter_id
required
integer
Request Body schema: application/json
stream
any Nullable

The Filter's Stream.

group
any Nullable

The Filter's Group.

@@ -797,7 +797,7 @@

Pagination

stream_id
required
integer

ID of the Filter's Stream.

group_id
required
integer

ID of the Filter's Group.

Responses

200
400
patch/api/filters/filter_id
https://fritz.science/api/filters/filter_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "stream": null,
  • "group": null,
  • "candidates":
    [
    ],
  • "name": "string",
  • "stream_id": 0,
  • "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
https://fritz.science/api/filters

Response samples

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

POST a new filter.

POST a new filter.

+

Responses

200
400
get/api/filters
https://fritz.science/api/filters

Response samples

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

POST a new filter.

POST a new filter.

Request Body schema: application/json
stream
any Nullable

The Filter's Stream.

group
any Nullable

The Filter's Group.

candidates
Array of any
name
required
string

Filter name.

@@ -819,24 +819,24 @@

Pagination

update_annotations
boolean

update annotations for existing candidates

auto_followup
boolean | dict

automatically create follow-up requests for passing and autosaved candidates

Responses

200
400
patch/api/filters/filter_id/v
https://fritz.science/api/filters/filter_id/v

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "filter_id": 1,
  • "active": true,
  • "active_fid": "string",
  • "autosave": null,
  • "update_annotations": true,
  • "auto_followup": null
}

Response samples

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

default_followup_request

Create default follow-up request.

Create default follow-up request.

-
Request Body schema: application/json
target_group_ids
Array of integers

IDs of groups to share the results of the default follow-up request with.

-
payload
any

Content of the default follow-up request.

+
Request Body schema: application/json
payload
any

Content of the default follow-up request.

+
target_group_ids
Array of integers

IDs of groups to share the results of the default follow-up request with.

allocation_id
required
integer

Follow-up request allocation ID.

-

Responses

200
post/api/default_followup_request
https://fritz.science/api/default_followup_request

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group_ids":
    [
    ],
  • "payload": null,
  • "allocation_id": 0
}

Response samples

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

defaultgcntags

Retrieve a single default gcn tag

Retrieve a single default gcn tag

-
path Parameters
default_gcn_tag_id
required
integer

Responses

200
400
get/api/default_gcn_tag/default_gcn_tag_id
https://fritz.science/api/default_gcn_tag/default_gcn_tag_id

Response samples

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

Delete a default gcn tag

Delete a default gcn tag

+

Responses

200
post/api/default_followup_request
https://fritz.science/api/default_followup_request

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": null,
  • "target_group_ids":
    [
    ],
  • "allocation_id": 0
}

Response samples

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

defaultgcntags

Retrieve a single default gcn tag

Retrieve a single default gcn tag

+
path Parameters
default_gcn_tag_id
required
integer

Responses

200
400
get/api/default_gcn_tag/default_gcn_tag_id
https://fritz.science/api/default_gcn_tag/default_gcn_tag_id

Response samples

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

Delete a default gcn tag

Delete a default gcn tag

path Parameters
default_gcn_tag_id
required
integer

Responses

200
delete/api/default_gcn_tag/default_gcn_tag_id
https://fritz.science/api/default_gcn_tag/default_gcn_tag_id

Response samples

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

Create default gcn tag.

Create default gcn tag.

-
Request Body schema: application/json
filters
required
any

Filters to determine which of the default gcn tags get executed for which events

-
default_tag_name
required
string

Default tag name.

-

Responses

200
post/api/default_gcn_tag
https://fritz.science/api/default_gcn_tag

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "filters": null,
  • "default_tag_name": "string"
}

Response samples

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

default_observation_plans

Retrieve a single default observation plan

Retrieve a single default observation plan

-
path Parameters
default_observation_plan_id
required
integer

Responses

200
400
get/api/default_observation_plan/default_observation_plan_id
https://fritz.science/api/default_observation_plan/default_observation_plan_id

Response samples

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

default_observation_plan

Create default observation plan requests.

Create default observation plan requests.

-
Request Body schema: application/json
target_group_ids
Array of integers

IDs of groups to share the results of the default observation plan request with.

-
payload
any

Content of the default observation plan request.

+
Request Body schema: application/json
default_tag_name
required
string

Default tag name.

+
filters
required
any

Filters to determine which of the default gcn tags get executed for which events

+

Responses

200
post/api/default_gcn_tag
https://fritz.science/api/default_gcn_tag

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "default_tag_name": "string",
  • "filters": null
}

Response samples

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

default_observation_plans

Retrieve a single default observation plan

Retrieve a single default observation plan

+
path Parameters
default_observation_plan_id
required
integer

Responses

200
400
get/api/default_observation_plan/default_observation_plan_id
https://fritz.science/api/default_observation_plan/default_observation_plan_id

Response samples

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

default_observation_plan

Create default observation plan requests.

Create default observation plan requests.

+
Request Body schema: application/json
payload
any

Content of the default observation plan request.

+
target_group_ids
Array of integers

IDs of groups to share the results of the default observation plan request with.

allocation_id
required
integer

Observation plan request allocation ID.

-

Responses

200
post/api/default_observation_plan
https://fritz.science/api/default_observation_plan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group_ids":
    [
    ],
  • "payload": null,
  • "allocation_id": 0
}

Response samples

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

default_survey_efficiencys

Retrieve a single default survey efficiency

Retrieve a single default survey efficiency

-
path Parameters
default_survey_efficiency_id
required
integer

Responses

200
400
get/api/default_survey_efficiency/default_survey_efficiency_id
https://fritz.science/api/default_survey_efficiency/default_survey_efficiency_id

Response samples

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

default_survey_efficiency

Create default survey efficiency requests.

Create default survey efficiency requests.

-
Request Body schema: application/json
payload
any

Content of the default survey efficiency analysis.

-
default_observationplan_request_id
required
integer

Default observation plan request ID.

-

Responses

200
post/api/default_survey_efficiency
https://fritz.science/api/default_survey_efficiency

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": null,
  • "default_observationplan_request_id": 0
}

Response samples

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

facility

Post a message from a remote facility

Post a message from a remote facility

+

Responses

200
post/api/default_observation_plan
https://fritz.science/api/default_observation_plan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": null,
  • "target_group_ids":
    [
    ],
  • "allocation_id": 0
}

Response samples

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

default_survey_efficiencys

Retrieve a single default survey efficiency

Retrieve a single default survey efficiency

+
path Parameters
default_survey_efficiency_id
required
integer

Responses

200
400
get/api/default_survey_efficiency/default_survey_efficiency_id
https://fritz.science/api/default_survey_efficiency/default_survey_efficiency_id

Response samples

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

default_survey_efficiency

Create default survey efficiency requests.

Create default survey efficiency requests.

+
Request Body schema: application/json
default_observationplan_request_id
required
integer

Default observation plan request ID.

+
payload
any

Content of the default survey efficiency analysis.

+

Responses

200
post/api/default_survey_efficiency
https://fritz.science/api/default_survey_efficiency

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "default_observationplan_request_id": 0,
  • "payload": null
}

Response samples

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

facility

Post a message from a remote facility

Post a message from a remote facility

Request Body schema: application/json
One of
  • SEDMListener
new_status
required
string
followup_request_id
required
integer

Responses

200
400
post/api/facility
https://fritz.science/api/facility

Request samples

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

Response samples

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

followup_requests

Update a follow-up request comment

Update a follow-up request comment

path Parameters
followup_request_id
required
string
query Parameters
comment
string

Comment to add to the follow-up request

Responses

200
400
put/api/followup_request/followup_request_id/comment
https://fritz.science/api/followup_request/followup_request_id/comment

Response samples

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

Add follow-up request to watch list

Add follow-up request to watch list

@@ -862,45 +862,45 @@

Pagination

magnitudeRange
list

lowest and highest magnitude to return, e.g. "(12,9)"

output_format
string

Output format for schedule. Can be png, pdf, or csv

Responses

200

A PDF/PNG schedule file

-
400
get/api/followup_request/schedule/instrument_id
https://fritz.science/api/followup_request/schedule/instrument_id

Response samples

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

Reprioritize followup requests schedule automatica

Reprioritize followup requests schedule automatically based on +

400
get/api/followup_request/schedule/instrument_id
https://fritz.science/api/followup_request/schedule/instrument_id

Response samples

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

Reprioritize followup requests schedule automatica

Reprioritize followup requests schedule automatically based on either magnitude or location within skymap.

Responses

200
400
put/api/followup_request/prioritization
https://fritz.science/api/followup_request/prioritization

Response samples

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

Update a follow-up request

Update a follow-up request

-
path Parameters
request_id
required
string
Request Body schema: application/json
allocation_id
required
integer

Followup request allocation ID.

-
not_if_spectra_exist
boolean

If true, the followup request will not be executed if there are any sources within radius that have spectra.

-
not_if_classified
boolean

If true, the followup request will not be executed if there are any sources within radius with (human-only) classifications.

+
path Parameters
request_id
required
string
Request Body schema: application/json
payload
any

Content of the followup request.

radius
number

Radius of to use when checking constraints.

target_group_ids
Array of integers

IDs of groups to share the results of the followup request with.

-
payload
any

Content of the followup request.

+
allocation_id
required
integer

Followup request allocation ID.

+
not_if_classified
boolean

If true, the followup request will not be executed if there are any sources within radius with (human-only) classifications.

+
not_if_spectra_exist
boolean

If true, the followup request will not be executed if there are any sources within radius that have spectra.

status
string
Default: "pending submission"

The status of the request.

-
not_if_duplicates
boolean

If true, the followup request will not be executed if the object already has a pending or completed request of the same allocation.

-
ignore_source_group_ids
Array of integers

If there are any sources within radius saved to any of these groups, the followup request will not be executed.

not_if_tns_classified
boolean

If true, the followup request will not be executed if any object within radius is already classified as SN in TNS.

-
obj_id
required
string

ID of the target Obj.

-
source_group_ids
Array of integers

IDs of groups to which there must be a source for the object associated with the followup request.

-

Responses

200
400
put/api/followup_request/request_id
https://fritz.science/api/followup_request/request_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allocation_id": 0,
  • "not_if_spectra_exist": true,
  • "not_if_classified": true,
  • "radius": 0,
  • "target_group_ids":
    [
    ],
  • "payload": null,
  • "status": "pending submission",
  • "not_if_duplicates": true,
  • "ignore_source_group_ids":
    [
    ],
  • "not_if_tns_classified": true,
  • "obj_id": "string",
  • "source_group_ids":
    [
    ]
}

Response samples

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

Delete follow-up request.

Delete follow-up request.

+
ignore_source_group_ids
Array of integers

If there are any sources within radius saved to any of these groups, the followup request will not be executed.

+
source_group_ids
Array of integers

IDs of groups to which there must be a source for the object associated with the followup request.

+
not_if_duplicates
boolean

If true, the followup request will not be executed if the object already has a pending or completed request of the same allocation.

+
obj_id
required
string

ID of the target Obj.

+

Responses

200
400
put/api/followup_request/request_id
https://fritz.science/api/followup_request/request_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": null,
  • "radius": 0,
  • "target_group_ids":
    [
    ],
  • "allocation_id": 0,
  • "not_if_classified": true,
  • "not_if_spectra_exist": true,
  • "status": "pending submission",
  • "not_if_tns_classified": true,
  • "ignore_source_group_ids":
    [
    ],
  • "source_group_ids":
    [
    ],
  • "not_if_duplicates": true,
  • "obj_id": "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
https://fritz.science/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
allocation_id
required
integer

Followup request allocation ID.

-
not_if_spectra_exist
boolean

If true, the followup request will not be executed if there are any sources within radius that have spectra.

-
not_if_classified
boolean

If true, the followup request will not be executed if there are any sources within radius with (human-only) classifications.

+
Request Body schema: application/json
payload
any

Content of the followup request.

radius
number

Radius of to use when checking constraints.

target_group_ids
Array of integers

IDs of groups to share the results of the followup request with.

-
payload
any

Content of the followup request.

+
allocation_id
required
integer

Followup request allocation ID.

+
not_if_classified
boolean

If true, the followup request will not be executed if there are any sources within radius with (human-only) classifications.

+
not_if_spectra_exist
boolean

If true, the followup request will not be executed if there are any sources within radius that have spectra.

status
string
Default: "pending submission"

The status of the request.

-
not_if_duplicates
boolean

If true, the followup request will not be executed if the object already has a pending or completed request of the same allocation.

-
ignore_source_group_ids
Array of integers

If there are any sources within radius saved to any of these groups, the followup request will not be executed.

not_if_tns_classified
boolean

If true, the followup request will not be executed if any object within radius is already classified as SN in TNS.

-
obj_id
required
string

ID of the target Obj.

-
source_group_ids
Array of integers

IDs of groups to which there must be a source for the object associated with the followup request.

-

Responses

200
post/api/followup_request
https://fritz.science/api/followup_request

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allocation_id": 0,
  • "not_if_spectra_exist": true,
  • "not_if_classified": true,
  • "radius": 0,
  • "target_group_ids":
    [
    ],
  • "payload": null,
  • "status": "pending submission",
  • "not_if_duplicates": true,
  • "ignore_source_group_ids":
    [
    ],
  • "not_if_tns_classified": true,
  • "obj_id": "string",
  • "source_group_ids":
    [
    ]
}

Response samples

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

Get photometry request.

Get photometry request.

+
ignore_source_group_ids
Array of integers

If there are any sources within radius saved to any of these groups, the followup request will not be executed.

+
source_group_ids
Array of integers

IDs of groups to which there must be a source for the object associated with the followup request.

+
not_if_duplicates
boolean

If true, the followup request will not be executed if the object already has a pending or completed request of the same allocation.

+
obj_id
required
string

ID of the target Obj.

+

Responses

200
post/api/followup_request
https://fritz.science/api/followup_request

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": null,
  • "radius": 0,
  • "target_group_ids":
    [
    ],
  • "allocation_id": 0,
  • "not_if_classified": true,
  • "not_if_spectra_exist": true,
  • "status": "pending submission",
  • "not_if_tns_classified": true,
  • "ignore_source_group_ids":
    [
    ],
  • "source_group_ids":
    [
    ],
  • "not_if_duplicates": true,
  • "obj_id": "string"
}

Response samples

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

Get photometry request.

Get photometry request.

path Parameters
request_id
required
string

Responses

200
get/api/photometry_request/request_id
https://fritz.science/api/photometry_request/request_id

Response samples

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

galaxys

Upload galaxies from GLADE+ catalog. If no file_na

Upload galaxies from GLADE+ catalog. If no file_name or file_url is provided, will look for the GLADE+ catalog in the data directory. If it can't be found, it will download it.

Request Body schema: application/json
file_name
string

Name of the file containing the galaxies (in the data directory)

file_url
string

URL of the file containing the galaxies

Responses

200
400
post/api/galaxy_catalog/glade
https://fritz.science/api/galaxy_catalog/glade

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "file_name": "string",
  • "file_url": "string"
}

Response samples

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

Upload galaxies from ASCII file

Upload galaxies from ASCII file

-
Request Body schema: application/json
catalogURL
string Nullable
Default: null

Galaxy catalog URL.

-
catalogData
required
any

Catalog data Ascii string

+
Request Body schema: application/json
catalogData
required
any

Catalog data Ascii string

+
catalogURL
string Nullable
Default: null

Galaxy catalog URL.

catalogName
required
string

Galaxy catalog name.

catalogDescription
string Nullable
Default: null

Galaxy catalog description.

-

Responses

200
400
post/api/galaxy_catalog/ascii
https://fritz.science/api/galaxy_catalog/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "catalogURL": null,
  • "catalogData": null,
  • "catalogName": "string",
  • "catalogDescription": null
}

Response samples

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

Set an object's host galaxy

Set an object's host galaxy

+

Responses

200
400
post/api/galaxy_catalog/ascii
https://fritz.science/api/galaxy_catalog/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "catalogData": null,
  • "catalogURL": null,
  • "catalogName": "string",
  • "catalogDescription": null
}

Response samples

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

Set an object's host galaxy

Set an object's host galaxy

path Parameters
obj_id
required
string
Request Body schema: application/json
galaxyName
required
string

Name of the galaxy to associate with the object

Responses

200
400
post/api/sources/obj_id/host
https://fritz.science/api/sources/obj_id/host

Request samples

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

Response samples

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

Delete an object's host galaxy

Delete an object's host galaxy

path Parameters
obj_id
required
string

Responses

200
400
delete/api/sources/obj_id/host
https://fritz.science/api/sources/obj_id/host

Response samples

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

Upload spatial catalog from ASCII file

Upload spatial catalog from ASCII file

@@ -937,12 +937,12 @@

Pagination

Defaults to no sorting unless a localization and catalog are provided, then defaults to mstar_prob_weighted.

sortOrder
string

Sort order. Can be one of the following: asc, desc. Defaults to None unless a localization and catalog are provided, then defaults to desc.

-

Responses

200
400
get/api/galaxy_catalog/catalog_name
https://fritz.science/api/galaxy_catalog/catalog_name

Response samples

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

Ingest a Galaxy catalog

Ingest a Galaxy catalog

-
Request Body schema: application/json
catalog_data
required
Array of any

Galaxy catalog data

+

Responses

200
400
get/api/galaxy_catalog/catalog_name
https://fritz.science/api/galaxy_catalog/catalog_name

Response samples

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

Ingest a Galaxy catalog

Ingest a Galaxy catalog

+
Request Body schema: application/json
catalog_url
string Nullable
Default: null

Galaxy catalog URL.

catalog_description
string Nullable
Default: null

Galaxy catalog description.

catalog_name
required
string

Galaxy catalog name.

-
catalog_url
string Nullable
Default: null

Galaxy catalog URL.

-

Responses

200
400
post/api/galaxy_catalog
https://fritz.science/api/galaxy_catalog

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "catalog_data":
    [
    ],
  • "catalog_description": null,
  • "catalog_name": "string",
  • "catalog_url": null
}

Response samples

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

Ingest a Spatial Catalog

Ingest a Spatial Catalog

+
catalog_data
required
Array of any

Galaxy catalog data

+

Responses

200
400
post/api/galaxy_catalog
https://fritz.science/api/galaxy_catalog

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "catalog_url": null,
  • "catalog_description": null,
  • "catalog_name": "string",
  • "catalog_data":
    [
    ]
}

Response samples

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

Ingest a Spatial Catalog

Ingest a Spatial Catalog

Request Body schema: application/json
catalog_data
Array of any

Spatial catalog data

catalog_name
string

Spatial catalog name.

Responses

200
400
post/api/spatial_catalog
https://fritz.science/api/spatial_catalog

Request samples

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

Response samples

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

instruments

Delete a galaxy catalog

Delete a galaxy catalog

@@ -978,7 +978,7 @@

Pagination

table.

localizationCumprob
number

Cumulative probability up to which to include fields. Defaults to 0.95.

-

Responses

200
400
get/api/instrument/instrument_id
https://fritz.science/api/instrument/instrument_id

Response samples

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

Update instrument

Update instrument

+

Responses

200
400
get/api/instrument/instrument_id
https://fritz.science/api/instrument/instrument_id

Response samples

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

Update instrument

Update instrument

path Parameters
instrument_id
required
integer
Request Body schema: application/json
telescope
any Nullable

The Telescope that hosts the Instrument.

photometry
Array of any
photometric_series
Array of any
spectra
Array of any
allocations
Array of any
observing_runs
Array of any
observations
Array of any
queued_observations
Array of any
fields
Array of any
tiles
Array of any
plans
Array of any
logs
Array of any
tnsrobots
Array of any
name
required
string

Instrument name.

type
required
string <= 20 characters
Enum: "imager" "spectrograph" "imaging spectrograph"

Instrument type, one of Imager, Spectrograph, or Imaging Spectrograph.

@@ -997,7 +997,7 @@

Pagination

region
string Nullable

Instrument astropy.regions representation.

has_fields
boolean

Whether the instrument has fields or not.

has_region
boolean

Whether the instrument has a region or not.

-

Responses

200
400
put/api/instrument/instrument_id
https://fritz.science/api/instrument/instrument_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "telescope": null,
  • "photometry":
    [
    ],
  • "photometric_series":
    [
    ],
  • "spectra":
    [
    ],
  • "allocations":
    [
    ],
  • "observing_runs":
    [
    ],
  • "observations":
    [
    ],
  • "queued_observations":
    [
    ],
  • "fields":
    [
    ],
  • "tiles":
    [
    ],
  • "plans":
    [
    ],
  • "logs":
    [
    ],
  • "tnsrobots":
    [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters":
    [
    ],
  • "sensitivity_data": null,
  • "configuration_data": null,
  • "status": null,
  • "last_status_update": "2024-06-29T14:41:21Z",
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true
}

Response samples

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

Delete an instrument

Delete an instrument

+

Responses

200
400
put/api/instrument/instrument_id
https://fritz.science/api/instrument/instrument_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "telescope": null,
  • "photometry":
    [
    ],
  • "photometric_series":
    [
    ],
  • "spectra":
    [
    ],
  • "allocations":
    [
    ],
  • "observing_runs":
    [
    ],
  • "observations":
    [
    ],
  • "queued_observations":
    [
    ],
  • "fields":
    [
    ],
  • "tiles":
    [
    ],
  • "plans":
    [
    ],
  • "logs":
    [
    ],
  • "tnsrobots":
    [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters":
    [
    ],
  • "sensitivity_data": null,
  • "configuration_data": null,
  • "status": null,
  • "last_status_update": "2024-06-29T14:54:58Z",
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true
}

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
query Parameters
fieldsOnly
boolean

Boolean indicating whether to just delete the associated fields. Defaults to false.

Responses

200
400
delete/api/instrument/instrument_id
https://fritz.science/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

@@ -1026,7 +1026,7 @@

Pagination

airmassTime
string

Time to use for airmass calculation in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sss). Defaults to localizationDateobs if not supplied.

-

Responses

200
400
get/api/instrument
https://fritz.science/api/instrument

Response samples

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

Add a new instrument

Add a new instrument

+

Responses

200
400
get/api/instrument
https://fritz.science/api/instrument

Response samples

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

Add a new instrument

Add a new instrument

Request Body schema: application/json
telescope
any Nullable

The Telescope that hosts the Instrument.

photometry
Array of any
photometric_series
Array of any
spectra
Array of any
allocations
Array of any
observing_runs
Array of any
observations
Array of any
queued_observations
Array of any
fields
Array of any
tiles
Array of any
plans
Array of any
logs
Array of any
tnsrobots
Array of any
name
required
string

Instrument name.

type
required
string <= 20 characters
Enum: "imager" "spectrograph" "imaging spectrograph"

Instrument type, one of Imager, Spectrograph, or Imaging Spectrograph.

@@ -1057,10 +1057,10 @@

Pagination

Single float radius in degrees in case of circle or list of two floats (height and width) in case of a rectangle.

-

Responses

200
400
post/api/instrument
https://fritz.science/api/instrument

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "telescope": null,
  • "photometry":
    [
    ],
  • "photometric_series":
    [
    ],
  • "spectra":
    [
    ],
  • "allocations":
    [
    ],
  • "observing_runs":
    [
    ],
  • "observations":
    [
    ],
  • "queued_observations":
    [
    ],
  • "fields":
    [
    ],
  • "tiles":
    [
    ],
  • "plans":
    [
    ],
  • "logs":
    [
    ],
  • "tnsrobots":
    [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters":
    [
    ],
  • "sensitivity_data":
    {
    },
  • "configuration_data":
    {
    },
  • "status": null,
  • "last_status_update": "2024-06-29T14:41:21Z",
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true,
  • "field_data": null,
  • "field_region": null,
  • "references": null,
  • "field_fov_type": null,
  • "field_fov_attributes": null
}

Response samples

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

Delete a spatial catalog

Delete a spatial catalog

+

Responses

200
400
post/api/instrument
https://fritz.science/api/instrument

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "telescope": null,
  • "photometry":
    [
    ],
  • "photometric_series":
    [
    ],
  • "spectra":
    [
    ],
  • "allocations":
    [
    ],
  • "observing_runs":
    [
    ],
  • "observations":
    [
    ],
  • "queued_observations":
    [
    ],
  • "fields":
    [
    ],
  • "tiles":
    [
    ],
  • "plans":
    [
    ],
  • "logs":
    [
    ],
  • "tnsrobots":
    [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters":
    [
    ],
  • "sensitivity_data":
    {
    },
  • "configuration_data":
    {
    },
  • "status": null,
  • "last_status_update": "2024-06-29T14:54:58Z",
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true,
  • "field_data": null,
  • "field_region": null,
  • "references": null,
  • "field_fov_type": null,
  • "field_fov_attributes": null
}

Response samples

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

Delete a spatial catalog

Delete a spatial catalog

path Parameters
catalog_id
required
integer

Responses

200
400
delete/api/spatial_catalog/catalog_id
https://fritz.science/api/spatial_catalog/catalog_id

Response samples

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

earthquakeevents

Perform a prediction analysis for the earthquake.

Perform a prediction analysis for the earthquake.

path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

200
post/api/earthquake/earthquake_id/mmadetector/mma_detector_id/predictions
https://fritz.science/api/earthquake/earthquake_id/mmadetector/mma_detector_id/predictions

Response samples

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

Retrieve a ground velocity measurement for the ear

Retrieve a ground velocity measurement for the earthquake.

-
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

200
get/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements
https://fritz.science/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements

Response samples

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

Provide a ground velocity measurement for the eart

Provide a ground velocity measurement for the earthquake.

+
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

200
get/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements
https://fritz.science/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements

Response samples

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

Provide a ground velocity measurement for the eart

Provide a ground velocity measurement for the earthquake.

path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

200
post/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements
https://fritz.science/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements

Response samples

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

Delete a ground velocity measurement for the earth

Delete a ground velocity measurement for the earthquake.

path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

200
delete/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements
https://fritz.science/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements

Response samples

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

Update a ground velocity measurement for the earth

Update a ground velocity measurement for the earthquake.

path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

200
patch/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements
https://fritz.science/api/earthquake/earthquake_id/mmadetector/mma_detector_id/measurements

Response samples

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

Get all Earthquake status tags

Get all Earthquake status tags

@@ -1085,7 +1085,7 @@

Pagination

that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Update a comment

Update a comment

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Update a comment

Update a comment

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectrum" "gcn_event" "shift"

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event" "shift"

The ID of the source or spectrum @@ -1127,14 +1127,14 @@

Pagination

This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Update a comment

Update a comment

+

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Update a comment

Update a comment

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectrum" "gcn_event" "shift"

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event" "shift"

The ID of the source or spectrum @@ -1176,7 +1176,7 @@

Pagination

that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Update a comment

Update a comment

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Update a comment

Update a comment

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectrum" "gcn_event" "shift"

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event" "shift"

The ID of the source or spectrum @@ -1231,47 +1231,47 @@

Pagination

that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Retrieve a comment

Retrieve a comment

+

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Retrieve a reminder

Retrieve a reminder

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Retrieve a reminder

Retrieve a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift" "earthquake"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake"

resource_id
required
string

The ID of the source, spectrum, gcn_event or shift that the reminder is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event

-
reminder_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Response samples

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

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+
reminder_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Response samples

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

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

calculate healpix values for a batch of sources wi

calculate healpix values for a batch of sources without a Healpix value

+

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

calculate healpix values for a batch of sources wi

calculate healpix values for a batch of sources without a Healpix value

query Parameters
numPerPage
integer

Number of sources to check for updates. Defaults to 100. Max 500.

pageNumber
integer

Page number for iterating through all sources. Defaults to 1

Responses

200
400
post/api/healpix
https://fritz.science/api/healpix

Response samples

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

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

@@ -1295,11 +1295,11 @@

Pagination

type
string
Enum: "png" "pdf"

output type

num_offset_stars
integer [ 0 .. 4 ]

output desired number of offset stars [0,5] (default: 3)

Responses

200

A PDF/PNG finding chart file

-
400
get/api/sources/obj_id/finder
https://fritz.science/api/sources/obj_id/finder

Response samples

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

Retrieve an object's classifications

Retrieve an object's classifications

-
path Parameters
obj_id
required
string

Responses

200
400
get/api/sources/obj_id/classifications
https://fritz.science/api/sources/obj_id/classifications

Response samples

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

Delete all of an object's classifications

Delete all of an object's classifications

+
400
get/api/sources/obj_id/finder
https://fritz.science/api/sources/obj_id/finder

Response samples

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

Retrieve an object's classifications

Retrieve an object's classifications

+
path Parameters
obj_id
required
string

Responses

200
400
get/api/sources/obj_id/classifications
https://fritz.science/api/sources/obj_id/classifications

Response samples

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

Delete all of an object's classifications

Delete all of an object's classifications

path Parameters
classification_id
required
integer
Request Body schema: application/json
label
boolean Nullable

Add label associated with classification.

Responses

200
delete/api/sources/obj_id/classifications
https://fritz.science/api/sources/obj_id/classifications

Request samples

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

Response samples

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

Retrieve basic info on Groups that an Obj is saved

Retrieve basic info on Groups that an Obj is saved to

-
path Parameters
obj_id
required
integer

Responses

200
400
get/api/sources/obj_id/groups
https://fritz.science/api/sources/obj_id/groups

Response samples

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

Note that a source has been labelled.

Note that a source has been labelled.

+
path Parameters
obj_id
required
integer

Responses

200
400
get/api/sources/obj_id/groups
https://fritz.science/api/sources/obj_id/groups

Response samples

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

Note that a source has been labelled.

Note that a source has been labelled.

path Parameters
obj_id
required
string

ID of object to indicate source labelling for

Request Body schema: application/json
groupIds
required
Array of integers

List of IDs of groups to indicate labelling for

Responses

200
post/api/sources/obj_id/labels
https://fritz.science/api/sources/obj_id/labels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "groupIds":
    [
    ]
}

Response samples

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

Delete source labels

Delete source labels

@@ -1310,13 +1310,13 @@

Pagination

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Retrieve an annotation

Retrieve an annotation

+

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Retrieve an annotation

Retrieve an annotation

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra" "photometry"

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

Response samples

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

Retrieve a source

Retrieve a source

+
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

Response samples

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

Retrieve a source

Retrieve a source

path Parameters
obj_id
required
string

Source ID

query Parameters
TNSname
string

TNS name for the source

includePhotometry
boolean

Boolean indicating whether to include associated photometry. Defaults to @@ -1332,7 +1332,7 @@

Pagination

includeCommentExists
boolean

Boolean indicating whether to return if a source has a comment. Defaults to false.

includePeriodExists
boolean

Boolean indicating whether to return if a source has a period set. Defaults to false.

includeThumbnails
boolean

Boolean indicating whether to include associated thumbnails. Defaults to false.

-

Responses

200
400
get/api/sources/obj_id
https://fritz.science/api/sources/obj_id

Response samples

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

Delete a source

Delete a source

+

Responses

200
400
get/api/sources/obj_id
https://fritz.science/api/sources/obj_id

Response samples

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

Delete a source

Delete a source

path Parameters
obj_id
required
string
group_id
required
string

Responses

200
delete/api/sources/obj_id
https://fritz.science/api/sources/obj_id

Response samples

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

Check if a Source exists

Check if a Source exists

path Parameters
obj_id
required
string

Responses

200
404
head/api/sources/obj_id
https://fritz.science/api/sources/obj_id

Response samples

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

Update a source

Update a source

path Parameters
obj_id
required
string
Request Body schema: application/json
host
any Nullable

The Galaxy associated with this source.

@@ -1531,47 +1531,47 @@

Pagination

that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Retrieve a comment

Retrieve a comment

+

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Retrieve a reminder

Retrieve a reminder

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Retrieve a reminder

Retrieve a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift" "earthquake"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake"

resource_id
required
string

The ID of the source, spectrum, gcn_event or shift that the reminder is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event

-
reminder_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Response samples

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

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+
reminder_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Response samples

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

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

Retrieve all spectra associated with an Object

Retrieve all spectra associated with an Object

+

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

Retrieve all spectra associated with an Object

Retrieve all spectra associated with an Object

path Parameters
obj_id
required
string

ID of the object to retrieve spectra for

query Parameters
normalization
string

what normalization is needed for the spectra (e.g., "median"). If omitted, returns the original spectrum. @@ -1583,42 +1583,42 @@

Pagination

Options are: observed_at, created_at

sortOrder
string

The order to sort the spectra by. Defaults to asc. Options are: asc, desc

-

Responses

200
400
get/api/sources/obj_id/spectra
https://fritz.science/api/sources/obj_id/spectra

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

200
400
get/api/sources/obj_id/spectra
https://fritz.science/api/sources/obj_id/spectra

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Retrieve an annotation

Retrieve an annotation

+

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Retrieve an annotation

Retrieve an annotation

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra" "photometry"

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

Response samples

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

Retrieve a spectrum

Retrieve a spectrum

-
path Parameters
spectrum_id
required
integer

Responses

200
403
get/api/spectra/spectrum_id
https://fritz.science/api/spectra/spectrum_id

Response samples

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

Update spectrum

Update spectrum

-
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

-
external_observer
string Nullable
Default: null

Free text provided as an external observer

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

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
403
get/api/spectra/spectrum_id
https://fritz.science/api/spectra/spectrum_id

Response samples

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

Update spectrum

Update spectrum

+
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
altdata
any

Miscellaneous alternative metadata.

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

obj_id
required
string

ID of this Spectrum's Obj.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

+
external_observer
string Nullable
Default: null

Free text provided as an external observer

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
origin
string

Origin of the spectrum.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

external_pi
string Nullable
Default: null

Free text provided as an external PI

-
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-

Responses

200
400
put/api/spectra/spectrum_id
https://fritz.science/api/spectra/spectrum_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "external_reducer": null,
  • "group_ids": [ ],
  • "observed_by": [ ],
  • "fluxes":
    [
    ],
  • "type": "source",
  • "external_observer": null,
  • "wavelengths":
    [
    ],
  • "obj_id": "string",
  • "instrument_id": 0,
  • "units": "string",
  • "errors":
    [
    ],
  • "label": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "external_pi": null,
  • "pi": [ ],
  • "reduced_by": [ ],
  • "origin": "string",
  • "altdata": null
}

Response samples

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

Delete a spectrum

Delete a spectrum

+
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+

Responses

200
400
put/api/spectra/spectrum_id
https://fritz.science/api/spectra/spectrum_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observed_by": [ ],
  • "observed_at": "2024-06-29T14:54:58Z",
  • "followup_request_id": 0,
  • "altdata": null,
  • "assignment_id": 0,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "external_observer": null,
  • "label": "string",
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "origin": "string",
  • "units": "string",
  • "type": "source",
  • "errors":
    [
    ],
  • "group_ids": [ ],
  • "external_pi": null,
  • "external_reducer": null,
  • "reduced_by": [ ],
  • "pi": [ ]
}

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/spectra/spectrum_id
https://fritz.science/api/spectra/spectrum_id

Response samples

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

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

query Parameters
minimalPayload
boolean

If true, return only the minimal metadata about each spectrum, instead of returning @@ -1658,30 +1658,29 @@

Pagination

commentsFilterAfter
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, only return sources that have comments after this time.

get/api/spectra
https://fritz.science/api/spectra

Upload spectrum

Upload spectrum

-
Request Body schema: application/json
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

-
external_observer
string Nullable
Default: null

Free text provided as an external observer

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
Request Body schema: application/json
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
altdata
any

Miscellaneous alternative metadata.

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

obj_id
required
string

ID of this Spectrum's Obj.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

+
external_observer
string Nullable
Default: null

Free text provided as an external observer

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
origin
string

Origin of the spectrum.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

external_pi
string Nullable
Default: null

Free text provided as an external PI

-
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-

Responses

200
400
post/api/spectra
https://fritz.science/api/spectra

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "external_reducer": null,
  • "group_ids": [ ],
  • "observed_by": [ ],
  • "fluxes":
    [
    ],
  • "type": "source",
  • "external_observer": null,
  • "wavelengths":
    [
    ],
  • "obj_id": "string",
  • "instrument_id": 0,
  • "units": "string",
  • "errors":
    [
    ],
  • "label": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "external_pi": null,
  • "pi": [ ],
  • "reduced_by": [ ],
  • "origin": "string",
  • "altdata": null
}

Response samples

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

Parse spectrum from ASCII file

Parse spectrum from ASCII file

-
Request Body schema: application/json
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

-
ascii
required
string

The content of the ASCII file to be parsed.

+
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+

Responses

200
400
post/api/spectra
https://fritz.science/api/spectra

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observed_by": [ ],
  • "observed_at": "2024-06-29T14:54:58Z",
  • "followup_request_id": 0,
  • "altdata": null,
  • "assignment_id": 0,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "external_observer": null,
  • "label": "string",
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "origin": "string",
  • "units": "string",
  • "type": "source",
  • "errors":
    [
    ],
  • "group_ids": [ ],
  • "external_pi": null,
  • "external_reducer": null,
  • "reduced_by": [ ],
  • "pi": [ ]
}

Response samples

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

Parse spectrum from ASCII file

Parse spectrum from ASCII file

+
Request Body schema: application/json
ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

The lines that make up the ASCII header must appear at the beginning of the file and all be formatted the same way within a single file. They can be formatted in one of two ways.

1) # KEY: VALUE
@@ -1755,20 +1754,11 @@ 
Pagination

 7966.80 1.029127
 7976.00 1.019637
 7985.20 0.732859
-7994.40 1.236514
fluxerr_column
integer Nullable
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

-
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

-

Responses

200
400
post/api/spectra/parse/ascii
https://fritz.science/api/spectra/parse/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "wave_column": 0,
  • "ascii": "string",
  • "fluxerr_column": null,
  • "flux_column": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "instrument": null,
  • "groups":
    [
    ],
  • "pis":
    [
    ],
  • "reducers":
    [
    ],
  • "observers":
    [
    ],
  • "followup_request": null,
  • "assignment": null,
  • "owner": null,
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "annotations":
    [
    ],
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "errors":
    [
    ],
  • "units": "string",
  • "obj_id": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "origin": "string",
  • "type": "source",
  • "label": "string",
  • "instrument_id": 0,
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "altdata": null,
  • "original_file_string": "string",
  • "original_file_filename": "string"
}

Upload spectrum from ASCII file

Upload spectrum from ASCII file

-
Request Body schema: application/json
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

-
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

-
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+7994.40 1.236514
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

fluxerr_column
integer Nullable
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

-
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. - Defaults to 'fsource'.

-
external_observer
string Nullable
Default: null

Free text provided as an external observer

-
obj_id
required
string

The ID of the object that the spectrum is of.

-
instrument_id
required
integer

The ID of the instrument that took the spectrum.

-
label
string

User defined label to be placed in plot legends, instead of the default -.

+
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

+

Responses

200
400
post/api/spectra/parse/ascii
https://fritz.science/api/spectra/parse/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ascii": "string",
  • "wave_column": 0,
  • "fluxerr_column": null,
  • "flux_column": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "instrument": null,
  • "groups":
    [
    ],
  • "pis":
    [
    ],
  • "reducers":
    [
    ],
  • "observers":
    [
    ],
  • "followup_request": null,
  • "assignment": null,
  • "owner": null,
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "annotations":
    [
    ],
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "errors":
    [
    ],
  • "units": "string",
  • "obj_id": "string",
  • "observed_at": "2024-06-29T14:54:58Z",
  • "origin": "string",
  • "type": "source",
  • "label": "string",
  • "instrument_id": 0,
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "altdata": null,
  • "original_file_string": "string",
  • "original_file_filename": "string"
}

Upload spectrum from ASCII file

Upload spectrum from ASCII file

+
Request Body schema: application/json
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

@@ -1846,44 +1836,54 @@

Pagination

7985.20 0.732859 7994.40 1.236514
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

-
external_pi
string Nullable
Default: null

Free text provided as an external PI

-
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+
obj_id
required
string

The ID of the object that the spectrum is of.

+
filename
required
string

The original filename (for bookkeeping purposes).

+
instrument_id
required
integer

The ID of the instrument that took the spectrum.

+
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

+
external_observer
string Nullable
Default: null

Free text provided as an external observer

+
label
string

User defined label to be placed in plot legends, instead of the default -.

+
fluxerr_column
integer Nullable
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. + Defaults to 'fsource'.

+
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

+
external_pi
string Nullable
Default: null

Free text provided as an external PI

+
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
filename
required
string

The original filename (for bookkeeping purposes).

-

Responses

200
400
post/api/spectra/ascii
https://fritz.science/api/spectra/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "flux_column": 1,
  • "external_reducer": null,
  • "group_ids":
    [
    ],
  • "observed_by": [ ],
  • "fluxerr_column": null,
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "label": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "ascii": "string",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "external_pi": null,
  • "pi": [ ],
  • "wave_column": 0,
  • "reduced_by": [ ],
  • "filename": "string"
}

Response samples

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

Create synthetic photometry from a spectrum

Create synthetic photometry from a spectrum

+
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+

Responses

200
400
post/api/spectra/ascii
https://fritz.science/api/spectra/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observed_by": [ ],
  • "observed_at": "2024-06-29T14:54:58Z",
  • "ascii": "string",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "obj_id": "string",
  • "filename": "string",
  • "instrument_id": 0,
  • "flux_column": 1,
  • "external_observer": null,
  • "label": "string",
  • "fluxerr_column": null,
  • "type": "source",
  • "group_ids":
    [
    ],
  • "wave_column": 0,
  • "external_pi": null,
  • "external_reducer": null,
  • "reduced_by": [ ],
  • "pi": [ ]
}

Response samples

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

Create synthetic photometry from a spectrum

Create synthetic photometry from a spectrum

path Parameters
spectrum_id
required
integer
query Parameters
filters
required
list

List of filters

-

Responses

200
400
post/api/spectra/synthphot/spectrum_id
https://fritz.science/api/spectra/synthphot/spectrum_id

Response samples

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

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

+

Responses

200
400
post/api/spectra/synthphot/spectrum_id
https://fritz.science/api/spectra/synthphot/spectrum_id

Response samples

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

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

query Parameters
instrument_ids
list of integers

Instrument id numbers of spectrum. If None, retrieve for all instruments.

min_date
ISO UTC date string

Minimum UTC date of range in ISOT format. If None, open ended range.

max_date
ISO UTC date string

Maximum UTC date of range in ISOT format. If None, open ended range.

-

Responses

200
400
get/api/spectra/range
https://fritz.science/api/spectra/range

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
403
get/api/spectrum/spectrum_id
https://fritz.science/api/spectrum/spectrum_id

Response samples

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

Update spectrum

Update spectrum

-
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

-
external_observer
string Nullable
Default: null

Free text provided as an external observer

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+

Responses

200
400
get/api/spectra/range
https://fritz.science/api/spectra/range

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
403
get/api/spectrum/spectrum_id
https://fritz.science/api/spectrum/spectrum_id

Response samples

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

Update spectrum

Update spectrum

+
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
altdata
any

Miscellaneous alternative metadata.

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

obj_id
required
string

ID of this Spectrum's Obj.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

+
external_observer
string Nullable
Default: null

Free text provided as an external observer

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
origin
string

Origin of the spectrum.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

external_pi
string Nullable
Default: null

Free text provided as an external PI

-
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-

Responses

200
400
put/api/spectrum/spectrum_id
https://fritz.science/api/spectrum/spectrum_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "external_reducer": null,
  • "group_ids": [ ],
  • "observed_by": [ ],
  • "fluxes":
    [
    ],
  • "type": "source",
  • "external_observer": null,
  • "wavelengths":
    [
    ],
  • "obj_id": "string",
  • "instrument_id": 0,
  • "units": "string",
  • "errors":
    [
    ],
  • "label": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "external_pi": null,
  • "pi": [ ],
  • "reduced_by": [ ],
  • "origin": "string",
  • "altdata": null
}

Response samples

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

Delete a spectrum

Delete a spectrum

+
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+

Responses

200
400
put/api/spectrum/spectrum_id
https://fritz.science/api/spectrum/spectrum_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observed_by": [ ],
  • "observed_at": "2024-06-29T14:54:58Z",
  • "followup_request_id": 0,
  • "altdata": null,
  • "assignment_id": 0,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "external_observer": null,
  • "label": "string",
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "origin": "string",
  • "units": "string",
  • "type": "source",
  • "errors":
    [
    ],
  • "group_ids": [ ],
  • "external_pi": null,
  • "external_reducer": null,
  • "reduced_by": [ ],
  • "pi": [ ]
}

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
https://fritz.science/api/spectrum/spectrum_id

Response samples

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

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

query Parameters
minimalPayload
boolean

If true, return only the minimal metadata about each spectrum, instead of returning @@ -1923,30 +1923,29 @@

Pagination

commentsFilterAfter
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, only return sources that have comments after this time.

get/api/spectrum
https://fritz.science/api/spectrum

Upload spectrum

Upload spectrum

-
Request Body schema: application/json
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

-
external_observer
string Nullable
Default: null

Free text provided as an external observer

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
Request Body schema: application/json
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
altdata
any

Miscellaneous alternative metadata.

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

obj_id
required
string

ID of this Spectrum's Obj.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

+
external_observer
string Nullable
Default: null

Free text provided as an external observer

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
origin
string

Origin of the spectrum.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

external_pi
string Nullable
Default: null

Free text provided as an external PI

-
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-

Responses

200
400
post/api/spectrum
https://fritz.science/api/spectrum

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "external_reducer": null,
  • "group_ids": [ ],
  • "observed_by": [ ],
  • "fluxes":
    [
    ],
  • "type": "source",
  • "external_observer": null,
  • "wavelengths":
    [
    ],
  • "obj_id": "string",
  • "instrument_id": 0,
  • "units": "string",
  • "errors":
    [
    ],
  • "label": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "external_pi": null,
  • "pi": [ ],
  • "reduced_by": [ ],
  • "origin": "string",
  • "altdata": null
}

Response samples

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

Parse spectrum from ASCII file

Parse spectrum from ASCII file

-
Request Body schema: application/json
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

-
ascii
required
string

The content of the ASCII file to be parsed.

+
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+

Responses

200
400
post/api/spectrum
https://fritz.science/api/spectrum

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observed_by": [ ],
  • "observed_at": "2024-06-29T14:54:58Z",
  • "followup_request_id": 0,
  • "altdata": null,
  • "assignment_id": 0,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "external_observer": null,
  • "label": "string",
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "origin": "string",
  • "units": "string",
  • "type": "source",
  • "errors":
    [
    ],
  • "group_ids": [ ],
  • "external_pi": null,
  • "external_reducer": null,
  • "reduced_by": [ ],
  • "pi": [ ]
}

Response samples

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

Parse spectrum from ASCII file

Parse spectrum from ASCII file

+
Request Body schema: application/json
ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

The lines that make up the ASCII header must appear at the beginning of the file and all be formatted the same way within a single file. They can be formatted in one of two ways.

1) # KEY: VALUE
@@ -2020,20 +2019,11 @@ 
Pagination

 7966.80 1.029127
 7976.00 1.019637
 7985.20 0.732859
-7994.40 1.236514
fluxerr_column
integer Nullable
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

-
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

-

Responses

200
400
post/api/spectrum/parse/ascii
https://fritz.science/api/spectrum/parse/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "wave_column": 0,
  • "ascii": "string",
  • "fluxerr_column": null,
  • "flux_column": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "instrument": null,
  • "groups":
    [
    ],
  • "pis":
    [
    ],
  • "reducers":
    [
    ],
  • "observers":
    [
    ],
  • "followup_request": null,
  • "assignment": null,
  • "owner": null,
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "annotations":
    [
    ],
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "errors":
    [
    ],
  • "units": "string",
  • "obj_id": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "origin": "string",
  • "type": "source",
  • "label": "string",
  • "instrument_id": 0,
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "altdata": null,
  • "original_file_string": "string",
  • "original_file_filename": "string"
}

Upload spectrum from ASCII file

Upload spectrum from ASCII file

-
Request Body schema: application/json
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

-
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

-
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+7994.40 1.236514
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

fluxerr_column
integer Nullable
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

-
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. - Defaults to 'fsource'.

-
external_observer
string Nullable
Default: null

Free text provided as an external observer

-
obj_id
required
string

The ID of the object that the spectrum is of.

-
instrument_id
required
integer

The ID of the instrument that took the spectrum.

-
label
string

User defined label to be placed in plot legends, instead of the default -.

+
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

+

Responses

200
400
post/api/spectrum/parse/ascii
https://fritz.science/api/spectrum/parse/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ascii": "string",
  • "wave_column": 0,
  • "fluxerr_column": null,
  • "flux_column": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "instrument": null,
  • "groups":
    [
    ],
  • "pis":
    [
    ],
  • "reducers":
    [
    ],
  • "observers":
    [
    ],
  • "followup_request": null,
  • "assignment": null,
  • "owner": null,
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "annotations":
    [
    ],
  • "wavelengths":
    [
    ],
  • "fluxes":
    [
    ],
  • "errors":
    [
    ],
  • "units": "string",
  • "obj_id": "string",
  • "observed_at": "2024-06-29T14:54:58Z",
  • "origin": "string",
  • "type": "source",
  • "label": "string",
  • "instrument_id": 0,
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "altdata": null,
  • "original_file_string": "string",
  • "original_file_filename": "string"
}

Upload spectrum from ASCII file

Upload spectrum from ASCII file

+
Request Body schema: application/json
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

@@ -2111,19 +2101,29 @@

Pagination

7985.20 0.732859 7994.40 1.236514
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

-
external_pi
string Nullable
Default: null

Free text provided as an external PI

-
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+
obj_id
required
string

The ID of the object that the spectrum is of.

+
filename
required
string

The original filename (for bookkeeping purposes).

+
instrument_id
required
integer

The ID of the instrument that took the spectrum.

+
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

+
external_observer
string Nullable
Default: null

Free text provided as an external observer

+
label
string

User defined label to be placed in plot legends, instead of the default -.

+
fluxerr_column
integer Nullable
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. + Defaults to 'fsource'.

+
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

+
external_pi
string Nullable
Default: null

Free text provided as an external PI

+
external_reducer
string Nullable
Default: null

Free text provided as an external reducer

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
filename
required
string

The original filename (for bookkeeping purposes).

-

Responses

200
400
post/api/spectrum/ascii
https://fritz.science/api/spectrum/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "flux_column": 1,
  • "external_reducer": null,
  • "group_ids":
    [
    ],
  • "observed_by": [ ],
  • "fluxerr_column": null,
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "instrument_id": 0,
  • "label": "string",
  • "observed_at": "2024-06-29T14:41:22Z",
  • "ascii": "string",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "external_pi": null,
  • "pi": [ ],
  • "wave_column": 0,
  • "reduced_by": [ ],
  • "filename": "string"
}

Response samples

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

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

+
pi
Array of integers
Default: []

IDs of the Users who are PI of this Spectrum, or to use as points of contact given an external PI.

+

Responses

200
400
post/api/spectrum/ascii
https://fritz.science/api/spectrum/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observed_by": [ ],
  • "observed_at": "2024-06-29T14:54:58Z",
  • "ascii": "string",
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "obj_id": "string",
  • "filename": "string",
  • "instrument_id": 0,
  • "flux_column": 1,
  • "external_observer": null,
  • "label": "string",
  • "fluxerr_column": null,
  • "type": "source",
  • "group_ids":
    [
    ],
  • "wave_column": 0,
  • "external_pi": null,
  • "external_reducer": null,
  • "reduced_by": [ ],
  • "pi": [ ]
}

Response samples

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

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

query Parameters
instrument_ids
list of integers

Instrument id numbers of spectrum. If None, retrieve for all instruments.

min_date
ISO UTC date string

Minimum UTC date of range in ISOT format. If None, open ended range.

max_date
ISO UTC date string

Maximum UTC date of range in ISOT format. If None, open ended range.

-

Responses

200
400
get/api/spectrum/range
https://fritz.science/api/spectrum/range

Response samples

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

Submit a (classification) spectrum to TNS

Submit a (classification) spectrum to TNS

+

Responses

200
400
get/api/spectrum/range
https://fritz.science/api/spectrum/range

Response samples

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

Submit a (classification) spectrum to TNS

Submit a (classification) spectrum to TNS

path Parameters
spectrum_id
required
integer
query Parameters
tnsrobotID
required
int

SkyPortal TNS Robot ID

classificationID
string

Classification ID (see TNS documentation at https://www.wis-tns.org/content/tns-getting-started @@ -2133,39 +2133,39 @@

Pagination

['object', 'host', 'sky', 'arcs', 'synthetic']

spectrumComment
string

Comment on the spectrum.

classificationComment
string

Comment on the classification.

-

Responses

200
400
post/api/spectrum/tns/spectrum_id
https://fritz.science/api/spectrum/tns/spectrum_id

Response samples

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

shifts

Retrieve a comment

Retrieve a comment

+

Responses

200
400
post/api/spectrum/tns/spectrum_id
https://fritz.science/api/spectrum/tns/spectrum_id

Response samples

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

shifts

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve a comment

Retrieve a comment

+

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

path Parameters
shift_id
required
integer
query Parameters
startDate
string

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

Responses

200
get/api/shifts/summary/shift_id
https://fritz.science/api/shifts/summary/shift_id

Response samples

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

Retrieve shifts

Retrieve shifts

-
path Parameters
shift_id
required
integer
query Parameters
group_id
integer

Responses

200
400
get/api/shifts/shift_id
https://fritz.science/api/shifts/shift_id

Response samples

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

Delete a shift

Delete a shift

+
path Parameters
shift_id
required
integer
query Parameters
group_id
integer

Responses

200
400
get/api/shifts/shift_id
https://fritz.science/api/shifts/shift_id

Response samples

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

Delete a shift

Delete a shift

path Parameters
shift_id
required
integer

Responses

200
400
delete/api/shifts/shift_id
https://fritz.science/api/shifts/shift_id

Response samples

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

Update a shift

Update a shift

path Parameters
shift_id
required
integer
Request Body schema: application/json
group
any Nullable

The Shift's Group.

users
Array of any
shift_users
Array of any
comments
Array of any
reminders
Array of any
name
string Nullable

Name of the shift.

@@ -2174,7 +2174,7 @@

Pagination

end_date
required
string <date-time>

The end time of this shift.

group_id
required
integer

ID of the Shift's Group.

required_users_number
integer Nullable

The number of users required to join this shift for it to be considered full

-

Responses

200
400
patch/api/shifts/shift_id
https://fritz.science/api/shifts/shift_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group": null,
  • "users":
    [
    ],
  • "shift_users":
    [
    ],
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2024-06-29T14:41:22Z",
  • "end_date": "2024-06-29T14:41:22Z",
  • "group_id": 0,
  • "required_users_number": 0
}

Response samples

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

Add a new shift

Add a new shift

+

Responses

200
400
patch/api/shifts/shift_id
https://fritz.science/api/shifts/shift_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group": null,
  • "users":
    [
    ],
  • "shift_users":
    [
    ],
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2024-06-29T14:54:58Z",
  • "end_date": "2024-06-29T14:54:58Z",
  • "group_id": 0,
  • "required_users_number": 0
}

Response samples

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

Add a new shift

Add a new shift

Request Body schema: application/json
group
any Nullable

The Shift's Group.

users
Array of any
shift_users
Array of any
comments
Array of any
reminders
Array of any
name
string Nullable

Name of the shift.

description
string Nullable

Longer description of the shift.

@@ -2184,7 +2184,7 @@

Pagination

required_users_number
integer Nullable

The number of users required to join this shift for it to be considered full

shift_admins
Array of integers

List of IDs of users to be shift admins. Current user will automatically be added as a shift admin.

-

Responses

200
400
post/api/shifts
https://fritz.science/api/shifts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group": null,
  • "users":
    [
    ],
  • "shift_users":
    [
    ],
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2024-06-29T14:41:22Z",
  • "end_date": "2024-06-29T14:41:22Z",
  • "group_id": 0,
  • "required_users_number": 0,
  • "shift_admins":
    [
    ]
}

Response samples

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

Add a shift user

Add a shift user

+

Responses

200
400
post/api/shifts
https://fritz.science/api/shifts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group": null,
  • "users":
    [
    ],
  • "shift_users":
    [
    ],
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2024-06-29T14:54:58Z",
  • "end_date": "2024-06-29T14:54:58Z",
  • "group_id": 0,
  • "required_users_number": 0,
  • "shift_admins":
    [
    ]
}

Response samples

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

Add a shift user

Add a shift user

path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean

Responses

200
post/api/shifts/shift_id/users/ignored_args
https://fritz.science/api/shifts/shift_id/users/ignored_args

Request samples

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

Response samples

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

Delete a shift user

Delete a shift user

path Parameters
shift_id
required
integer
user_id
required
integer

Responses

200
delete/api/shifts/shift_id/users/user_id
https://fritz.science/api/shifts/shift_id/users/user_id

Response samples

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

Update a shift user's admin status, or needs_repla

Update a shift user's admin status, or needs_replacement status

path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
boolean

Boolean indicating whether user is shift admin.

@@ -2196,54 +2196,54 @@

Pagination

that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/comments/resource_id
https://fritz.science/api/associated_resource_type/comments/resource_id

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve a comment

Retrieve a comment

+

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

gcn_events

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+
comment_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/comments/comment_id
https://fritz.science/api/associated_resource_type/resource_id/comments/comment_id

Response samples

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

gcn_events

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/comments
https://fritz.science/api/associated_resource_type/comments

Response samples

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

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

query Parameters
text
string

Filter comments by partial text match.

-

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

annotations

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/resource_id/comments
https://fritz.science/api/associated_resource_type/resource_id/comments

Response samples

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

annotations

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Update an annotation

Update an annotation

+

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Update an annotation

Update an annotation

path Parameters
associated_resource_type
required
string

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. @@ -2287,7 +2287,7 @@

Pagination

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

Response samples

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

Update an annotation

Update an annotation

+
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

Response samples

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

Update an annotation

Update an annotation

path Parameters
associated_resource_type
required
string

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. @@ -2313,11 +2313,11 @@

Pagination

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Get all GCN Event tags

Get all GCN Event tags

+

Responses

200
400
get/api/associated_resource_type/resource_id
https://fritz.science/api/associated_resource_type/resource_id

Response samples

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

Get all GCN Event tags

Get all GCN Event tags

Responses

200
400
get/api/gcn_event/tags/dateobs
https://fritz.science/api/gcn_event/tags/dateobs

Response samples

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

Get all GCN Event properties

Get all GCN Event properties

Responses

200
400
get/api/gcn_event/properties
https://fritz.science/api/gcn_event/properties

Response samples

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

retrieve the PhotStat associated with the obj_id.

retrieve the PhotStat associated with the obj_id.

path Parameters
obj_id
required
string

object ID to get statistics on

-

Responses

200
400
get/api/sources/obj_id/phot_stat
https://fritz.science/api/sources/obj_id/phot_stat

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "last_update": "2024-06-29T14:41:22Z",
  • "last_full_update": "2024-06-29T14:41:22Z",
  • "obj_id": "string",
  • "num_obs_global": 0,
  • "num_obs_per_filter": null,
  • "num_det_global": 0,
  • "num_det_no_forced_phot_global": 0,
  • "num_det_per_filter": null,
  • "first_detected_mjd": 0,
  • "first_detected_mag": 0,
  • "first_detected_filter": "string",
  • "last_detected_mjd": 0,
  • "last_detected_mag": 0,
  • "last_detected_filter": "string",
  • "first_detected_no_forced_phot_mjd": 0,
  • "first_detected_no_forced_phot_mag": 0,
  • "first_detected_no_forced_phot_filter": "string",
  • "last_detected_no_forced_phot_mjd": 0,
  • "last_detected_no_forced_phot_mag": 0,
  • "last_detected_no_forced_phot_filter": "string",
  • "recent_obs_mjd": 0,
  • "predetection_mjds": null,
  • "last_non_detection_mjd": 0,
  • "time_to_non_detection": 0,
  • "mean_mag_global": 0,
  • "mean_mag_per_filter": null,
  • "mean_color": null,
  • "peak_mjd_global": 0,
  • "peak_mjd_per_filter": null,
  • "peak_mag_global": 0,
  • "peak_mag_per_filter": null,
  • "faintest_mag_global": 0,
  • "faintest_mag_per_filter": null,
  • "deepest_limit_global": 0,
  • "deepest_limit_per_filter": null,
  • "rise_rate": 0,
  • "decay_rate": 0,
  • "mag_rms_global": 0,
  • "mag_rms_per_filter": null,
  • "id": 0
}

create or update the PhotStat associated with the

create or update the PhotStat associated with the obj_id.

+

Responses

200
400
get/api/sources/obj_id/phot_stat
https://fritz.science/api/sources/obj_id/phot_stat

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "last_update": "2024-06-29T14:54:58Z",
  • "last_full_update": "2024-06-29T14:54:58Z",
  • "obj_id": "string",
  • "num_obs_global": 0,
  • "num_obs_per_filter": null,
  • "num_det_global": 0,
  • "num_det_no_forced_phot_global": 0,
  • "num_det_per_filter": null,
  • "first_detected_mjd": 0,
  • "first_detected_mag": 0,
  • "first_detected_filter": "string",
  • "last_detected_mjd": 0,
  • "last_detected_mag": 0,
  • "last_detected_filter": "string",
  • "first_detected_no_forced_phot_mjd": 0,
  • "first_detected_no_forced_phot_mag": 0,
  • "first_detected_no_forced_phot_filter": "string",
  • "last_detected_no_forced_phot_mjd": 0,
  • "last_detected_no_forced_phot_mag": 0,
  • "last_detected_no_forced_phot_filter": "string",
  • "recent_obs_mjd": 0,
  • "predetection_mjds": null,
  • "last_non_detection_mjd": 0,
  • "time_to_non_detection": 0,
  • "mean_mag_global": 0,
  • "mean_mag_per_filter": null,
  • "mean_color": null,
  • "peak_mjd_global": 0,
  • "peak_mjd_per_filter": null,
  • "peak_mag_global": 0,
  • "peak_mag_per_filter": null,
  • "faintest_mag_global": 0,
  • "faintest_mag_per_filter": null,
  • "deepest_limit_global": 0,
  • "deepest_limit_per_filter": null,
  • "rise_rate": 0,
  • "decay_rate": 0,
  • "mag_rms_global": 0,
  • "mag_rms_per_filter": null,
  • "id": 0
}

create or update the PhotStat associated with the

create or update the PhotStat associated with the obj_id.

path Parameters
obj_id
required
string

object ID to get statistics on

Responses

200
400
put/api/sources/obj_id/phot_stat
https://fritz.science/api/sources/obj_id/phot_stat

Response samples

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

create a new PhotStat to be associated with the ob

create a new PhotStat to be associated with the obj_id.

path Parameters
obj_id
required
string

object ID to get statistics on

@@ -2381,27 +2381,27 @@

Pagination

Responses

200
400
get/api/localization/properties
https://fritz.science/api/localization/properties

Response samples

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

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
https://fritz.science/api/photometry/photometry_id

Response samples

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

Delete photometry

Delete photometry

+

Responses

200
400
get/api/photometry/photometry_id
https://fritz.science/api/photometry/photometry_id

Response samples

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

Delete photometry

Delete photometry

path Parameters
photometry_id
required
integer

Responses

200
400
delete/api/photometry/photometry_id
https://fritz.science/api/photometry/photometry_id

Response samples

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

Update photometry

Update photometry

-
path Parameters
photometry_id
required
integer
Request Body schema: application/json
One of
  • PhotometryMag
  • PhotometryFlux
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.

-
mag
number Nullable
Default: null

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

-
magref
any Nullable
Default: null

Magnitude of the reference 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 allowed if no reference is given.

+
path Parameters
photometry_id
required
integer
Request Body schema: application/json
One of
  • PhotometryMag
  • PhotometryFlux
mag
number Nullable
Default: null

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

+
filter
required
any
Enum: "bessellux" "bessellb" "bessellv" "bessellr" "besselli" "standard::u" "standard::b" "standard::v" "standard::r" "standard::i" "desu" "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" "f062" "f087" "f106" "f129" "f158" "f184" "f213" "f146" "ztfg" "ztfr" "ztfi" "uvot::b" "uvot::u" "uvot::uvm2" "uvot::uvw1" "uvot::uvw2" "uvot::v" "uvot::white" "ps1::open" "ps1::g" "ps1::r" "ps1::i" "ps1::z" "ps1::y" "ps1::w" "atlasc" "atlaso" "2massj" "2massh" "2massks" "gaia::gbp" "gaia::g" "gaia::grp" "gaia::grvs" "tess" "gotob" "gotog" "gotol" "gotor"

The bandpass of the observation.

ra
number Nullable
Default: null

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

+
dec_unc
number Nullable
Default: null

Uncertainty on dec [arcsec].

+
instrument_id
required
integer

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

+
mjd
required
number

MJD of the observation.

+
dec
number Nullable
Default: null

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

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

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

e_magref
any Nullable
Default: null

Gaussian error on the reference magnitude. 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.

-
limiting_mag
required
number

Limiting magnitude of the image in the magnitude system magsys.

-
filter
required
any
Enum: "bessellux" "bessellb" "bessellv" "bessellr" "besselli" "standard::u" "standard::b" "standard::v" "standard::r" "standard::i" "desu" "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" "f062" "f087" "f106" "f129" "f158" "f184" "f213" "f146" "ztfg" "ztfr" "ztfi" "uvot::b" "uvot::u" "uvot::uvm2" "uvot::uvw1" "uvot::uvw2" "uvot::v" "uvot::white" "ps1::open" "ps1::g" "ps1::r" "ps1::i" "ps1::z" "ps1::y" "ps1::w" "atlasc" "atlaso" "2massj" "2massh" "2massks" "gaia::gbp" "gaia::g" "gaia::grp" "gaia::grvs" "tess" "gotob" "gotog" "gotol" "gotor"

The bandpass of the observation.

alert_id
integer 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.

-
dec
number Nullable
Default: null

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

-
mjd
required
number

MJD of the observation.

-
origin
any Nullable
Default: null

Provenance of the Photometry. If a record is already present with identical origin, only the groups or streams list will be updated (other data assumed identical). Defaults to None.

-
assignment_id
integer Nullable
Default: null

ID of the classical assignment which generated the photometry

+
magref
any Nullable
Default: null

Magnitude of the reference 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 allowed if no reference is given.

ra_unc
number Nullable
Default: null

Uncertainty on RA [arcsec].

+
limiting_mag
required
number

Limiting magnitude of the image in the magnitude system magsys.

+
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.

altdata
object Nullable
Default: null

Misc. alternative metadata stored in JSON format, e.g. {'calibration': {'source': 'ps1','color_term': 0.012}, 'photometry_method': 'allstar', 'method_reference': 'Masci et al. (2015)'}

-
dec_unc
number Nullable
Default: null

Uncertainty on dec [arcsec].

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

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

-
obj_id
required
string

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

-
instrument_id
required
integer

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

-

Responses

200
400
patch/api/photometry/photometry_id
https://fritz.science/api/photometry/photometry_id

Request samples

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

Response samples

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

Update and/or upload photometry, resolving potenti

Update and/or upload photometry, resolving potential duplicates

+
origin
any Nullable
Default: null

Provenance of the Photometry. If a record is already present with identical origin, only the groups or streams list will be updated (other data assumed identical). Defaults to None.

+
assignment_id
integer Nullable
Default: null

ID of the classical assignment which generated the photometry

+
obj_id
required
string

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

+

Responses

200
400
patch/api/photometry/photometry_id
https://fritz.science/api/photometry/photometry_id

Request samples

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

Response samples

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

Update and/or upload photometry, resolving potenti

Update and/or upload photometry, resolving potential duplicates

path Parameters
refresh
required
boolean

If true, triggers a refresh of the object's photometry on the web page, only for the users that have the object's source page open.

duplicate_ignore_flux
required
boolean

If true, will not use the flux/fluxerr of existing rows when looking for duplicates @@ -2411,33 +2411,33 @@

Pagination

existing rows (duplicates) with the new values. Applies only to rows with an origin already specified. If existing duplicates have no origin, the update will be skipped.

-
Request Body schema: application/json
One of
  • PhotMagFlexible
  • PhotFluxFlexible
stream_ids
any
Default: []

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

-
group_ids
any
Default: []

List of group IDs to which photometry points will be visible. If 'all', will be shared with site-wide public group (visible to all users who can view associated source).

+
Request Body schema: application/json
One of
  • PhotMagFlexible
  • PhotFluxFlexible
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.

magerr
any Nullable
Default: null

Error on the magnitude 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.

-
magref
any Nullable
Default: null

Magnitude of the reference 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 allowed if no reference is given.

-
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.

limiting_mag_nsigma
any
Default: 3

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

-
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.

-
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.

-
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.

-
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

+
altdata
any Nullable
Default: null

Misc. alternative metadata stored in JSON format, e.g. {'calibration': {'source': 'ps1','color_term': 0.012}, 'photometry_method': 'allstar', 'method_reference': 'Masci et al. (2015)'}. Can be a list of dicts or a single dict which will be broadcast to all values.

+
assignment_id
integer Nullable
Default: null

ID of the classical assignment which generated the photometry

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.

+
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.

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.

+
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.

+
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

+
magref
any Nullable
Default: null

Magnitude of the reference 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 allowed if no reference is given.

+
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.

+
origin
any Nullable
Default: null

Provenance of the Photometry. If a record is already present with identical origin, only the groups or streams list will be updated (other data assumed identical). Defaults to None.

+
stream_ids
any
Default: []

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

e_magref
any Nullable
Default: null

Gaussian error on the reference magnitude. 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.

-
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.

+
group_ids
any
Default: []

List of group IDs to which photometry points will be visible. If 'all', will be shared with site-wide public group (visible to all users who can view associated source).

+
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.

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, desu, 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, f062, f087, f106, f129, f158, f184, f213, f146, ztfg, ztfr, ztfi, uvot::b, uvot::u, uvot::uvm2, uvot::uvw1, uvot::uvw2, uvot::v, uvot::white, ps1::open, ps1::g, ps1::r, ps1::i, ps1::z, ps1::y, ps1::w, atlasc, atlaso, 2massj, 2massh, 2massks, gaia::gbp, gaia::g, gaia::grp, gaia::grvs, tess, gotob, gotog, gotol, gotor

-
assignment_id
integer Nullable
Default: null

ID of the classical assignment which generated the photometry

-
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.

-
origin
any Nullable
Default: null

Provenance of the Photometry. If a record is already present with identical origin, only the groups or streams list will be updated (other data assumed identical). Defaults to None.

-
altdata
any Nullable
Default: null

Misc. alternative metadata stored in JSON format, e.g. {'calibration': {'source': 'ps1','color_term': 0.012}, 'photometry_method': 'allstar', 'method_reference': 'Masci et al. (2015)'}. Can be a list of dicts or a single dict which will be broadcast to all values.

-
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.

-

Responses

200
put/api/photometry
https://fritz.science/api/photometry

Request samples

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

Response samples

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

Retrieve a photometric series

Retrieve a photometric series

+
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.

+
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.

+

Responses

200
put/api/photometry
https://fritz.science/api/photometry

Request samples

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

Response samples

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

Retrieve a photometric series

Retrieve a photometric series

path Parameters
photometric_series_id
required
integer
query Parameters
dataFormat
string
Enum: "json" "hdf5" "none"

Format of the data to return. If none, the data will not be returned. If hdf5, the data will be returned as a bytestream in HDF5 format. (to see how to unpack this data format, look at photometric_series.md) If json, the data will be returned as a JSON object, where each key is a list of values for that column.

-

Responses

200
get/api/photometric_series/photometric_series_id
https://fritz.science/api/photometric_series/photometric_series_id

Response samples

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

Delete a photometric series

Delete a photometric series

+

Responses

200
get/api/photometric_series/photometric_series_id
https://fritz.science/api/photometric_series/photometric_series_id

Response samples

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

Delete a photometric series

Delete a photometric series

path Parameters
photometric_series_id
required
integer

Responses

200
400
delete/api/photometric_series/photometric_series_id
https://fritz.science/api/photometric_series/photometric_series_id

Response samples

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

Retrieve all photometric series, based on various

Retrieve all photometric series, based on various cuts.

query Parameters
dataFormat
string
Enum: "json" "hdf5" "none"

Format of the data to return. If none, the data will not be returned. If hdf5, the data will be returned as a bytestream in HDF5 format. @@ -2561,10 +2561,10 @@

Pagination

path Parameters
upload_id
required
string

Responses

200
400
delete/api/photometry/bulk_delete/upload_id
https://fritz.science/api/photometry/bulk_delete/upload_id

Response samples

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

Get photometry taken by specific instruments over

Get photometry taken by specific instruments over a date range

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)

-
Request Body schema: application/json
instrument_ids
Array of integers Nullable
Default: null

IDs of the instruments to query for photometry from. If None, queries all instruments.

-
max_date
string <date-time> Nullable
Default: null

Query for photometry taken before this UT DateTime. For an open-ended interval use None.

-
min_date
string <date-time> Nullable
Default: null

Query for photometry taken after this UT DateTime. For an open-ended interval use None.

-

Responses

200
400
get/api/photometry/range
https://fritz.science/api/photometry/range

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "instrument_ids": null,
  • "max_date": null,
  • "min_date": null
}

Response samples

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

Get all photometry origins

Get all photometry origins

+
Request Body schema: application/json
min_date
string <date-time> Nullable
Default: null

Query for photometry taken after this UT DateTime. For an open-ended interval use None.

+
instrument_ids
Array of integers Nullable
Default: null

IDs of the instruments to query for photometry from. If None, queries all instruments.

+
max_date
string <date-time> Nullable
Default: null

Query for photometry taken before this UT DateTime. For an open-ended interval use None.

+

Responses

200
400
get/api/photometry/range
https://fritz.science/api/photometry/range

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "min_date": null,
  • "instrument_ids": null,
  • "max_date": null
}

Response samples

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

Get all photometry origins

Get all photometry origins

Responses

200
400
get/api/photometry/origins
https://fritz.science/api/photometry/origins

Response samples

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

Copy all photometry points from one source to anot

Copy all photometry points from one source to another

path Parameters
target_id
required
string

The obj_id of the target Source (to which the photometry is being copied to)

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

List of IDs of groups to give photometry access to

@@ -2579,23 +2579,23 @@

Pagination

includeOwnerInfo
boolean

Boolean indicating whether to include photometry owner. Defaults to false.

includeStreamInfo
boolean

Boolean indicating whether to include photometry stream information. Defaults to false.

includeValidationInfo
boolean

Boolean indicating whether to include photometry validation information. Defaults to false.

-

Responses

200
400
get/api/sources/obj_id/photometry
https://fritz.science/api/sources/obj_id/photometry

Response samples

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

Delete object photometry

Delete object photometry

+

Responses

200
400
get/api/sources/obj_id/photometry
https://fritz.science/api/sources/obj_id/photometry

Response samples

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

Delete object photometry

Delete object photometry

path Parameters
obj_id
required
string

Responses

200
400
delete/api/sources/obj_id/photometry
https://fritz.science/api/sources/obj_id/photometry

Response samples

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

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Retrieve an annotation

Retrieve an annotation

+

Responses

200
400
get/api/associated_resource_type/resource_id/annotations
https://fritz.science/api/associated_resource_type/resource_id/annotations

Response samples

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

Retrieve an annotation

Retrieve an annotation

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra" "photometry"

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

Response samples

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

gcnevents

Get observation plan requests of the GcnEvent.

Get observation plan requests of the GcnEvent.

-
path Parameters
gcnevent_id
required
string

Responses

200
get/api/gcn_event/gcnevent_id/observation_plan_requests
https://fritz.science/api/gcn_event/gcnevent_id/observation_plan_requests

Response samples

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

Get survey efficiency analyses of the GcnEvent.

Get survey efficiency analyses of the GcnEvent.

-
path Parameters
gcnevent_id
required
string

Responses

200
get/api/gcn_event/gcnevent_id/survey_efficiency
https://fritz.science/api/gcn_event/gcnevent_id/survey_efficiency

Response samples

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

Get catalog queries of the GcnEvent.

Get catalog queries of the GcnEvent.

-
path Parameters
gcnevent_id
required
string

Responses

200
get/api/gcn_event/gcnevent_id/catalog_query
https://fritz.science/api/gcn_event/gcnevent_id/catalog_query

Response samples

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

Post a GCN Event alias

Post a GCN Event alias

+
annotation_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/annotations/annotation_id
https://fritz.science/api/associated_resource_type/resource_id/annotations/annotation_id

Response samples

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

gcnevents

Get observation plan requests of the GcnEvent.

Get observation plan requests of the GcnEvent.

+
path Parameters
gcnevent_id
required
string

Responses

200
get/api/gcn_event/gcnevent_id/observation_plan_requests
https://fritz.science/api/gcn_event/gcnevent_id/observation_plan_requests

Response samples

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

Get survey efficiency analyses of the GcnEvent.

Get survey efficiency analyses of the GcnEvent.

+
path Parameters
gcnevent_id
required
string

Responses

200
get/api/gcn_event/gcnevent_id/survey_efficiency
https://fritz.science/api/gcn_event/gcnevent_id/survey_efficiency

Response samples

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

Get catalog queries of the GcnEvent.

Get catalog queries of the GcnEvent.

+
path Parameters
gcnevent_id
required
string

Responses

200
get/api/gcn_event/gcnevent_id/catalog_query
https://fritz.science/api/gcn_event/gcnevent_id/catalog_query

Response samples

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

Post a GCN Event alias

Post a GCN Event alias

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

Request Body schema: application/json
alias
required
string

Alias to add to the event

Responses

200
400
post/api/gcn_event/dateobs/alias
https://fritz.science/api/gcn_event/dateobs/alias

Request samples

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

Response samples

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

Delete a GCN event alias

Delete a GCN event alias

@@ -2613,7 +2613,7 @@

Pagination

that the reminder is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event

-
reminder_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Response samples

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

Post a reminder

Post a reminder

+
reminder_id
required
integer

Responses

200
400
get/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Response samples

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

Post a reminder

Post a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string

The ID of the source or spectrum @@ -2649,19 +2649,19 @@

Pagination

user_id
required
integer

ID of the Reminder User instance.

group_ids
Array of integers

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

-

Responses

200
400
patch/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "user": null,
  • "groups":
    [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "origin": "string",
  • "bot": true,
  • "next_reminder": "2024-06-29T14:41:22Z",
  • "reminder_delay": 0,
  • "number_of_reminders": 0,
  • "user_id": 0,
  • "group_ids":
    [
    ]
}

Response samples

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

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+

Responses

200
400
patch/api/associated_resource_type/resource_id/reminders/reminder_id
https://fritz.science/api/associated_resource_type/resource_id/reminders/reminder_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "obj": null,
  • "user": null,
  • "groups":
    [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "origin": "string",
  • "bot": true,
  • "next_reminder": "2024-06-29T14:54:59Z",
  • "reminder_delay": 0,
  • "number_of_reminders": 0,
  • "user_id": 0,
  • "group_ids":
    [
    ]
}

Response samples

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

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

gcn_event

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

gcn_event

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

Scrape data of a GCN Event from GraceDB

Scrape data of a GCN Event from GraceDB

+

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

Scrape data of a GCN Event from GraceDB

Scrape data of a GCN Event from GraceDB

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

Responses

200
400
post/api/gcn_event/dateobs/gracedb
https://fritz.science/api/gcn_event/dateobs/gracedb

Response samples

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

Scrape aliases of a GCN Event from GCNs notice/cir

Scrape aliases of a GCN Event from GCNs notice/circulars

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

@@ -2671,14 +2671,14 @@

Pagination

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

earthquakenotices

Ingest EarthquakeEvent

Ingest EarthquakeEvent

+

Responses

200
400
get/api/associated_resource_type/resource_id/reminders
https://fritz.science/api/associated_resource_type/resource_id/reminders

Response samples

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

earthquakenotices

Ingest EarthquakeEvent

Ingest EarthquakeEvent

Request Body schema: application/json
sent_by
any Nullable

The user that saved this EarthquakeEvent

notices
Array of any
predictions
Array of any
measurements
Array of any
comments
Array of any
reminders
Array of any
sent_by_id
required
integer

The ID of the User who created this GcnTag.

event_id
required
string
event_uri
string Nullable
status
string

The status of the earthquake event.

Responses

200
400
post/api/earthquake
https://fritz.science/api/earthquake

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sent_by": null,
  • "notices":
    [
    ],
  • "predictions":
    [
    ],
  • "measurements":
    [
    ],
  • "comments":
    [
    ],
  • "reminders":
    [
    ],
  • "sent_by_id": 0,
  • "event_id": "string",
  • "event_uri": "string",
  • "status": "string"
}

Response samples

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

gcn

Retrieve a GCN report

Retrieve a GCN report

-
path Parameters
dateobs
required
string
summary_id
required
integer

Responses

200
400
get/api/gcn_event/dateobs/report/report_id
https://fritz.science/api/gcn_event/dateobs/report/report_id

Response samples

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

Delete a GCN report

Delete a GCN report

+
path Parameters
dateobs
required
string
summary_id
required
integer

Responses

200
400
get/api/gcn_event/dateobs/report/report_id
https://fritz.science/api/gcn_event/dateobs/report/report_id

Response samples

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

Delete a GCN report

Delete a GCN report

path Parameters
report_id
required
integer

Responses

200
400
delete/api/gcn_event/dateobs/report/report_id
https://fritz.science/api/gcn_event/dateobs/report/report_id

Response samples

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

Retrieve a GCN summary

Retrieve a GCN summary

-
path Parameters
dateobs
required
string
summary_id
required
integer

Responses

200
400
get/api/gcn_event/dateobs/summary/summary_id
https://fritz.science/api/gcn_event/dateobs/summary/summary_id

Response samples

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

Delete a GCN summary

Delete a GCN summary

+
path Parameters
dateobs
required
string
summary_id
required
integer

Responses

200
400
get/api/gcn_event/dateobs/summary/summary_id
https://fritz.science/api/gcn_event/dateobs/summary/summary_id

Response samples

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

Delete a GCN summary

Delete a GCN summary

path Parameters
summary_id
required
integer

Responses

200
400
delete/api/gcn_event/dateobs/summary/summary_id
https://fritz.science/api/gcn_event/dateobs/summary/summary_id

Response samples

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

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

path Parameters
shift_id
required
integer
query Parameters
startDate
string

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

@@ -2700,23 +2700,23 @@

Pagination

query Parameters
maximumAirmass
number

Maximum airmass to consider. Defaults to 2.5.

twilight
string

Twilight definition. Choices are astronomical (-18 degrees), nautical (-12 degrees), and civil (-6 degrees).

Responses

200
get/api/localization/localization_id/worldmap
https://fritz.science/api/localization/localization_id/worldmap

Response samples

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

Download a GCN localization skymap

Download a GCN localization skymap

-
path Parameters
dateobs
required
string
localization_name
required
string

Responses

200
400
get/api/localization/dateobs/name/localization_name/download
https://fritz.science/api/localization/dateobs/name/localization_name/download

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "localization_name": "string",
  • "flat_2d":
    [
    ],
  • "contour": null,
  • "dateobs": "string"
}

Retrieve a GCN localization

Retrieve a GCN localization

+
path Parameters
dateobs
required
string
localization_name
required
string

Responses

200
400
get/api/localization/dateobs/name/localization_name/download
https://fritz.science/api/localization/dateobs/name/localization_name/download

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dateobs": "string",
  • "contour": null,
  • "flat_2d":
    [
    ],
  • "localization_name": "string"
}

Retrieve a GCN localization

Retrieve a GCN localization

path Parameters
dateobs
required
dateobs
localization_name
required
localization_name
query Parameters
include2DMap
boolean

Boolean indicating whether to include flatted skymap. Defaults to false.

-

Responses

200
400
get/api/localization/dateobs/name/localization_name
https://fritz.science/api/localization/dateobs/name/localization_name

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "localization_name": "string",
  • "flat_2d":
    [
    ],
  • "contour": null,
  • "dateobs": "string"
}

Delete a GCN localization

Delete a GCN localization

+

Responses

200
400
get/api/localization/dateobs/name/localization_name
https://fritz.science/api/localization/dateobs/name/localization_name

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dateobs": "string",
  • "contour": null,
  • "flat_2d":
    [
    ],
  • "localization_name": "string"
}

Delete a GCN localization

Delete a GCN localization

path Parameters
dateobs
required
string
localization_name
required
string

Responses

200
400
delete/api/localization/dateobs/name/localization_name
https://fritz.science/api/localization/dateobs/name/localization_name

Response samples

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

A fits file corresponding to the intersection of t

A fits file corresponding to the intersection of the input fits files.

-
path Parameters
dateobs
required
dateobs
localization_name
required
localization_name

Responses

200
400
get/api/localizationcrossmatch
https://fritz.science/api/localizationcrossmatch

Response samples

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

Post a skymap-based trigger

Post a skymap-based trigger

-
Request Body schema: application/json
localization_id
required
integer

Localization ID.

-
allocation_id
required
integer

Followup request allocation ID.

-
integrated_probability
number

Integrated probability within skymap.

-

Responses

200
400
post/api/skymap_trigger
https://fritz.science/api/skymap_trigger

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "localization_id": 0,
  • "allocation_id": 0,
  • "integrated_probability": 0
}

Response samples

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

Create a summary plot for the observability for a

Create a summary plot for the observability for a given source.

+
path Parameters
dateobs
required
dateobs
localization_name
required
localization_name

Responses

200
400
get/api/localizationcrossmatch
https://fritz.science/api/localizationcrossmatch

Response samples

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

Post a skymap-based trigger

Post a skymap-based trigger

+
Request Body schema: application/json
integrated_probability
number

Integrated probability within skymap.

+
localization_id
required
integer

Localization ID.

+
allocation_id
required
integer

Followup request allocation ID.

+

Responses

200
400
post/api/skymap_trigger
https://fritz.science/api/skymap_trigger

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "integrated_probability": 0,
  • "localization_id": 0,
  • "allocation_id": 0
}

Response samples

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

Create a summary plot for the observability for a

Create a summary plot for the observability for a given source.

path Parameters
obj_id
required
string

ID of object to generate observability plot for

query Parameters
maximumAirmass
number

Maximum airmass to consider. Defaults to 2.5.

twilight
string

Twilight definition. Choices are astronomical (-18 degrees), nautical (-12 degrees), and civil (-6 degrees).

Responses

200
get/api/sources/obj_id/observability
https://fritz.science/api/sources/obj_id/observability

Response samples

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

gcntags

Post a GCN Event tag

Post a GCN Event tag

-
Request Body schema: application/json
text
any

GCN Event tag

-
dateobs
any

UTC event timestamp

-

Responses

200
400
post/api/gcn_event/tags/dateobs
https://fritz.science/api/gcn_event/tags/dateobs

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "text": null,
  • "dateobs": null
}

Response samples

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

Ingest GCN xml file

Ingest GCN xml file

+
Request Body schema: application/json
dateobs
any

UTC event timestamp

+
text
any

GCN Event tag

+

Responses

200
400
post/api/gcn_event/tags/dateobs
https://fritz.science/api/gcn_event/tags/dateobs

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dateobs": null,
  • "text": null
}

Response samples

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

Ingest GCN xml file

Ingest GCN xml file

Request Body schema: application/json
xml
string

VOEvent XML content.

dateobs
any

UTC event timestamp

json
string

JSON notice content.

@@ -2784,26 +2784,26 @@

Pagination

numberObservations
number

Minimum number of observations of a field required to include. Defaults to 1.

Responses

200
400
post/api/observation/treasuremap/instrument_id
https://fritz.science/api/observation/treasuremap/instrument_id

Response samples

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

Submit manual observation plan.

Submit manual observation plan.

-
Request Body schema: application/json
allocation_id
required
integer

Observation plan request allocation ID.

-
observation_plan_data
any

Observation plan data json

+
Request Body schema: application/json
localization_id
required
integer

Localization ID.

target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

-
localization_id
required
integer

Localization ID.

+
allocation_id
required
integer

Observation plan request allocation ID.

status
string
Default: "pending submission"

The status of the request.

-
gcnevent_id
required
integer

ID of the GcnEvent.

-

Responses

200
post/api/observation_plan/manual
https://fritz.science/api/observation_plan/manual

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allocation_id": 0,
  • "observation_plan_data": null,
  • "target_group_ids":
    [
    ],
  • "localization_id": 0,
  • "status": "pending submission",
  • "gcnevent_id": 0
}

Response samples

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

Submit observation plan request.

Submit observation plan request.

-
Request Body schema: application/json
allocation_id
required
integer

Observation plan request allocation ID.

-
target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

+
gcnevent_id
required
integer

ID of the GcnEvent.

+
observation_plan_data
any

Observation plan data json

+

Responses

200
post/api/observation_plan/manual
https://fritz.science/api/observation_plan/manual

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "localization_id": 0,
  • "target_group_ids":
    [
    ],
  • "allocation_id": 0,
  • "status": "pending submission",
  • "gcnevent_id": 0,
  • "observation_plan_data": null
}

Response samples

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

Submit observation plan request.

Submit observation plan request.

+
Request Body schema: application/json
payload
any

Content of the observation plan request.

localization_id
required
integer

Localization ID.

-
payload
any

Content of the observation plan request.

+
target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

+
allocation_id
required
integer

Observation plan request allocation ID.

status
string
Default: "pending submission"

The status of the request.

gcnevent_id
required
integer

ID of the GcnEvent.

-

Responses

200
post/api/observation_plan
https://fritz.science/api/observation_plan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allocation_id": 0,
  • "target_group_ids":
    [
    ],
  • "localization_id": 0,
  • "payload": null,
  • "status": "pending submission",
  • "gcnevent_id": 0
}

Response samples

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

Delete observation plan.

Delete observation plan.

+

Responses

200
post/api/observation_plan
https://fritz.science/api/observation_plan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": null,
  • "localization_id": 0,
  • "target_group_ids":
    [
    ],
  • "allocation_id": 0,
  • "status": "pending submission",
  • "gcnevent_id": 0
}

Response samples

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

Delete observation plan.

Delete observation plan.

path Parameters
observation_plan_id
required
string

Responses

200
delete/api/observation_plan/observation_plan_request_id
https://fritz.science/api/observation_plan/observation_plan_request_id

Response samples

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

Submit the observation plan to treasuremap.space

Submit the observation plan to treasuremap.space

path Parameters
observation_plan_id
required
string

Responses

200
400
post/api/observation_plan/observation_plan_request_id/treasuremap
https://fritz.science/api/observation_plan/observation_plan_request_id/treasuremap

Response samples

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

Get a GCN-izable summary of the observation plan.

Get a GCN-izable summary of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/gcn
https://fritz.science/api/observation_plan/observation_plan_request_id/gcn

Response samples

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

Submit an observation plan.

Submit an observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

200
post/api/observation_plan/observation_plan_request_id/queue
https://fritz.science/api/observation_plan/observation_plan_request_id/queue

Response samples

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

Remove an observation plan from the queue.

Remove an observation plan from the queue.

+
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/gcn
https://fritz.science/api/observation_plan/observation_plan_request_id/gcn

Response samples

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

Submit an observation plan.

Submit an observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

200
post/api/observation_plan/observation_plan_request_id/queue
https://fritz.science/api/observation_plan/observation_plan_request_id/queue

Response samples

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

Remove an observation plan from the queue.

Remove an observation plan from the queue.

path Parameters
observation_plan_id
required
string

Responses

200
delete/api/observation_plan/observation_plan_request_id/queue
https://fritz.science/api/observation_plan/observation_plan_request_id/queue

Response samples

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

Get a movie summary of the observation plan.

Get a movie summary of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/movie
https://fritz.science/api/observation_plan/observation_plan_request_id/movie

Response samples

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

Perform an efficiency analysis of the observation

Perform an efficiency analysis of the observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/movie
https://fritz.science/api/observation_plan/observation_plan_request_id/movie

Response samples

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

Perform an efficiency analysis of the observation

Perform an efficiency analysis of the observation plan.

path Parameters
observation_plan_id
required
string
query Parameters
numberInjections
number

Number of simulations to evaluate efficiency with. Defaults to 1000.

numberDetections
number

Number of detections required for detection. Defaults to 1.

detectionThreshold
number

Threshold (in sigmas) required for detection. Defaults to 5.

@@ -2814,13 +2814,13 @@

Pagination

able to view the analyses. Defaults to all of requesting user's groups.

Responses

200
get/api/observation_plan/observation_plan_request_id/simsurvey
https://fritz.science/api/observation_plan/observation_plan_request_id/simsurvey

Response samples

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

Get GeoJSON summary of the observation plan.

Get GeoJSON summary of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/geojson
https://fritz.science/api/observation_plan/observation_plan_request_id/geojson

Response samples

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

Get survey efficiency analyses of the observation

Get survey efficiency analyses of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/survey_efficiency
https://fritz.science/api/observation_plan/observation_plan_request_id/survey_efficiency

Response samples

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

Submit the fields in the observation plan to an ob

Submit the fields in the observation plan to an observing run

+
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/geojson
https://fritz.science/api/observation_plan/observation_plan_request_id/geojson

Response samples

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

Get survey efficiency analyses of the observation

Get survey efficiency analyses of the observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

200
get/api/observation_plan/observation_plan_request_id/survey_efficiency
https://fritz.science/api/observation_plan/observation_plan_request_id/survey_efficiency

Response samples

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

Submit the fields in the observation plan to an ob

Submit the fields in the observation plan to an observing run

path Parameters
observation_plan_id
required
integer

ID of observation plan request to create observing run for

Responses

200
400
post/api/observation_plan/observation_plan_request_id/observing_run
https://fritz.science/api/observation_plan/observation_plan_request_id/observing_run

Response samples

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

Delete selected fields from the observation plan.

Delete selected fields from the observation plan.

path Parameters
observation_plan_id
required
string
Request Body schema: application/json
fieldIds
Array of integers

List of field IDs to remove from the plan

-

Responses

200
delete/api/observation_plan/observation_plan_request_id/fields
https://fritz.science/api/observation_plan/observation_plan_request_id/fields

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fieldIds":
    [
    ]
}

Response samples

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

groups

Retrieve the public group

Retrieve the public group

-

Responses

200
get/api/groups/public
https://fritz.science/api/groups/public

Response samples

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

Add alert stream access to group

Add alert stream access to group

+

Responses

200
delete/api/observation_plan/observation_plan_request_id/fields
https://fritz.science/api/observation_plan/observation_plan_request_id/fields

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fieldIds":
    [
    ]
}

Response samples

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

groups

Retrieve the public group

Retrieve the public group

+

Responses

200
get/api/groups/public
https://fritz.science/api/groups/public

Response samples

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

Add alert stream access to group

Add alert stream access to group

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

Responses

200
post/api/groups/group_id/streams/ignored_args
https://fritz.science/api/groups/group_id/streams/ignored_args

Request samples

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

Response samples

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

Delete an alert stream from group

Delete an alert stream from group

path Parameters
group_id
required
integer
stream_id
required
integer

Responses

200
delete/api/groups/group_id/streams/stream_id
https://fritz.science/api/groups/group_id/streams/stream_id

Response samples

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

Add a group user

Add a group user

path Parameters
group_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean
canSave
boolean

Boolean indicating whether user can save sources to group. Defaults to true.

@@ -2833,7 +2833,7 @@

Pagination

path Parameters
group_id
required
integer
user_id
required
integer

Responses

200
delete/api/groups/group_id/users/user_id
https://fritz.science/api/groups/group_id/users/user_id

Response samples

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

Add users from other group(s) to specified group

Add users from other group(s) to specified group

path Parameters
group_id
required
integer
Request Body schema: application/json
fromGroupIDs
required
boolean

Responses

200
post/api/groups/group_id/usersFromGroups/ignored_args
https://fritz.science/api/groups/group_id/usersFromGroups/ignored_args

Request samples

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

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
query Parameters
includeGroupUsers
boolean

Boolean indicating whether to include group users. Defaults to true.

-

Responses

200
400
get/api/groups/group_id
https://fritz.science/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

+

Responses

200
400
get/api/groups/group_id
https://fritz.science/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
streams
Array of any
filters
Array of any
shifts
Array of any
users
Array of any
group_users
Array of any
observing_runs
Array of any
photometry
Array of any
photometric_series
Array of any
spectra
Array of any
mmadetector_spectra
Array of any
mmadetector_time_intervals
Array of any
allocations
Array of any
source_labels
Array of any
admission_requests
Array of any
tnsrobots
Array of any
gcnreports
Array of any
gcnsummaries
Array of any
name
required
string

Name of the group.

nickname
string Nullable

Short group nickname.

description
string Nullable

Longer description of the group.

@@ -2853,14 +2853,14 @@

Pagination

group_admins
Array of integers

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

Responses

200
post/api/groups
https://fritz.science/api/groups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "streams":
    [
    ],
  • "filters":
    [
    ],
  • "shifts":
    [
    ],
  • "users":
    [
    ],
  • "group_users":
    [
    ],
  • "observing_runs":
    [
    ],
  • "photometry":
    [
    ],
  • "photometric_series":
    [
    ],
  • "spectra":
    [
    ],
  • "mmadetector_spectra":
    [
    ],
  • "mmadetector_time_intervals":
    [
    ],
  • "allocations":
    [
    ],
  • "source_labels":
    [
    ],
  • "admission_requests":
    [
    ],
  • "tnsrobots":
    [
    ],
  • "gcnreports":
    [
    ],
  • "gcnsummaries":
    [
    ],
  • "name": "string",
  • "nickname": "string",
  • "description": "string",
  • "private": true,
  • "single_user_group": true,
  • "group_admins":
    [
    ]
}

Response samples

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

Retrieve a group admission request

Retrieve a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

200
400
get/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Delete a group admission request

Delete a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

200
400
get/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Delete a group admission request

Delete a group admission request

path Parameters
admission_request_id
required
integer

Responses

200
delete/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Update a group admission request's status

Update a group admission request's status

path Parameters
admission_request_id
required
integer
Request Body schema: application/json
status
required
string

One of either 'accepted', 'declined', or 'pending'.

Responses

200
patch/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Request samples

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

Response samples

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

Retrieve all group admission requests

Retrieve all group admission requests

query Parameters
groupID
integer

ID of group for which admission requests are desired

-

Responses

200
400
get/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Response samples

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

Create a new group admission request

Create a new group admission request

+

Responses

200
400
get/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Response samples

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

Create a new group admission request

Create a new group admission request

Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

200
post/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

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

Retrieve basic info on Groups that an Obj is saved

Retrieve basic info on Groups that an Obj is saved to

-
path Parameters
obj_id
required
integer

Responses

200
400
get/api/sources/obj_id/groups
https://fritz.science/api/sources/obj_id/groups

Response samples

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

Save or request group(s) to save source, and optio

Save or request group(s) to save source, and optionally unsave from group(s).

+
path Parameters
obj_id
required
integer

Responses

200
400
get/api/sources/obj_id/groups
https://fritz.science/api/sources/obj_id/groups

Response samples

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

Save or request group(s) to save source, and optio

Save or request group(s) to save source, and optionally unsave from group(s).

Request Body schema: application/json
objId
required
string

ID of the object in question.

inviteGroupIds
required
Array of integers

List of group IDs to save or invite to save specified source.

unsaveGroupIds
Array of integers

List of group IDs from which specified source is to be unsaved.

@@ -2870,10 +2870,10 @@

Pagination

path Parameters
group_id
required
integer
stream_id
required
integer

Responses

200
delete/api/groups/group_id/streams/stream_id
https://fritz.science/api/groups/group_id/streams/stream_id

Response samples

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

Grant stream access to a user

Grant stream access to a user

path Parameters
stream_id
required
integer
Request Body schema: application/json
user_id
required
integer

Responses

200
post/api/streams/stream_id/users/ignored_args
https://fritz.science/api/streams/stream_id/users/ignored_args

Request samples

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

Response samples

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

Delete a stream user (revoke stream access for use

Delete a stream user (revoke stream access for user)

path Parameters
stream_id
required
integer
user_id
required
integer

Responses

200
delete/api/streams/stream_id/users/user_id
https://fritz.science/api/streams/stream_id/users/user_id

Response samples

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

Retrieve a stream

Retrieve a stream

-
path Parameters
filter_id
required
integer

Responses

200
400
get/api/streams/stream_id
https://fritz.science/api/streams/stream_id

Response samples

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

Delete a stream

Delete a stream

+
path Parameters
filter_id
required
integer

Responses

200
400
get/api/streams/stream_id
https://fritz.science/api/streams/stream_id

Response samples

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

Delete a stream

Delete a stream

path Parameters
stream_id
required
integer

Responses

200
delete/api/streams/stream_id
https://fritz.science/api/streams/stream_id

Response samples

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

Update a stream

Update a stream

path Parameters
stream_id
required
integer
Request Body schema: application/json
name
string
altdata
object

Responses

200
400
patch/api/streams/stream_id
https://fritz.science/api/streams/stream_id

Request samples

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

Response samples

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

Retrieve all streams

Retrieve all streams

-

Responses

200
400
get/api/streams
https://fritz.science/api/streams

Response samples

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

POST a new stream.

POST a new stream.

+

Responses

200
400
get/api/streams
https://fritz.science/api/streams

Response samples

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

POST a new stream.

POST a new stream.

Request Body schema: application/json
name
required
string
altdata
object

Responses

200
post/api/streams
https://fritz.science/api/streams

Request samples

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

Response samples

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

users

Add a group user

Add a group user

path Parameters
group_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean
canSave
boolean

Boolean indicating whether user can save sources to group. Defaults to true.

Responses

200
post/api/groups/group_id/users/ignored_args
https://fritz.science/api/groups/group_id/users/ignored_args

Request samples

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

Response samples

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

Update a group user's admin or save access status

Update a group user's admin or save access status

@@ -2884,12 +2884,12 @@

Pagination

Responses

200
patch/api/groups/group_id/users/ignored_args
https://fritz.science/api/groups/group_id/users/ignored_args

Request samples

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

Response samples

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

Delete a group user

Delete a group user

path Parameters
group_id
required
integer
user_id
required
integer

Responses

200
delete/api/groups/group_id/users/user_id
https://fritz.science/api/groups/group_id/users/user_id

Response samples

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

Add users from other group(s) to specified group

Add users from other group(s) to specified group

path Parameters
group_id
required
integer
Request Body schema: application/json
fromGroupIDs
required
boolean

Responses

200
post/api/groups/group_id/usersFromGroups/ignored_args
https://fritz.science/api/groups/group_id/usersFromGroups/ignored_args

Request samples

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

Response samples

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

Retrieve a group admission request

Retrieve a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

200
400
get/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Delete a group admission request

Delete a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

200
400
get/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Delete a group admission request

Delete a group admission request

path Parameters
admission_request_id
required
integer

Responses

200
delete/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Update a group admission request's status

Update a group admission request's status

path Parameters
admission_request_id
required
integer
Request Body schema: application/json
status
required
string

One of either 'accepted', 'declined', or 'pending'.

Responses

200
patch/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Request samples

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

Response samples

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

Retrieve all group admission requests

Retrieve all group admission requests

query Parameters
groupID
integer

ID of group for which admission requests are desired

-

Responses

200
400
get/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Response samples

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

Create a new group admission request

Create a new group admission request

+

Responses

200
400
get/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Response samples

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

Create a new group admission request

Create a new group admission request

Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

200
post/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

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

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

path Parameters
shift_id
required
integer
query Parameters
startDate
string

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

@@ -2901,7 +2901,7 @@

Pagination

Responses

200
patch/api/shifts/shift_id/users/user_id
https://fritz.science/api/shifts/shift_id/users/user_id

Request samples

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

Response samples

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

Grant stream access to a user

Grant stream access to a user

path Parameters
stream_id
required
integer
Request Body schema: application/json
user_id
required
integer

Responses

200
post/api/streams/stream_id/users/ignored_args
https://fritz.science/api/streams/stream_id/users/ignored_args

Request samples

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

Response samples

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

Delete a stream user (revoke stream access for use

Delete a stream user (revoke stream access for user)

path Parameters
stream_id
required
integer
user_id
required
integer

Responses

200
delete/api/streams/stream_id/users/user_id
https://fritz.science/api/streams/stream_id/users/user_id

Response samples

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

Retrieve a user

Retrieve a user

-
path Parameters
user_id
required
integer

Responses

200
400
get/api/user/user_id
https://fritz.science/api/user/user_id

Response samples

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

Delete a user

Delete a user

+
path Parameters
user_id
required
integer

Responses

200
400
get/api/user/user_id
https://fritz.science/api/user/user_id

Response samples

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

Delete a user

Delete a user

path Parameters
user_id
required
integer

Responses

200
400
delete/api/user/user_id
https://fritz.science/api/user/user_id

Response samples

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

Update a User record

Update a User record

path Parameters
user_id
required
integer
Request Body schema: application/json
expirationDate
string

Arrow-parseable date string (e.g. 2020-01-01). Set a user's expiration date, after which the user's account will be deactivated and will be unable @@ -2917,7 +2917,7 @@

Pagination

acl
string

Get users with this ACL.

group
string

Get users part of the group with name given by this parameter.

stream
string

Get users with access to the stream with name given by this parameter.

-

Responses

200
400
get/api/user
https://fritz.science/api/user

Response samples

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

Add a new user

Add a new user

+

Responses

200
400
get/api/user
https://fritz.science/api/user

Response samples

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

Add a new user

Add a new user

Request Body schema: application/json
username
required
string
first_name
string
last_name
string
affiliations
Array of strings
contact_email
string
oauth_uid
string
contact_phone
string
roles
Array of strings

List of user roles. Defaults to [Full user]. Will be overridden by groupIDsAndAdmin on a per-group basis.

groupIDsAndAdmin
Array of arrays

Array of 2-element arrays [groupID, admin] where groupID @@ -2925,7 +2925,7 @@

Pagination

admin is a boolean indicating whether they will be an admin in that group, e.g. [[group_id_1, true], [group_id_2, false]]

Responses

200
post/api/user
https://fritz.science/api/user

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "affiliations":
    [
    ],
  • "contact_email": "string",
  • "oauth_uid": "string",
  • "contact_phone": "string",
  • "roles":
    [
    ],
  • "groupIDsAndAdmin":
    [
    ]
}

Response samples

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

mmadetectors

Retrieve a Multimessenger Astronomical Detector (M

Retrieve a Multimessenger Astronomical Detector (MMADetector)

-
path Parameters
mmadetector_id
required
integer

Responses

200
400
get/api/mmadetector/mmadetector_id
https://fritz.science/api/mmadetector/mmadetector_id

Response samples

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

Delete a Multimessenger Astronomical Detector (MMA

Delete a Multimessenger Astronomical Detector (MMADetector)

+
path Parameters
mmadetector_id
required
integer

Responses

200
400
get/api/mmadetector/mmadetector_id
https://fritz.science/api/mmadetector/mmadetector_id

Response samples

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

Delete a Multimessenger Astronomical Detector (MMA

Delete a Multimessenger Astronomical Detector (MMADetector)

path Parameters
mmadetector_id
required
integer

Responses

200
400
delete/api/mmadetector/mmadetector_id
https://fritz.science/api/mmadetector/mmadetector_id

Response samples

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

Update a Multimessenger Astronomical Detector (MMA

Update a Multimessenger Astronomical Detector (MMADetector)

path Parameters
mmadetector_id
required
integer
Request Body schema: application/json
events
Array of any
spectra
Array of any
time_intervals
Array of any
name
required
string

Unabbreviated facility name (e.g., LIGO Hanford Observatory.

nickname
required
string

Abbreviated facility name (e.g., H1).

@@ -2936,7 +2936,7 @@

Pagination

fixed_location
boolean

Does this telescope have a fixed location (lon, lat, elev)?

Responses

200
400
patch/api/mmadetector/mmadetector_id
https://fritz.science/api/mmadetector/mmadetector_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "events":
    [
    ],
  • "spectra":
    [
    ],
  • "time_intervals":
    [
    ],
  • "name": "string",
  • "nickname": "string",
  • "type": "gravitational-wave",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "fixed_location": true
}

Response samples

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

Retrieve all Multimessenger Astronomical Detectors

Retrieve all Multimessenger Astronomical Detectors (MMADetectors)

query Parameters
name
string

Filter by name

-

Responses

200
400
get/api/mmadetector
https://fritz.science/api/mmadetector

Response samples

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

Create a Multimessenger Astronomical Detector (MMA

Create a Multimessenger Astronomical Detector (MMADetector)

+

Responses

200
400
get/api/mmadetector
https://fritz.science/api/mmadetector

Response samples

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

Create a Multimessenger Astronomical Detector (MMA

Create a Multimessenger Astronomical Detector (MMADetector)

Request Body schema: application/json
events
Array of any
spectra
Array of any
time_intervals
Array of any
name
required
string

Unabbreviated facility name (e.g., LIGO Hanford Observatory.

nickname
required
string

Abbreviated facility name (e.g., H1).

type
required
string <= 18 characters
Enum: "gravitational-wave" "neutrino" "gamma-ray-burst"

MMA detector type, one of gravitational wave, neutrino, or gamma-ray burst.

@@ -2945,15 +2945,15 @@

Pagination

elevation
number Nullable

Elevation in meters.

fixed_location
boolean

Does this telescope have a fixed location (lon, lat, elev)?

Responses

200
400
post/api/mmadetector
https://fritz.science/api/mmadetector

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "events":
    [
    ],
  • "spectra":
    [
    ],
  • "time_intervals":
    [
    ],
  • "name": "string",
  • "nickname": "string",
  • "type": "gravitational-wave",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "fixed_location": true
}

Response samples

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

mmadetector_spectra

Retrieve an mmadetector spectrum

Retrieve an mmadetector spectrum

-
path Parameters
spectrum_id
required
integer

Responses

200
403
get/api/mmadetector/spectra/spectrum_id
https://fritz.science/api/mmadetector/spectra/spectrum_id

Response samples

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

Delete an mmadetector spectrum

Delete an mmadetector spectrum

+
path Parameters
spectrum_id
required
integer

Responses

200
403
get/api/mmadetector/spectra/spectrum_id
https://fritz.science/api/mmadetector/spectra/spectrum_id

Response samples

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

Delete an mmadetector spectrum

Delete an mmadetector spectrum

path Parameters
spectrum_id
required
integer

Responses

200
400
delete/api/mmadetector/spectra/spectrum_id
https://fritz.science/api/mmadetector/spectra/spectrum_id

Response samples

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

Update mmadetector spectrum

Update mmadetector spectrum

-
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
detector_id
required
integer

ID of the MMADetector that acquired the Spectrum.

-
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

+
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

frequencies
required
Array of numbers

Frequencies of the spectrum [Hz].

-
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

-
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

-

Responses

200
400
patch/api/mmadetector/spectra/spectrum_id
https://fritz.science/api/mmadetector/spectra/spectrum_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detector_id": 0,
  • "end_time": "2024-06-29T14:41:22Z",
  • "group_ids": [ ],
  • "frequencies":
    [
    ],
  • "amplitudes":
    [
    ],
  • "start_time": "2024-06-29T14:41:22Z"
}

Response samples

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

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

+
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

+
detector_id
required
integer

ID of the MMADetector that acquired the Spectrum.

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+

Responses

200
400
patch/api/mmadetector/spectra/spectrum_id
https://fritz.science/api/mmadetector/spectra/spectrum_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amplitudes":
    [
    ],
  • "start_time": "2024-06-29T14:54:59Z",
  • "frequencies":
    [
    ],
  • "end_time": "2024-06-29T14:54:59Z",
  • "detector_id": 0,
  • "group_ids": [ ]
}

Response samples

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

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

query Parameters
observedBefore
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, return only spectra observed before this time.

observedAfter
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, @@ -2961,14 +2961,14 @@

Pagination

detectorIDs
any

If provided, filter only spectra observed with one of these mmadetector IDs.

groupIDs
list

If provided, filter only spectra saved to one of these group IDs.

get/api/mmadetector/spectra
https://fritz.science/api/mmadetector/spectra

Upload a Multimessenger Astronomical Detector (MMA

Upload a Multimessenger Astronomical Detector (MMADetector) spectrum

-
Request Body schema: application/json
detector_id
required
integer

ID of the MMADetector that acquired the Spectrum.

-
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+
Request Body schema: application/json
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

+
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

frequencies
required
Array of numbers

Frequencies of the spectrum [Hz].

-
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

-
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

-

Responses

200
400
post/api/mmadetector/spectra
https://fritz.science/api/mmadetector/spectra

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detector_id": 0,
  • "end_time": "2024-06-29T14:41:23Z",
  • "group_ids": [ ],
  • "frequencies":
    [
    ],
  • "amplitudes":
    [
    ],
  • "start_time": "2024-06-29T14:41:23Z"
}

Response samples

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

mmadetector_time_intervals

Retrieve an mmadetector time_interval

Retrieve an mmadetector time_interval

-
path Parameters
time_interval_id
required
integer

Responses

200
403
get/api/mmadetector/time_intervals/time_interval_id
https://fritz.science/api/mmadetector/time_intervals/time_interval_id

Response samples

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

Delete an mmadetector time_interval

Delete an mmadetector time_interval

+
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

+
detector_id
required
integer

ID of the MMADetector that acquired the Spectrum.

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+

Responses

200
400
post/api/mmadetector/spectra
https://fritz.science/api/mmadetector/spectra

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amplitudes":
    [
    ],
  • "start_time": "2024-06-29T14:54:59Z",
  • "frequencies":
    [
    ],
  • "end_time": "2024-06-29T14:54:59Z",
  • "detector_id": 0,
  • "group_ids": [ ]
}

Response samples

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

mmadetector_time_intervals

Retrieve an mmadetector time_interval

Retrieve an mmadetector time_interval

+
path Parameters
time_interval_id
required
integer

Responses

200
403
get/api/mmadetector/time_intervals/time_interval_id
https://fritz.science/api/mmadetector/time_intervals/time_interval_id

Response samples

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

Delete an mmadetector time_interval

Delete an mmadetector time_interval

path Parameters
time_interval_id
required
integer

Responses

200
400
delete/api/mmadetector/time_intervals/time_interval_id
https://fritz.science/api/mmadetector/time_intervals/time_interval_id

Response samples

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

Update mmadetector time_interval

Update mmadetector time_interval

path Parameters
time_interval_id
required
integer
Request Body schema: application/json
detector
any Nullable

The MMADetector that acquired the Time Interval.

groups
Array of any
owner
any Nullable

The User who uploaded the detector time interval.

@@ -2988,7 +2988,7 @@

Pagination

path Parameters
user_id
required
string
query Parameters
listName
string

name of the list to retrieve objects from. If not given will return all objects saved by the user to all lists.

-

Responses

200
400
get/api/listing/user_id
https://fritz.science/api/listing/user_id

Response samples

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

Add a listing.

Add a listing.

+

Responses

200
400
get/api/listing/user_id
https://fritz.science/api/listing/user_id

Response samples

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

Add a listing.

Add a listing.

Request Body schema: application/json
user_id
integer

ID of user that you want to add the listing to. If not given, will default to the associated user object that is posting.

obj_id
string
list_name
string

Listing name for this item, e.g., "favorites". @@ -3017,12 +3017,12 @@

Pagination

alphanumeric character or underscore. (it must match the regex: /^\w+/)

Responses

200
patch/api/listing/listing_id
https://fritz.science/api/listing/listing_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user_id": 0,
  • "obj_id": "string",
  • "list_name": "string"
}

Response samples

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

group_admission_requests

Retrieve a group admission request

Retrieve a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

200
400
get/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Delete a group admission request

Delete a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

200
400
get/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Delete a group admission request

Delete a group admission request

path Parameters
admission_request_id
required
integer

Responses

200
delete/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Response samples

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

Update a group admission request's status

Update a group admission request's status

path Parameters
admission_request_id
required
integer
Request Body schema: application/json
status
required
string

One of either 'accepted', 'declined', or 'pending'.

Responses

200
patch/api/group_admission_requests/admission_request_id
https://fritz.science/api/group_admission_requests/admission_request_id

Request samples

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

Response samples

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

Retrieve all group admission requests

Retrieve all group admission requests

query Parameters
groupID
integer

ID of group for which admission requests are desired

-

Responses

200
400
get/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Response samples

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

Create a new group admission request

Create a new group admission request

+

Responses

200
400
get/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Response samples

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

Create a new group admission request

Create a new group admission request

Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

200
post/api/group_admission_requests
https://fritz.science/api/group_admission_requests

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

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

instrumentlogs

Add log messages from an instrument

Add log messages from an instrument

path Parameters
instrument_id
required
integer

The instrument ID to post logs for

Request Body schema: application/json
start_date
required
string

Arrow-parseable date string (e.g. 2020-01-01).

@@ -3066,15 +3066,15 @@

Pagination

pageNumber
integer

Page number for paginated query results. Defaults to 1

sortBy
string

The field to sort by.

sortOrder
string

The sort order - either "asc" or "desc". Defaults to "asc"

-

Responses

200
400
get/api/observation
https://fritz.science/api/observation

Response samples

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

Ingest a set of ExecutedObservations

Ingest a set of ExecutedObservations

-
Request Body schema: application/json
telescopeName
required
string

The telescope name associated with the fields

-
observationData
any

Observation data dictionary list

-
instrumentName
required
string

The instrument name associated with the fields

-

Responses

200
400
post/api/observation
https://fritz.science/api/observation

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "telescopeName": "string",
  • "observationData": null,
  • "instrumentName": "string"
}

Response samples

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

Delete an observation

Delete an observation

+

Responses

200
400
get/api/observation
https://fritz.science/api/observation

Response samples

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

Ingest a set of ExecutedObservations

Ingest a set of ExecutedObservations

+
Request Body schema: application/json
observationData
any

Observation data dictionary list

+
instrumentName
required
string

The instrument name associated with the fields

+
telescopeName
required
string

The telescope name associated with the fields

+

Responses

200
400
post/api/observation
https://fritz.science/api/observation

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observationData": null,
  • "instrumentName": "string",
  • "telescopeName": "string"
}

Response samples

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

Delete an observation

Delete an observation

path Parameters
observation_id
required
integer

Responses

200
400
delete/api/observation/observation_id
https://fritz.science/api/observation/observation_id

Response samples

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

Upload observation from ASCII file

Upload observation from ASCII file

-
Request Body schema: application/json
observationData
any

Observation data Ascii string

-
instrumentID
required
string

The instrument ID associated with the fields

-

Responses

200
400
post/api/observation/ascii
https://fritz.science/api/observation/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "observationData": null,
  • "instrumentID": "string"
}

Response samples

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

Perform simsurvey efficiency calculation

Perform simsurvey efficiency calculation

+
Request Body schema: application/json
instrumentID
required
string

The instrument ID associated with the fields

+
observationData
any

Observation data Ascii string

+

Responses

200
400
post/api/observation/ascii
https://fritz.science/api/observation/ascii

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "instrumentID": "string",
  • "observationData": null
}

Response samples

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

Perform simsurvey efficiency calculation

Perform simsurvey efficiency calculation

path Parameters
instrument_id
required
string

ID for the instrument to submit

query Parameters
startDate
required
string

Filter by start date

endDate
required
string

Filter by end date

@@ -3104,16 +3104,16 @@

Pagination

query Parameters
startDate
string

Filter by start date

endDate
string

Filter by end date

queuesOnly
bool

Return queue only (do not commit observations)

-

Responses

200
400
get/api/observation/external_api/allocation_id
https://fritz.science/api/observation/external_api/allocation_id

Response samples

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

Delete queued observations from external API

Delete queued observations from external API

+

Responses

200
400
get/api/observation/external_api/allocation_id
https://fritz.science/api/observation/external_api/allocation_id

Response samples

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

Delete queued observations from external API

Delete queued observations from external API

path Parameters
allocation_id
required
string

ID for the allocation to delete queue

query Parameters
queueName
required
string

Queue name to remove

Responses

200
400
delete/api/observation/external_api/allocation_id
https://fritz.science/api/observation/external_api/allocation_id

Response samples

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

Retrieve observations from external API

Retrieve observations from external API

Request Body schema: application/json
end_date
required
any

end date of the request.

-
allocation_id
required
integer

Followup request allocation ID.

-
start_date
required
any

start date of the request.

-

Responses

200
400
post/api/observation/external_api
https://fritz.science/api/observation/external_api

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "end_date": null,
  • "allocation_id": 0,
  • "start_date": null
}

Response samples

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

Retrieve skymap-based trigger from external API

Retrieve skymap-based trigger from external API

+
start_date
required
any

start date of the request.

+
allocation_id
required
integer

Followup request allocation ID.

+

Responses

200
400
post/api/observation/external_api
https://fritz.science/api/observation/external_api

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "end_date": null,
  • "start_date": null,
  • "allocation_id": 0
}

Response samples

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

Retrieve skymap-based trigger from external API

Retrieve skymap-based trigger from external API

path Parameters
allocation_id
required
string

ID for the allocation to retrieve

-

Responses

200
400
get/api/skymap_trigger/allocation_id
https://fritz.science/api/skymap_trigger/allocation_id

Response samples

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

Delete skymap-based trigger from external API

Delete skymap-based trigger from external API

+

Responses

200
400
get/api/skymap_trigger/allocation_id
https://fritz.science/api/skymap_trigger/allocation_id

Response samples

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

Delete skymap-based trigger from external API

Delete skymap-based trigger from external API

path Parameters
allocation_id
required
string

ID for the allocation to delete queue

query Parameters
queueName
required
string

Queue name to remove

Responses

200
400
delete/api/skymap_trigger/allocation_id
https://fritz.science/api/skymap_trigger/allocation_id

Response samples

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

invitations

Retrieve invitations

Retrieve invitations

@@ -3125,7 +3125,7 @@

Pagination

group
string

Get invitations part of the group with name given by this parameter.

stream
string

Get invitations with access to the stream with name given by this parameter.

invitedBy
string

Get invitations invited by users whose username contains this string.

-

Responses

200
get/api/invitations
https://fritz.science/api/invitations

Response samples

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

Invite a new user

Invite a new user

+

Responses

200
get/api/invitations
https://fritz.science/api/invitations

Response samples

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

Invite a new user

Invite a new user

Request Body schema: application/json
userEmail
required
string
role
string

The role the new user will have in the system. If provided, must be one of either "Full user" or "View only". Defaults to "Full user".

@@ -3151,7 +3151,7 @@

Pagination

path Parameters
survey_efficiency_analysis_id
required
string

Responses

200
delete/api/observation/simsurvey/survey_efficiency_analysis_id
https://fritz.science/api/observation/simsurvey/survey_efficiency_analysis_id

Response samples

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

Create a summary plot for a simsurvey efficiency c

Create a summary plot for a simsurvey efficiency calculation.

path Parameters
survey_efficiency_analysis_id
required
string

Responses

200
get/api/observation/simsurvey/survey_efficiency_analysis_id/plot
https://fritz.science/api/observation/simsurvey/survey_efficiency_analysis_id/plot

Response samples

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

Create a summary plot for a simsurvey efficiency c

Create a summary plot for a simsurvey efficiency calculation.

path Parameters
survey_efficiency_analysis_id
required
string

Responses

200
get/api/observation_plan/survey_efficiency_analysis_id/simsurvey/plot
https://fritz.science/api/observation_plan/survey_efficiency_analysis_id/simsurvey/plot

Response samples

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

Retrieve an observation efficiency analysis

Retrieve an observation efficiency analysis

-
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

200
400
get/api/survey_efficiency/observations/survey_efficiency_analysis_id
https://fritz.science/api/survey_efficiency/observations/survey_efficiency_analysis_id

Response samples

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

observationplan_requests

Remove observations from treasuremap.space.

Remove observations from treasuremap.space.

+
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

200
400
get/api/survey_efficiency/observations/survey_efficiency_analysis_id
https://fritz.science/api/survey_efficiency/observations/survey_efficiency_analysis_id

Response samples

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

observationplan_requests

Remove observations from treasuremap.space.

Remove observations from treasuremap.space.

path Parameters
instrument_id
required
string

ID for the instrument to submit

query Parameters
localizationDateobs
string

Event time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sss). Each localization is associated with a specific GCNEvent by @@ -3161,23 +3161,23 @@

Pagination

GcnEvent page table.

Responses

200
delete/api/observation/treasuremap/instrument_id
https://fritz.science/api/observation/treasuremap/instrument_id

Response samples

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

Remove observation plan from treasuremap.space.

Remove observation plan from treasuremap.space.

path Parameters
observation_plan_id
required
string

Responses

200
delete/api/observation_plan/observation_plan_request_id/treasuremap
https://fritz.science/api/observation_plan/observation_plan_request_id/treasuremap

Response samples

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

observing_runs

Retrieve an observing run

Retrieve an observing run

-
path Parameters
run_id
required
integer

Responses

200
400
get/api/observing_run/run_id
https://fritz.science/api/observing_run/run_id

Response samples

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

Update observing run

Update observing run

-
path Parameters
run_id
required
integer
Request Body schema: application/json
pi
string

The PI of the observing run.

+
path Parameters
run_id
required
integer

Responses

200
400
get/api/observing_run/run_id
https://fritz.science/api/observing_run/run_id

Response samples

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

Update observing run

Update observing run

+
path Parameters
run_id
required
integer
Request Body schema: application/json
group_id
integer

The ID of the group this run is associated with.

instrument_id
required
integer

The ID of the instrument to be used in this run.

-
group_id
integer

The ID of the group this run is associated with.

observers
string

The names of the observers

+
pi
string

The PI of the observing run.

calendar_date
required
string <date>

The local calendar date of the run.

-

Responses

200
400
put/api/observing_run/run_id
https://fritz.science/api/observing_run/run_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "pi": "string",
  • "instrument_id": 0,
  • "group_id": 0,
  • "observers": "string",
  • "calendar_date": "2024-06-29"
}

Response samples

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

Delete an observing run

Delete an observing run

+

Responses

200
400
put/api/observing_run/run_id
https://fritz.science/api/observing_run/run_id

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group_id": 0,
  • "instrument_id": 0,
  • "observers": "string",
  • "pi": "string",
  • "calendar_date": "2024-06-29"
}

Response samples

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

Delete an observing run

Delete an observing run

path Parameters
run_id
required
integer

Responses

200
400
delete/api/observing_run/run_id
https://fritz.science/api/observing_run/run_id

Response samples

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

Retrieve all observing runs

Retrieve all observing runs

-

Responses

200
400
get/api/observing_run
https://fritz.science/api/observing_run

Response samples

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

Add a new observing run

Add a new observing run

-
Request Body schema: application/json
pi
string

The PI of the observing run.

+

Responses

200
400
get/api/observing_run
https://fritz.science/api/observing_run

Response samples

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

Add a new observing run

Add a new observing run

+
Request Body schema: application/json
group_id
integer

The ID of the group this run is associated with.

instrument_id
required
integer

The ID of the instrument to be used in this run.

-
group_id
integer

The ID of the group this run is associated with.

observers
string

The names of the observers

+
pi
string

The PI of the observing run.

calendar_date
required
string <date>

The local calendar date of the run.

-

Responses

200
400
post/api/observing_run
https://fritz.science/api/observing_run

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "pi": "string",
  • "instrument_id": 0,
  • "group_id": 0,
  • "observers": "string",
  • "calendar_date": "2024-06-29"
}

Response samples

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

survey_efficiency_for_observation_plans

Delete a simsurvey efficiency calculation.

Delete a simsurvey efficiency calculation.

+

Responses

200
400
post/api/observing_run
https://fritz.science/api/observing_run

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group_id": 0,
  • "instrument_id": 0,
  • "observers": "string",
  • "pi": "string",
  • "calendar_date": "2024-06-29"
}

Response samples

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

survey_efficiency_for_observation_plans

Delete a simsurvey efficiency calculation.

Delete a simsurvey efficiency calculation.

path Parameters
survey_efficiency_analysis_id
required
string

Responses

200
delete/api/observation_plan/survey_efficiency_analysis_id/simsurvey
https://fritz.science/api/observation_plan/survey_efficiency_analysis_id/simsurvey

Response samples

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

Retrieve an observation plan efficiency analysis

Retrieve an observation plan efficiency analysis

-
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

200
400
get/api/survey_efficiency/observation_plan/survey_efficiency_analysis_id
https://fritz.science/api/survey_efficiency/observation_plan/survey_efficiency_analysis_id

Response samples

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

objs

Delete an Obj

Delete an Obj

+
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

200
400
get/api/survey_efficiency/observation_plan/survey_efficiency_analysis_id
https://fritz.science/api/survey_efficiency/observation_plan/survey_efficiency_analysis_id

Response samples

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

objs

Delete an Obj

Delete an Obj

path Parameters
obj_id
required
string

Responses

200
400
delete/api/objs/obj_id
https://fritz.science/api/objs/obj_id

Response samples

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

Set an object's host galaxy

Set an object's host galaxy

path Parameters
obj_id
required
string
Request Body schema: application/json
galaxyName
required
string

Name of the galaxy to associate with the object

Responses

200
400
post/api/sources/obj_id/host
https://fritz.science/api/sources/obj_id/host

Request samples

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

Response samples

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

Delete an object's host galaxy

Delete an object's host galaxy

@@ -3217,7 +3217,7 @@

Pagination

(to see how to unpack this data format, look at photometric_series.md) If json, the data will be returned as a JSON object, where each key is a list of values for that column.

-

Responses

200
get/api/photometric_series/photometric_series_id
https://fritz.science/api/photometric_series/photometric_series_id

Response samples

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

Delete a photometric series

Delete a photometric series

+

Responses

200
get/api/photometric_series/photometric_series_id
https://fritz.science/api/photometric_series/photometric_series_id

Response samples

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

Delete a photometric series

Delete a photometric series

path Parameters
photometric_series_id
required
integer

Responses

200
400
delete/api/photometric_series/photometric_series_id
https://fritz.science/api/photometric_series/photometric_series_id

Response samples

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

Retrieve all photometric series, based on various

Retrieve all photometric series, based on various cuts.

query Parameters
dataFormat
string
Enum: "json" "hdf5" "none"

Format of the data to return. If none, the data will not be returned. If hdf5, the data will be returned as a bytestream in HDF5 format. @@ -3357,9 +3357,9 @@

Pagination

groupIDs
required
Array of integers

List of IDs of groups data will be shared with. To share data with a single user, specify their single user group ID here.

Responses

200
post/api/sharing
https://fritz.science/api/sharing

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "photometryIDs":
    [
    ],
  • "spectrumIDs":
    [
    ],
  • "groupIDs":
    [
    ]
}

Response samples

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

recurring_apis

Retrieve an Recurring API by id

Retrieve an Recurring API by id

-
path Parameters
recurring_api_id
required
integer

Responses

200
400
get/api/recurring_api/recurring_api_id
https://fritz.science/api/recurring_api/recurring_api_id

Response samples

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

Delete an Recurring API.

Delete an Recurring API.

+
path Parameters
recurring_api_id
required
integer

Responses

200
400
get/api/recurring_api/recurring_api_id
https://fritz.science/api/recurring_api/recurring_api_id

Response samples

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

Delete an Recurring API.

Delete an Recurring API.

path Parameters
recurring_api_id
required
integer

Responses

200
delete/api/recurring_api/recurring_api_id
https://fritz.science/api/recurring_api/recurring_api_id

Response samples

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

Retrieve all Recurring APIs

Retrieve all Recurring APIs

-

Responses

200
400
get/api/recurring_api
https://fritz.science/api/recurring_api

Response samples

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

POST a new Recurring APIs.

POST a new Recurring APIs.

+

Responses

200
400
get/api/recurring_api
https://fritz.science/api/recurring_api

Response samples

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

POST a new Recurring APIs.

POST a new Recurring APIs.

Request Body schema: application/json
endpoint
required
string

Endpoint of the API call.

method
required
string

HTTP method of the API call.

next_call
required
datetime

Time of the next API call.

@@ -3382,7 +3382,7 @@

Pagination

path Parameters
catalog_id
required
integer
get/api/spatial_catalog/catalog_id
https://fritz.science/api/spatial_catalog/catalog_id

Retrieve all SpatialCatalogs

Retrieve all SpatialCatalogs

get/api/spatial_catalog
https://fritz.science/api/spatial_catalog

config

Retrieve parts of the config file that are exposed

Retrieve parts of the config file that are exposed to the user/browser

Responses

200
get/api/config
https://fritz.science/api/config

Response samples

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

taxonomies

Retrieve a taxonomy

Retrieve a taxonomy

-
path Parameters
taxonomy_id
required
integer

Responses

200
400
get/api/taxonomy/taxonomy_id
https://fritz.science/api/taxonomy/taxonomy_id

Response samples

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

Update taxonomy

Update taxonomy

+
path Parameters
taxonomy_id
required
integer

Responses

200
400
get/api/taxonomy/taxonomy_id
https://fritz.science/api/taxonomy/taxonomy_id

Response samples

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

Update taxonomy

Update taxonomy

path Parameters
taxonomy_id
required
integer
Request Body schema: application/json
groups
Array of any
classifications
Array of any
name
required
string

Short string to make this taxonomy memorable to end users.

hierarchy
required
any

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

provenance
string Nullable

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

@@ -3390,7 +3390,7 @@

Pagination

isLatest
boolean

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

Responses

200
400
put/api/taxonomy/taxonomy_id
https://fritz.science/api/taxonomy/taxonomy_id

Request samples

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

Response samples

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

Delete a taxonomy

Delete a taxonomy

path Parameters
taxonomy_id
required
integer

Responses

200
delete/api/taxonomy/taxonomy_id
https://fritz.science/api/taxonomy/taxonomy_id

Response samples

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

Get all the taxonomies

Get all the taxonomies

-

Responses

200
400
get/api/taxonomy
https://fritz.science/api/taxonomy

Response samples

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

Post new taxonomy

Post new taxonomy

+

Responses

200
400
get/api/taxonomy
https://fritz.science/api/taxonomy

Response samples

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

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 @@ -3406,7 +3406,7 @@

Pagination

isLatest
boolean

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

Responses

200
post/api/taxonomy
https://fritz.science/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":
    {
    }
}

telescopes

Retrieve a telescope

Retrieve a telescope

-
path Parameters
telescope_id
required
integer

Responses

200
400
get/api/telescope/telescope_id
https://fritz.science/api/telescope/telescope_id

Response samples

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

Update telescope

Update telescope

+
path Parameters
telescope_id
required
integer

Responses

200
400
get/api/telescope/telescope_id
https://fritz.science/api/telescope/telescope_id

Response samples

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

Update telescope

Update telescope

path Parameters
telescope_id
required
integer
Request Body schema: application/json
instruments
Array of any
name
required
string

Unabbreviated facility name (e.g., Palomar 200-inch Hale Telescope).

nickname
required
string

Abbreviated facility name (e.g., P200).

lat
number Nullable

Latitude in deg.

@@ -3424,7 +3424,7 @@

Pagination

latitudeMax
number

Filter by latitude <= latitudeMax

longitudeMin
number

Filter by longitude >= longitudeMin

longitudeMax
number

Filter by longitude <= longitudeMax

-

Responses

200
400
get/api/telescope
https://fritz.science/api/telescope

Response samples

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

Create telescopes

Create telescopes

+

Responses

200
400
get/api/telescope
https://fritz.science/api/telescope

Response samples

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

Create telescopes

Create telescopes

Request Body schema: application/json
instruments
Array of any
name
required
string

Unabbreviated facility name (e.g., Palomar 200-inch Hale Telescope).

nickname
required
string

Abbreviated facility name (e.g., P200).

lat
number Nullable

Latitude in deg.

@@ -3437,7 +3437,7 @@

Pagination

fixed_location
boolean

Does this telescope have a fixed location (lon, lat, elev)?

Responses

200
400
post/api/telescope
https://fritz.science/api/telescope

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "instruments":
    [
    ],
  • "name": "string",
  • "nickname": "string",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "diameter": 0,
  • "skycam_link": "string",
  • "weather_link": "string",
  • "robotic": true,
  • "fixed_location": true
}

Response samples

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

Retrieve weather info at the telescope site saved

Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id parameter

query Parameters
telescope_id
integer

Responses

200
get/api/weather
https://fritz.science/api/weather

Response samples

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

thumbnails

Retrieve a thumbnail

Retrieve a thumbnail

-
path Parameters
thumbnail_id
required
integer

Responses

200
400
get/api/thumbnail/thumbnail_id
https://fritz.science/api/thumbnail/thumbnail_id

Response samples

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

Update thumbnail

Update thumbnail

+
path Parameters
thumbnail_id
required
integer

Responses

200
400
get/api/thumbnail/thumbnail_id
https://fritz.science/api/thumbnail/thumbnail_id

Response samples

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

Update thumbnail

Update thumbnail

path Parameters
thumbnail_id
required
integer
Request Body schema: application/json
obj
any Nullable

The Thumbnail's Obj.

type
string <= 6 characters Nullable
Enum: "new" "ref" "sub" "sdss" "dr8" "ls" "ps1" "new_gz" "ref_gz" "sub_gz"

Thumbnail type (e.g., ref, new, sub, ls, ps1, ...)

file_uri
string Nullable

Path of the Thumbnail on the machine running SkyPortal.

@@ -3503,7 +3503,7 @@

Pagination

path Parameters
tnsrobot_id
required
integer

ID of the TNS robot

user_id
required
integer

ID of the user to remove as a coauthor

Responses

200
400
delete/api/tns_robot/tnsrobot_id/coauthor/user_id
https://fritz.science/api/tns_robot/tnsrobot_id/coauthor/user_id

Response samples

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

Retrieve a TNS robot

Retrieve a TNS robot

-
path Parameters
tnsrobot_id
required
integer

Responses

200
400
get/api/tns_robot/tnsrobot_id
https://fritz.science/api/tns_robot/tnsrobot_id

Response samples

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

Delete a TNS robot

Delete a TNS robot

+
path Parameters
tnsrobot_id
required
integer

Responses

200
400
get/api/tns_robot/tnsrobot_id
https://fritz.science/api/tns_robot/tnsrobot_id

Response samples

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

Delete a TNS robot

Delete a TNS robot

path Parameters
tnsrobot_id
required
integer

Responses

200
400
delete/api/tns_robot/tnsrobot_id
https://fritz.science/api/tns_robot/tnsrobot_id

Response samples

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

Post or update a TNS robot

Post or update a TNS robot

Request Body schema: application/json
instruments
Array of any
streams
Array of any
groups
Array of any
coauthors
Array of any
bot_name
required
string

Name of the TNS bot.

bot_id
required
integer

ID of the TNS bot.

@@ -3530,10 +3530,10 @@

Pagination

Responses

200
400
post/api/public_pages/source/source_id
https://fritz.science/api/public_pages/source/source_id

Request samples

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

Response samples

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

Delete a public source page

Delete a public source page

path Parameters
page_id
required
string

The ID of the public source page to delete

Responses

200
400
delete/api/public_pages/source/page_id
https://fritz.science/api/public_pages/source/page_id

Response samples

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

reports

Retrieve all reports

Retrieve all reports

-

Responses

200
400
get/public/reports/report_type/report_id/option
https://fritz.science/public/reports/report_type/report_id/option

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sent_by": null,
  • "group": null,
  • "sent_by_id": 0,
  • "dateobs": "2024-06-29T14:41:23Z",
  • "group_id": 0,
  • "data": null,
  • "report_name": "string",
  • "published": true,
  • "id": 0
}

source_page

Display the public page for a given source and ver

Display the public page for a given source and version

+

Responses

200
400
get/public/reports/report_type/report_id/option
https://fritz.science/public/reports/report_type/report_id/option

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sent_by": null,
  • "group": null,
  • "sent_by_id": 0,
  • "dateobs": "2024-06-29T14:54:59Z",
  • "group_id": 0,
  • "data": null,
  • "report_name": "string",
  • "published": true,
  • "id": 0
}

source_page

Display the public page for a given source and ver

Display the public page for a given source and version

path Parameters
source_id
required
string

The ID of the source for which to display the public page

version_hash
required
string

The hash of the source data used to identify the version

-

Responses

200
400
get/public/sources/source_id/version_hash///
https://fritz.science/public/sources/source_id/version_hash///

Response samples

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

sources_page

List all public source pages and their versions

List all public source pages and their versions

+

Responses

200
400
get/public/sources/source_id/version_hash///
https://fritz.science/public/sources/source_id/version_hash///

Response samples

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

sources_page

List all public source pages and their versions

List all public source pages and their versions

Responses

200
get/public/sources/source_id/version_hash//
https://fritz.science/public/sources/source_id/version_hash//

alerts

Retrieve an object from Kowalski by objectId

Retrieve an object from Kowalski by objectId

path Parameters
object_id
required
str
query Parameters
instrument
str
candid
int
includeAllFields
boolean

Responses

200

retrieved alert(s)

400
get/api/alerts/object_id
https://fritz.science/api/alerts/object_id

Response samples

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

Retrieve objects from Kowalski by objectId and or

Retrieve objects from Kowalski by objectId and or position

@@ -3558,7 +3558,7 @@

Pagination

cmap
string
Enum: "bone" "gray" "cividis" "viridis" "magma"

Color map to use when rendering png

Responses

200

retrieved cutout

400

retrieval failed

-
get/api/alerts_cutouts/object_id
https://fritz.science/api/alerts_cutouts/object_id

Response samples

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

Serve alert cutouts as a triplet

query Parameters
candid
required
integer

ZTF alert candid

+
get/api/alerts_cutouts/object_id
https://fritz.science/api/alerts_cutouts/object_id

Response samples

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

Serve alert cutouts as a triplet

query Parameters
candid
required
integer

ZTF alert candid

normalizeImage
boolean

Responses

200

retrieved aux data

400

retrieval failed

get/api/alerts_triplets/object_id
https://fritz.science/api/alerts_triplets/object_id

Response samples

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

kowalski

Retrieve an object from Kowalski by objectId

Retrieve an object from Kowalski by objectId

@@ -3585,7 +3585,7 @@

Pagination

cmap
string
Enum: "bone" "gray" "cividis" "viridis" "magma"

Color map to use when rendering png

Responses

200

retrieved cutout

400

retrieval failed

-
get/api/alerts_cutouts/object_id
https://fritz.science/api/alerts_cutouts/object_id

Response samples

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

Serve alert cutouts as a triplet

query Parameters
candid
required
integer

ZTF alert candid

+
get/api/alerts_cutouts/object_id
https://fritz.science/api/alerts_cutouts/object_id

Response samples

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

Serve alert cutouts as a triplet

query Parameters
candid
required
integer

ZTF alert candid

normalizeImage
boolean

Responses

200

retrieved aux data

400

retrieval failed

get/api/alerts_triplets/object_id
https://fritz.science/api/alerts_triplets/object_id

Response samples

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

Retrieve archival light curve data from Kowalski/Gloria by position

path Parameters
lc_id
required
string
query Parameters
catalog
required
str
ra
float

RA in degrees

@@ -3649,7 +3649,7 @@

Pagination

radius_units
string

Distance units (either "deg", "arcmin", or "arcsec"). Default is arcsec

Responses

200
400
post/api/archive/features
https://fritz.science/api/archive/features

Response samples

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