Notecard API
This API reference contains an alphabetical overview of all Notecard API requests. Each API listing includes the arguments available for each request, what each request returns, as well as examples of how to perform the request on a Notecard in host firmware.
Request Badges
Each request includes a series of badges that indicate which types of Notecards support the request.
-
Cell indicates a request can be performed on all versions of Notecard Cellular.
-
Cell+WiFi indicates a request can be performed on all versions of Notecard Cell+WiFi.
-
LoRa indicates a request can be performed on Notecard for LoRa.
-
Skylo indicates a request can be performed on Notecard for Skylo.
-
WiFi indicates a request can be performed on all versions of Notecard WiFi.
Request Listing
card Requests
Configure device behavior, read GPS and accelerometer data, and query Notecard state, network, and peripherals.
dfu Requests
Host firmware update requests used, in concert with Notehub, to update the firmware of a host MCU.
env Requests
Read and work with environment variables.
file Requests
Work with all types of Notefiles, including changing, deleting, and querying their contents.
hub Requests
Configure and monitor the connection between Notecard and Notehub.
note Requests
Create and manage the Notes stored inside Notefiles.
ntn Requests
Interface with a paired Starnote device for NTN (satellite) communications.
var Requests
A simple interface for managing data stored in DB Notefiles.
web Requests
Perform requests against third-party APIs and services directly from Notecard.
