Firmware V3 API Documentation

REST API Overview

Firmware V3 provides a comprehensive REST API. All endpoints return JSON. Base URL: http://192.168.4.1/api/

Authentication: Connection to the RadioDoge WiFi network is required.

Broadcast Dogecoin Transaction

Endpoint: POST /api/broadcast

Broadcast a Dogecoin transaction to the entire RadioDoge network. No internet required on your device.

curl -X POST "http://192.168.4.1/api/broadcast" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "type=transaction&priority=normal&message=0100000001..."

Parameters:

  • type: transaction (required)
  • priority: normal, high, or urgent (optional)
  • message: Signed Dogecoin transaction hex (required)

Broadcast General Message

curl -X POST "http://192.168.4.1/api/broadcast" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "type=announcement&priority=normal&message=Network update"

Communication API

Send Direct Message

Endpoint: POST /api/message

  • address: Target address (e.g., "10.1.2")
  • type: text, data, or command
  • text: Message content

Send Direct Transaction (LoRa)

Endpoint: POST /api/transaction

  • address: Target address
  • type: signed, raw, or utxo
  • data: Transaction hex string

Send to Internet Gateway

Endpoint: POST /api/transaction/send

  • transaction: Signed transaction hex string

Ping

Endpoint: GET /api/ping or POST /api/ping

Parameters: region, community, node (0–255 each); optional broadcast=1

Device Status & Configuration

EndpointMethodDescription
/api/statusGETDevice status and configuration
/api/addressGET/POSTGet or set LoRa address (region, community, node)
/api/wifiGETWiFi status
/api/wifi/connectPOSTConnect to internet WiFi (ssid, password)
/api/wifi/disconnectPOSTDisconnect from WiFi
/api/wifi/clearPOSTClear stored WiFi credentials

Password Management

EndpointMethodDescription
/api/password/changePOSTChange AP password (8–32 chars, letters + numbers)
/api/password/resetPOSTReset password to default
/api/password/statusGETPassword status

Gateway Management

EndpointMethodDescription
/api/gateway/statusGETGateway configuration and status
/api/gateway/savePOSTSave gateway (type, ip, port, username, password, endpoint)
/api/gateway/configGET/POSTGet or set gateway config
/api/gateway/testPOSTTest gateway connection
/api/gateway/clearPOSTClear gateway config
/api/gateway/debugGETGateway debug info
/api/gateway/loadGETLoad gateway config

Gateway type: core, dogebox, wallet, or custom.

JSON-RPC

Endpoint: POST /api/jsonrpc

Send JSON-RPC requests to Dogecoin Core nodes. Parameters: transaction, url, rpcuser, rpcpass.


For full request/response examples and additional endpoints, refer to the RadioDoge repository.

On this page