### API Root Response Example

Source: https://db.satnogs.org/api?format=api

This is an example of a successful HTTP 200 OK response from the API root. It includes headers and a JSON body listing available data endpoints.

```http
**HTTP 200 OK**
**Allow:** GET, HEAD, OPTIONS
**Content-Type:** application/json
**Vary:** Accept
```

```json
{
    "artifacts": "https://db.satnogs.org/api/artifacts/?format=api",
    "modes": "https://db.satnogs.org/api/modes/?format=api",
    "satellites": "https://db.satnogs.org/api/satellites/?format=api",
    "transmitters": "https://db.satnogs.org/api/transmitters/?format=api",
    "telemetry": "https://db.satnogs.org/api/telemetry/?format=api",
    "tle": "https://db.satnogs.org/api/tle/?format=api",
    "optical-observations": "https://db.satnogs.org/api/optical-observations/?format=api"
}
```

--------------------------------

### List Artifacts Endpoint

Source: https://db.satnogs.org/api/artifacts

This is the endpoint for listing all artifacts. It supports the GET method and returns JSON.

```http
**GET** /api/artifacts/

```

--------------------------------

### Retrieve Artifacts (API)

Source: https://db.satnogs.org/api/artifacts?format=api

Use this GET request to retrieve artifacts in API format. Ensure proper authentication is provided.

```http
**GET** /api/artifacts/?format=api
```

--------------------------------

### Example TLE Set Data

Source: https://db.satnogs.org/api/tle?format=api

This snippet shows the structure of a single TLE set entry returned by the API. It includes detailed orbital information and satellite identifiers.

```json
{
        "tle1": "1 42954U 17060A   26137.85451249  .00000239  00000-0  37119-4 0  9994",
        "tle2": "2 42954  97.6534 176.9447 0016512 194.0270 166.0487 14.81138341463960",
        "tle_source": "Space-Track.org",
        "sat_id": "VNEH-2036-0013-1591-2048",
        "norad_cat_id": 42954,
        "updated": "2026-05-18T01:24:15.847446+0000"
    }
```

```json
{
        "tle0": "0 ZHUHAI-1 03B",
        "tle1": "1 44536U 19060C   26137.83861120  .00020356  00000-0  33537-3 0  9996",
        "tle2": "2 44536  97.5501 294.0145 0009466  73.9941 286.2353 15.52308078371610",
        "tle_source": "Space-Track.org",
        "sat_id": "ZCOY-2513-5525-7733-9938",
        "norad_cat_id": 44536,
        "updated": "2026-05-18T01:24:15.891541+0000"
    }
```

```json
{
        "tle0": "0 HINODE (SOLAR B)",
        "tle1": "1 29479U 06041A   26137.79810235  .00000385  00000-0  74628-4 0  9993",
        "tle2": "2 29479  98.0561 154.3983 0018113  29.1199 331.1013 14.68574605 50418",
        "tle_source": "Space-Track.org",
        "sat_id": "GUVU-5628-7211-7591-2238",
        "norad_cat_id": 29479,
        "updated": "2026-05-18T01:24:15.913853+0000"
    }
```

```json
{
        "tle0": "0 ZINYUAN-3",
        "tle1": "1 45939U 20051A   26137.86368204  .00002626  00000-0  11965-3 0  9995",
        "tle2": "2 45939  97.2850 206.5660 0006949  64.2834 295.9119 15.21501508322734",
        "tle_source": "Space-Track.org",
        "sat_id": "QFDI-7012-5975-9015-5255",
        "norad_cat_id": 45939,
        "updated": "2026-05-18T01:24:15.924841+0000"
    }
```

```json
{
        "tle0": "0 YAOGAN 12",
        "tle1": "1 37875U 11066B   26137.84756212  .00004624  00000-0  18133-3 0  9993",
        "tle2": "2 37875  97.1166 177.8472 0009012 344.2610  15.8348 15.26181874807412",
        "tle_source": "Space-Track.org",
        "sat_id": "YUDM-3653-3969-7673-7871",
        "norad_cat_id": 37875,
        "updated": "2026-05-17T23:24:01.115451+0000"
    }
```

```json
{
        "tle0": "0 LKW-4",
        "tle1": "1 43236U 18025A   26137.75823422  .00027249  00000-0  34061-3 0  9997",
        "tle2": "2 43236  97.6331 306.3114 0002963  73.3795 286.7785 15.59806835455288",
        "tle_source": "Space-Track.org",
        "sat_id": "JOXI-4911-4673-3061-3606",
        "norad_cat_id": 43236,
        "updated": "2026-05-18T01:24:15.988878+0000"
    }
```

```json
{
        "tle0": "0 SPOT 5",
        "tle1": "1 27421U 02021A   26137.83886249  .00000263  00000-0  65247-4 0  9997",
        "tle2": "2 27421  97.9871 178.0431 0129839  11.5015 348.9100 14.54727458258432",
        "tle_source": "Space-Track.org",
        "sat_id": "EKKE-1628-2117-0194-5233",
        "norad_cat_id": 27421,
        "updated": "2026-05-18T01:24:15.978107+0000"
    }
```

```json
{
        "tle0": "0 CHUANG XIN 1-02(CX-1-02)",
        "tle1": "1 33434U 08056B   26137.86372902  .00000019  00000-0  24337-4 0  9995",
        "tle2": "2 33434  98.6151 164.4300 0013274 226.1098 133.8989 14.30146262914286",
        "tle_source": "Space-Track.org",
        "sat_id": "AJLV-0901-9195-1341-8642",
        "norad_cat_id": 33434,
        "updated": "2026-05-18T01:24:15.967216+0000"
    }
```

```json
{
        "tle0": "0 HAIYANG 2B",
        "tle1": "1 43655U 18081A   26137.84181877  .00000049  00000-0  90725-4 0  9994",
        "tle2": "2 43655  99.3289 147.0551 0001558  46.9356 313.1926 13.79306753380741",
        "tle_source": "Space-Track.org",
        "sat_id": "XKAV-8568-9227-4065-8826",
        "norad_cat_id": 43655,
        "updated": "2026-05-18T01:24:15.957094+0000"
    }
```

```json
{
        "tle0": "0 SHIJIAN 6 03B (SJ-6 03B)",
        "tle1": "1 33409U 08053B   26137.83351200  .00000579  00000-0  46201-4 0  9994",
        "tle2": "2 33409  97.8592 157.2231 0020657 138.5892 221.6903 15.04214574958185",
        "tle_source": "Space-Track.org",
        "sat_id": "VBJF-5677-4529-8435-7222",
        "norad_cat_id": 33409,
        "updated": "2026-05-17T23:24:01.083533+0000"
    }
```

```json
{
        "tle0": "0 KOMPSAT 5",
        "tle1": "1 39227U 13042A   26137.83824413  .00000827  00000-0  63451-4 0  9995",
        "tle2": "2 39227  97.6209 324.9657 0002078 209.3787 150.7323 15.04494757699299",
        "tle_source": "Space-Track.org",
        "sat_id": "HDFJ-7121-8844-1224-4505",
        "norad_cat_id": 39227,
        "updated": "2026-05-17T23:24:01.075504+0000"
    }
```

```json
{
        "tle0": "0 SHIJIAN 6 02B (SJ-6 02B)",
        "tle1": "1 29506U 06046B   26137.88770110  .00001372  00000-0  11129-3 0  9999",
        "tle2": "2 29506  97.7157 167.1337 0012089 156.3255 203.8527 15.01285739 66195",
        "tle_source": "Space-Track.org",
        "sat_id": "GIOA-1239-3078-9381-1628",
        "norad_cat_id": 29506,
        "updated": "2026-05-18T01:24:15.934979+0000"
    }
```

```json
{
        "tle0": "0 AFR-1",
        "tle1": "1 56964U 23084AJ  26137.85462071  .00003260  00000-0  12102-3 0  9999",
        "tle2": "2 56964  97.6234 273.8300 0012048  87.3364 272.9254 15.28270497162591",
        "tle_source": "Space-Track.org",
        "sat_id": "AFR1-1234-5678-9012-3456",
        "norad_cat_id": 56964,
        "updated": "2026-05-18T01:24:15.999999+0000"
    }
```

--------------------------------

### GET Request for API Root

Source: https://db.satnogs.org/api?format=api

Use this GET request to access the root of the SatNOGS API. The `format=api` parameter ensures the response is in the API format.

```http
**GET** /api/?format=api
```

--------------------------------

### Get Artifact List

Source: https://db.satnogs.org/api/artifacts?format=api

Retrieves a list of artifacts from the DB SatNOGS API. Requires authentication.

```APIDOC
## GET /api/artifacts/?format=api

### Description
Retrieves a list of artifacts in API format.

### Method
GET

### Endpoint
/api/artifacts/

### Query Parameters
- **format** (string) - Required - Specifies the output format, should be 'api'.

### Response
#### Success Response (200)
- **Content-Type**: application/json
- **Vary**: Accept

#### Response Example
```json
{
    "detail": "Authentication credentials were not provided."
}
```

### Error Handling
#### HTTP 401 Unauthorized
- **Allow**: GET, POST, HEAD, OPTIONS
- **Content-Type**: application/json
- **Vary**: Accept
- **WWW-Authenticate**: Token

```json
{
    "detail": "Authentication credentials were not provided."
}
```
```

--------------------------------

### GET /api/tle/

Source: https://db.satnogs.org/api/tle

Retrieves a list of the most recent two-line element (TLE) sets for satellites.

```APIDOC
## GET /api/tle/

### Description
Retrieves a list of the most recent two-line element (TLE) sets for satellites.

### Method
GET

### Endpoint
/api/tle/

### Response
#### Success Response (200)
- **tle0** (string) - The TLE line 0, typically containing the satellite name.
- **tle1** (string) - The TLE line 1, containing orbital elements.
- **tle2** (string) - The TLE line 2, containing orbital elements.
- **tle_source** (string) - The source of the TLE data.
- **sat_id** (string) - A unique identifier for the satellite.
- **norad_cat_id** (integer) - The NORAD catalog ID for the satellite.
- **updated** (string) - The timestamp when the TLE data was last updated.

### Response Example
```json
[
    {
        "tle0": "0 ISS (ZARYA)",
        "tle1": "1 25544U 98067A   26137.87541122  .00005144  00000-0  10059-3 0  9991",
        "tle2": "2 25544  51.6321  90.1533 0007579  69.9393 290.2410 15.49247594567059",
        "tle_source": "Space-Track.org",
        "sat_id": "XSKZ-5603-1870-9019-3066",
        "norad_cat_id": 25544,
        "updated": "2026-05-18T01:23:54.336971+0000"
    }
]
```
```

--------------------------------

### List Artifacts

Source: https://db.satnogs.org/api/artifacts

Retrieves a list of all available artifacts. Requires authentication.

```APIDOC
## GET /api/artifacts/

### Description
Retrieves a list of all available artifacts. This endpoint is used to fetch a collection of artifact resources.

### Method
GET

### Endpoint
/api/artifacts/

### Response
#### Success Response (200)
- **artifacts** (array) - A list of artifact objects.

#### Error Response (401 Unauthorized)
- **detail** (string) - Indicates that authentication credentials were not provided.

```json
{
    "detail": "Authentication credentials were not provided."
}
```
```

--------------------------------

### List Optical Observations

Source: https://db.satnogs.org/api/optical-observations

Use this endpoint to retrieve a list of optical observations. Requires authentication.

```http
**GET** /api/optical-observations/
```

--------------------------------

### GET Telemetry List Endpoint

Source: https://db.satnogs.org/api/telemetry

This is the endpoint for retrieving a list of telemetry data. It requires authentication.

```http
**GET** /api/telemetry/

```

--------------------------------

### Get Telemetry List

Source: https://db.satnogs.org/api/telemetry?format=browse-json-ld

Retrieves a list of telemetry data in JSON-LD format. Requires authentication.

```APIDOC
## GET /api/telemetry/?format=browse-json-ld

### Description
Retrieves a list of telemetry data in JSON-LD format. Requires authentication.

### Method
GET

### Endpoint
/api/telemetry/?format=browse-json-ld

### Response
#### Success Response (200)
- **data** (object) - Contains telemetry information.

#### Response Example
```json
{
    "@context": "http://schema.org",
    "@type": "Observation",
    "@id": "/api/v0.1/stations/00000/observations/12345/",
    "observer": "/api/v0.1/users/123/",
    "creation_timestamp": "2023-01-01T12:00:00Z",
    "creation_date": "2023-01-01",
    "station": {
        "@type": "SatelliteSite",
        "@id": "/api/v0.1/stations/00000/"
    },
    "instruments": [
        {
            "@type": "Instrument",
            "@id": "/api/v0.1/stations/00000/instruments/123/"
        }
    ],
    "groundstation": {
        "@type": "SatelliteSite",
        "@id": "/api/v0.1/stations/00000/"
    },
    "norad_cat_id": 12345,
    "launch_timestamp": "2023-01-01T12:00:00Z",
    "launch_date": "2023-01-01",
    "tle": {
        "@type": "Orbit",
        "line1": "1 12345U 23001A   23001.50000000  .00000000  00000-0  00000-0 0  9999",
        "line2": "2 12345  51.6370 100.0000 12345  60.0000 300.0000 15.49000000000000"
    }
}
```

#### Error Response (401 Unauthorized)
```json
{
    "detail": "Authentication credentials were not provided."
}
```
```

--------------------------------

### List Optical Observations

Source: https://db.satnogs.org/api/optical-observations?format=api

Retrieves a list of optical observations. Authentication is required.

```APIDOC
## GET /api/optical-observations/?format=api

### Description
Retrieves a list of optical observations.

### Method
GET

### Endpoint
/api/optical-observations/

### Query Parameters
- **format** (string) - Required - Specifies the output format, 'api' for this endpoint.

### Response
#### Success Response (200)
- **detail** (string) - Description of the successful response (if any, not detailed in source).

#### Error Response (401 Unauthorized)
- **detail** (string) - "Authentication credentials were not provided."
```