---
title: ntn Requests - API Reference
description: Use a compatible Notecard to interface with a paired Starnote device for NTN (satellite) communications.
source_url: https://dev.blues.io/api-reference/notecard-api/ntn-requests/latest/
canonical_url: https://dev.blues.io/api-reference/notecard-api/ntn-requests/latest/
markdown_url: https://dev.blues.io/api-reference/notecard-api/ntn-requests/latest.md
---

# ntn Requests

Use a compatible Notecard to interface with a paired Starnote device for [NTN](https://dev.blues.io/api-reference/glossary.md#ntn-non-terrestrial-networks) (satellite) communications.

## ntn.gps

Supported on

(Cell, Cell+WiFi, Skylo, WiFi)

On a Notecard paired with a Starnote, this controls whether the Starnote uses a location known to the paired Notecard instead of acquiring one with its own GPS/GNSS module. It does not, by default.

On Notecard for Skylo, the satellite radio and the GPS/GNSS are part of the same module. This request controls whether the Notecard uses a known location (typically a fixed location set with `card.location.mode`), instead of acquiring a new location for NTN use.

Arguments

### `off`

*boolean (optional)*

When `true`, the Notecard does not supply its location to the NTN module. This is the default configuration.

### `on`

*boolean (optional)*

When `true`, the Notecard supplies its location to the NTN module. If the Notecard does not yet know its location, none is supplied, and this setting has no effect until a location becomes available.

**Enable Notecard GPS Override**

**JSON**

```json
{
  "req": "ntn.gps",
  "on": true
}
```

**C/C++**

```cpp
J *req = NoteNewRequest("ntn.gps");
JAddBoolToObject(req, "on", true);

NoteRequest(req);
```

**Python**

```python
req = {"req": "ntn.gps"}
req["on"] = True
rsp = card.Transaction(req)
```

Configure the Notecard to supply the location it already knows to the NTN module.

**Do Not Supply the Notecard's Location**

**JSON**

```json
{
  "req": "ntn.gps",
  "off": true
}
```

**C/C++**

```cpp
J *req = NoteNewRequest("ntn.gps");
JAddBoolToObject(req, "off", true);

NoteRequest(req);
```

**Python**

```python
req = {"req": "ntn.gps"}
req["off"] = True
rsp = card.Transaction(req)
```

Configure the Notecard to not supply its location to the NTN module (default).

**Query Current GPS Configuration**

**JSON**

```json
{
  "req": "ntn.gps"
}
```

**C/C++**

```cpp
J *req = NoteNewRequest("ntn.gps");

NoteRequest(req);
```

**Python**

```python
req = {"req": "ntn.gps"}
rsp = card.Transaction(req)
```

Request current GPS/GNSS location configuration.

**Response Members**

### `off`

*boolean*

Returned and `true` if a paired Starnote will use its own GPS/GNSS location.

### `on`

*boolean*

Returned and `true` if a Starnote will use the GPS/GNSS location from its paired Notecard.

Example Response

```json
{
  "off": true
}
```

Response indicating Starnote is using its own GPS/GNSS location (default).

```json
{
  "on": true
}
```

Response indicating Starnote is using paired Notecard's GPS/GNSS location.

## ntn.reset

Supported on

(Cell, Cell+WiFi, Skylo, WiFi)

Once a Notecard is connected to a Starnote device, the presence of a physical Starnote is stored in a permanent configuration that is not affected by a `card.restore` request. This request clears the existing NTN configuration, allowing you to return to testing NTN mode over cellular or WiFi, and [enables the Starnote to be paired with a different Notecard device](https://dev.blues.io/starnote/satellite-best-practices.md#pairing-starnote-with-a-different-notecard).

Arguments

None

**Example**

**JSON**

```json
{
  "req": "ntn.reset"
}
```

**C/C++**

```cpp
J *req = NoteNewRequest("ntn.reset");

NoteRequest(req);
```

**Python**

```python
req = {"req": "ntn.reset"}
rsp = card.Transaction(req)
```

Clear Starnote configuration to return to testing NTN mode over cellular or WiFi.

**Response Members**

None: an empty object `{}` means success.

## ntn.status

Supported on

(Cell, Cell+WiFi, WiFi)

Displays the current status of a Notecard's connection to a paired Starnote.

Arguments

None

**Example**

**JSON**

```json
{
  "req": "ntn.status"
}
```

**C/C++**

```cpp
J *req = NoteNewRequest("ntn.status");

NoteRequest(req);
```

**Python**

```python
req = {"req": "ntn.status"}
rsp = card.Transaction(req)
```

Request current status of Notecard's connection to paired Starnote.

**Response Members**

### `err`

*string*

This member is present if any errors have occurred while connecting to a paired Starnote, for example: `{"err":"no NTN module is connected {no-ntn-module}"}`

### `status`

*string*

Details about a Notecard's connection to a paired Starnote, for example: `{"status":"{ntn-idle}{ntn-unknown-location}"}`

Example Response

```json
{
  "status": "{ntn-idle}"
}
```

Response showing Starnote connection in idle state.

```json
{
  "err": "no NTN module is connected {no-ntn-module}"
}
```

Response showing error when no NTN module is connected.

```json
{
  "status": "{ntn-idle}{ntn-unknown-location}"
}
```

Response showing detailed status including location information.

[note Requests](https://dev.blues.io/api-reference/notecard-api/note-requests.md "note Requests") [var Requests](https://dev.blues.io/api-reference/notecard-api/var-requests.md "var Requests")