Skip to main content
GET
Get contracts for a SiteId

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

site-id
string
required

Site identifier provided by Datanumia

Query Parameters

fluid
enum<string>
required

Type of energy covered by the contract: electricity or gas.

Available options:
elec,
gas
beginTs
string<date-time>

Start timestamp for the requested period.

The supported format is as defined by RFC 3339, section 5.6 restricted to : full-date'T'partial-time'Z'.

Default : customer history limit

endTs
string<date-time>

End timestamp for the requested.

The supported format is as defined by RFC 3339, section 5.6 restricted to : full-date'T'partial-time'Z'.

Default : now.

Response

OK - Returns the requested list of contracts for the site-id

contracts
object[]