API docs by Redocly

VDEM REST API (v1)

Download OpenAPI specification:Download

Customer Support: support@greenstream.com

Version 1 of the VDEM REST API. The API provides read access to VDEM community instance resources and messages.

Get endpoint list (base path)

Returns a welcome message and a list of VDEM API endpoints. A valid access key must be provided in the header of the request.

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
{
  • "message": "Welcome to the VDEM API",
  • "version": "1.0.0",
  • "status": "OK",
  • "timestamp": "2025-05-02T13:23:08.545286Z",
  • "endpoints": [
    ]
}

Get user account profile.

Returns a user account profile. The request will only return information for the user account associated with the access key. A valid access key must be provided in the header of the request.

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
{
  • "address": {
    },
  • "phone": "string",
  • "lastUpdate": 0,
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "id": "string",
  • "abbreviation": "string",
  • "email": "string",
  • "URL": "string",
  • "createDate": 0
}

Get customer account profile.

Returns a customer profile. The request will only return information for the customer account associated with the access key. A valid access key must be provided in the header of the request.

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
{
  • "entityType": "CUSTOMER",
  • "visible": true,
  • "dates": {
    },
  • "address": {
    },
  • "url": "https://meraklabs.co",
  • "email": "",
  • "display_name": "Merak Labs",
  • "active": true,
  • "base_name": "Merak Labs",
  • "description": "Merak Labs",
  • "phone": "",
  • "type": "commercial"
}

Get list of device profiles.

Returns a list of device profiles. The list contains devices assigned to your customer account. A valid access key must be provided in the header of the request.

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
{
  • "modelID": "",
  • "model": "Corbo 12 Iridium",
  • "entityType": "DEVICE",
  • "configuration": {
    },
  • "dates": {
    },
  • "status": "online",
  • "attributes": { },
  • "name": "Corbo 12 Iridium",
  • "make": "Green Stream Technologies Inc",
  • "sensors": {
    },
  • "parts": {
    },
  • "commands": {
    },
  • "description": "Corbo 12 Gateway with Iridium wireless communications",
  • "serialNumber": "",
  • "type": "Iridium Gateway",
  • "id": "b7eb4993-fd92-41a3-86c8-e6c55f28ab3a"
}

Get messages for subscribed sites.

Returns an list of messages for assigned sites. The API takes two query parameters, start and end. Both parameters are date values that are in Epoch time format. A valid access key must be provided in the header of the request.

query Parameters
start
required
integer <int64>
Example: start=1745341349

Start time in epoch format

end
required
integer <int64>
Example: end=1745345000

End time in epoch format

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the last (x) message for subscribed sites.

Returns the last (x) messages for assigned sites. The API takes one query parameter, limit. The parameters specifies the number of messages to return for each site. A valid access key must be provided in the header of the request.

query Parameters
limit
required
integer >= 1
Example: limit=10

Number of messages to return

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of VDEM reference data endpoints.

Returns a list of reference endpoints. A valid access key must be provided in the header of the request.

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
{
  • "message": "Welcome to the VDEM Reference API",
  • "version": "1.0.0",
  • "status": "OK",
  • "timestamp": "2025-05-02T15:39:40.059280Z",
  • "endpoints": [
    ]
}

Get a list of VDEM places.

Returns a list of VDEM geographic locations to include cities, counties and VDEM regions. A valid access key must be provided in the header of the request.

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
{
  • "SITE": {
    },
  • "CITY": {
    },
  • "COUNTY": {
    },
  • "VDEM_REGION": {
    }
}

Get a site profile.

Returns a site profile. The API takes a single query parameter, id. The id corresponds to a sites uinique id and is obtained by calling the /sites API. A valid access key must be provided in the header of the request.

query Parameters
id
required
string
Example: id=bda75fd3-a685-4340-bbe8-d748b15fe084

The unique identifier of the site

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
{
  • "msg": {
    },
  • "address": {
    },
  • "filters": {
    },
  • "lastUpdate": "2025-04-04T20:04:45+0000",
  • "name": "Dismal Creek at Pilgrim's Knob",
  • "enabled": false,
  • "active": false,
  • "createDate": "2025-04-04T20:04:45+0000",
  • "parameters": [
    ],
  • "comms": {
    },
  • "description": "",
  • "geometry": {
    },
  • "id": "4a30e4c2-a8d1-4500-bdf9-68c52fda7860",
  • "device": null
}

Get messages for a site.

Returns messages for a site. The API takes two query parameters, start and end. Both parameters are date values that are in Epoch time format. A valid access key must be provided in the header of the request.

query Parameters
start
required
integer <int64>
Example: start=1745341349

Start time in epoch format

end
required
integer <int64>
Example: end=1745345000

End time in epoch format

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of sites.

Returns a list of assigned sites. A valid access key must be provided in the header of the request.

header Parameters
x-api-key
required
string
Example: 06a713ec-cb37-455f-8966-ca814bded57b

The access key provided by Green Stream. A new access key can provided upon request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]