Comet List API

Version: 1.1 (2023 March 07)

Comet List API provides a method of requesting machine-readable data for a set of comet object within the COBS database.

HTTP Request

Example Queries

https://cobs.si/api/comet_list.api?type=C&page=1
https://cobs.si/api/comet_list.api?type=P&is-observed=1&page=1

Query Parameters

All parameters are optional. If non are specified the list of all comets will be returned by the query.

Data Output

Please always check the JSON payload “signature” object for the API “version”. If the version does not match the version in this document (at the top), there is no guarantee that the format has not changed.
Example "signature" object with "version" value "1.1": "signature":{"version":"1.1","source":"COBS ... API"}

Normal Data Payload

This output is the result of specifying a unique object.
The following example query https://cobs.si/api/comet_list.api?type=M&page=1 returns the following payload containing data sections objects.

{
  "info": {
    "page": 1
    "pages": 1
    "start": 1
    "end": 4 
    "length": 5000 
    "recordsTotal": 4
  },
  "objects": [
    {
      "id": 1062,
      "type": "M",
      "name": "2001 HT5",
      "fullname": "2001 HT5 (45277)",
      "icq_name": "2001HT5",
      "component": null,
      "is_observed": false,
      "is_active": true
    },
    {
      "id": 1063,
      "type": "M",
      "name": "2001 OG1",
      "fullname": "2001 OG1 (139403)",
      "icq_name": "2001OG1",
      "component": null,
      "is_observed": false,
      "is_active": true
    },
    {
      "id": 1065,
      "type": "M",
      "name": "2003 KV",
      "fullname": "2003 KV (136118)",
      "icq_name": "2003KV",
      "component": null,
      "is_observed": false,
      "is_active": true
    },
    {
      "id": 1713,
      "type": "M",
      "name": "3200",
      "fullname": "3200 Phaethon",
      "icq_name": "MB003200",
      "component": null,
      "is_observed": true,
      "is_active": true
    }
  ],
  "signature": {
    "source": "COBS Query API",
    "version": "1.2",
    "date": "2023 March"
  }
}

Sections Output

The following sections are available for output. The detailed structure of the contents within each section are described in corresponding document sections below.

Structure of Sections

The following shows the JSON structure of a normal data payload containing all possible sections. The detailed structure of the contents within each section are described in corresponding document sections below.

{
  "info": {
    query info fields ...
  },
  "object": {
    object fields ...
  },
  "signature": {
    signature fields ...
  },
}

Query Info Section

General information about the API query.

The following fields are provided in the general information section:

Objects Data Section

The objects data section contains an array of comets from the COBS database.

The following fields are provided in the objects section:

Object subsection: alias

If alternate designations are requested (alt-des=1), the field “alias” will contain an array of alternate designations, or an emtpy array if no alternates are available. Each element in the array contains more key/value pair where the keys are the following:

For example, here is the “alias” content for numbered comet 249P/LINEAR:

[
  {"id": 413, "name": "P/2006 U1", "fullname": "P/2006 U1 (LINEAR)"},
  {"id": 416, "name": "P/2011 A4", "fullname": "P/2011 A4 (LINEAR)"}
]

HTTP Response Codes

All errors are returned via appropriate HTTP response codes.

Change Log

Version 1.1 (2023 March)

Queries are paginated with max 5000 items.

Version 1.0 (2022 February)

Initial release