eiagov-typescript-fetch-client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +73 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/apis/AEOApi.ts +415 -0
- package/apis/COALApi.ts +3645 -0
- package/apis/CRUDIMPORTSApi.ts +322 -0
- package/apis/DBFApi.ts +2260 -0
- package/apis/ELECApi.ts +1180 -0
- package/apis/EMISSApi.ts +640 -0
- package/apis/IEOApi.ts +415 -0
- package/apis/INTLApi.ts +322 -0
- package/apis/NGApi.ts +511 -0
- package/apis/NUCSTATUSApi.ts +910 -0
- package/apis/RTOApi.ts +2260 -0
- package/apis/RootApi.ts +66 -0
- package/apis/SEDSApi.ts +322 -0
- package/apis/SEPApi.ts +1990 -0
- package/apis/STEOApi.ts +322 -0
- package/apis/TOTALApi.ts +322 -0
- package/apis/index.ts +18 -0
- package/docs/AEOApi.md +456 -0
- package/docs/COALApi.md +4847 -0
- package/docs/CRUDIMPORTSApi.md +371 -0
- package/docs/DBFApi.md +2976 -0
- package/docs/DataParams.md +48 -0
- package/docs/DataResponse.md +42 -0
- package/docs/DataResponseContainer.md +38 -0
- package/docs/ELECApi.md +1524 -0
- package/docs/EMISSApi.md +798 -0
- package/docs/Facet.md +38 -0
- package/docs/FacetDetails.md +36 -0
- package/docs/FacetDetailsContainer.md +38 -0
- package/docs/FacetMetaData.md +36 -0
- package/docs/FacetOptionList.md +36 -0
- package/docs/FacetOptionListContainer.md +38 -0
- package/docs/FinalRoute.md +52 -0
- package/docs/FinalRouteResponse.md +36 -0
- package/docs/FinalRouteResponseContainer.md +38 -0
- package/docs/Frequency.md +40 -0
- package/docs/IEOApi.md +456 -0
- package/docs/INTLApi.md +371 -0
- package/docs/NGApi.md +541 -0
- package/docs/NUCSTATUSApi.md +1161 -0
- package/docs/RTOApi.md +2976 -0
- package/docs/RootApi.md +70 -0
- package/docs/RouteRequest.md +36 -0
- package/docs/RouteResponse.md +36 -0
- package/docs/RouteResponseContainer.md +38 -0
- package/docs/Routes.md +40 -0
- package/docs/SEDSApi.md +372 -0
- package/docs/SEPApi.md +2613 -0
- package/docs/STEOApi.md +371 -0
- package/docs/Sort.md +36 -0
- package/docs/TOTALApi.md +371 -0
- package/index.ts +5 -0
- package/models/DataParams.ts +129 -0
- package/models/DataResponse.ts +97 -0
- package/models/DataResponseContainer.ts +96 -0
- package/models/Facet.ts +81 -0
- package/models/FacetDetails.ts +81 -0
- package/models/FacetDetailsContainer.ts +96 -0
- package/models/FacetMetaData.ts +73 -0
- package/models/FacetOptionList.ts +73 -0
- package/models/FacetOptionListContainer.ts +96 -0
- package/models/FinalRoute.ts +152 -0
- package/models/FinalRouteResponse.ts +88 -0
- package/models/FinalRouteResponseContainer.ts +96 -0
- package/models/Frequency.ts +89 -0
- package/models/RouteRequest.ts +73 -0
- package/models/RouteResponse.ts +88 -0
- package/models/RouteResponseContainer.ts +96 -0
- package/models/Routes.ts +89 -0
- package/models/Sort.ts +73 -0
- package/models/index.ts +20 -0
- package/package.json +15 -0
- package/runtime.ts +449 -0
package/docs/SEPApi.md
ADDED
|
@@ -0,0 +1,2613 @@
|
|
|
1
|
+
# SEPApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.eia.gov*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**v2ElectricitySepGet**](SEPApi.md#v2electricitysepget) | **GET** /v2/electricity/sep | Class SEPController |
|
|
8
|
+
| [**v2ElectricityStateElectricityProfilesCapabilityDataGet**](SEPApi.md#v2electricitystateelectricityprofilescapabilitydataget) | **GET** /v2/electricity/state-electricity-profiles/capability/data | |
|
|
9
|
+
| [**v2ElectricityStateElectricityProfilesCapabilityDataPost**](SEPApi.md#v2electricitystateelectricityprofilescapabilitydatapost) | **POST** /v2/electricity/state-electricity-profiles/capability/data | Class CapabilityDataController |
|
|
10
|
+
| [**v2ElectricityStateElectricityProfilesCapabilityFacetFacetIdGet**](SEPApi.md#v2electricitystateelectricityprofilescapabilityfacetfacetidget) | **GET** /v2/electricity/state-electricity-profiles/capability/facet/{facet_id} | |
|
|
11
|
+
| [**v2ElectricityStateElectricityProfilesCapabilityFacetGet**](SEPApi.md#v2electricitystateelectricityprofilescapabilityfacetget) | **GET** /v2/electricity/state-electricity-profiles/capability/facet | |
|
|
12
|
+
| [**v2ElectricityStateElectricityProfilesCapabilityGet**](SEPApi.md#v2electricitystateelectricityprofilescapabilityget) | **GET** /v2/electricity/state-electricity-profiles/capability | |
|
|
13
|
+
| [**v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataGet**](SEPApi.md#v2electricitystateelectricityprofilesemissionsbystatebyfueldataget) | **GET** /v2/electricity/state-electricity-profiles/emissions-by-state-by-fuel/data | |
|
|
14
|
+
| [**v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataPost**](SEPApi.md#v2electricitystateelectricityprofilesemissionsbystatebyfueldatapost) | **POST** /v2/electricity/state-electricity-profiles/emissions-by-state-by-fuel/data | Return sep emissions-by-state-by-fuel Data |
|
|
15
|
+
| [**v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetFacetIdGet**](SEPApi.md#v2electricitystateelectricityprofilesemissionsbystatebyfuelfacetfacetidget) | **GET** /v2/electricity/state-electricity-profiles/emissions-by-state-by-fuel/facet/{facet_id} | |
|
|
16
|
+
| [**v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetGet**](SEPApi.md#v2electricitystateelectricityprofilesemissionsbystatebyfuelfacetget) | **GET** /v2/electricity/state-electricity-profiles/emissions-by-state-by-fuel/facet | |
|
|
17
|
+
| [**v2ElectricityStateElectricityProfilesEmissionsByStateByFuelGet**](SEPApi.md#v2electricitystateelectricityprofilesemissionsbystatebyfuelget) | **GET** /v2/electricity/state-electricity-profiles/emissions-by-state-by-fuel | |
|
|
18
|
+
| [**v2ElectricityStateElectricityProfilesEnergyEfficiencyDataGet**](SEPApi.md#v2electricitystateelectricityprofilesenergyefficiencydataget) | **GET** /v2/electricity/state-electricity-profiles/energy-efficiency/data | |
|
|
19
|
+
| [**v2ElectricityStateElectricityProfilesEnergyEfficiencyDataPost**](SEPApi.md#v2electricitystateelectricityprofilesenergyefficiencydatapost) | **POST** /v2/electricity/state-electricity-profiles/energy-efficiency/data | Return sep energy-effiency Data |
|
|
20
|
+
| [**v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetFacetIdGet**](SEPApi.md#v2electricitystateelectricityprofilesenergyefficiencyfacetfacetidget) | **GET** /v2/electricity/state-electricity-profiles/energy-efficiency/facet/{facet_id} | |
|
|
21
|
+
| [**v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetGet**](SEPApi.md#v2electricitystateelectricityprofilesenergyefficiencyfacetget) | **GET** /v2/electricity/state-electricity-profiles/energy-efficiency/facet | |
|
|
22
|
+
| [**v2ElectricityStateElectricityProfilesEnergyEfficiencyGet**](SEPApi.md#v2electricitystateelectricityprofilesenergyefficiencyget) | **GET** /v2/electricity/state-electricity-profiles/energy-efficiency | |
|
|
23
|
+
| [**v2ElectricityStateElectricityProfilesMetersDataGet**](SEPApi.md#v2electricitystateelectricityprofilesmetersdataget) | **GET** /v2/electricity/state-electricity-profiles/meters/data | |
|
|
24
|
+
| [**v2ElectricityStateElectricityProfilesMetersDataPost**](SEPApi.md#v2electricitystateelectricityprofilesmetersdatapost) | **POST** /v2/electricity/state-electricity-profiles/meters/data | Return sep meters Data |
|
|
25
|
+
| [**v2ElectricityStateElectricityProfilesMetersFacetFacetIdGet**](SEPApi.md#v2electricitystateelectricityprofilesmetersfacetfacetidget) | **GET** /v2/electricity/state-electricity-profiles/meters/facet/{facet_id} | |
|
|
26
|
+
| [**v2ElectricityStateElectricityProfilesMetersFacetGet**](SEPApi.md#v2electricitystateelectricityprofilesmetersfacetget) | **GET** /v2/electricity/state-electricity-profiles/meters/facet | |
|
|
27
|
+
| [**v2ElectricityStateElectricityProfilesMetersGet**](SEPApi.md#v2electricitystateelectricityprofilesmetersget) | **GET** /v2/electricity/state-electricity-profiles/meters | |
|
|
28
|
+
| [**v2ElectricityStateElectricityProfilesNetMeteringDataGet**](SEPApi.md#v2electricitystateelectricityprofilesnetmeteringdataget) | **GET** /v2/electricity/state-electricity-profiles/net-metering/data | |
|
|
29
|
+
| [**v2ElectricityStateElectricityProfilesNetMeteringDataPost**](SEPApi.md#v2electricitystateelectricityprofilesnetmeteringdatapost) | **POST** /v2/electricity/state-electricity-profiles/net-metering/data | Return sep net-metering Data |
|
|
30
|
+
| [**v2ElectricityStateElectricityProfilesNetMeteringFacetFacetIdGet**](SEPApi.md#v2electricitystateelectricityprofilesnetmeteringfacetfacetidget) | **GET** /v2/electricity/state-electricity-profiles/net-metering/facet/{facet_id} | |
|
|
31
|
+
| [**v2ElectricityStateElectricityProfilesNetMeteringFacetGet**](SEPApi.md#v2electricitystateelectricityprofilesnetmeteringfacetget) | **GET** /v2/electricity/state-electricity-profiles/net-metering/facet | |
|
|
32
|
+
| [**v2ElectricityStateElectricityProfilesNetMeteringGet**](SEPApi.md#v2electricitystateelectricityprofilesnetmeteringget) | **GET** /v2/electricity/state-electricity-profiles/net-metering | |
|
|
33
|
+
| [**v2ElectricityStateElectricityProfilesSourceDispositionDataGet**](SEPApi.md#v2electricitystateelectricityprofilessourcedispositiondataget) | **GET** /v2/electricity/state-electricity-profiles/source-disposition/data | |
|
|
34
|
+
| [**v2ElectricityStateElectricityProfilesSourceDispositionDataPost**](SEPApi.md#v2electricitystateelectricityprofilessourcedispositiondatapost) | **POST** /v2/electricity/state-electricity-profiles/source-disposition/data | Return sep source-disposition Data |
|
|
35
|
+
| [**v2ElectricityStateElectricityProfilesSourceDispositionFacetFacetIdGet**](SEPApi.md#v2electricitystateelectricityprofilessourcedispositionfacetfacetidget) | **GET** /v2/electricity/state-electricity-profiles/source-disposition/facet/{facet_id} | |
|
|
36
|
+
| [**v2ElectricityStateElectricityProfilesSourceDispositionFacetGet**](SEPApi.md#v2electricitystateelectricityprofilessourcedispositionfacetget) | **GET** /v2/electricity/state-electricity-profiles/source-disposition/facet | |
|
|
37
|
+
| [**v2ElectricityStateElectricityProfilesSourceDispositionGet**](SEPApi.md#v2electricitystateelectricityprofilessourcedispositionget) | **GET** /v2/electricity/state-electricity-profiles/source-disposition | |
|
|
38
|
+
| [**v2ElectricityStateElectricityProfilesSummaryDataGet**](SEPApi.md#v2electricitystateelectricityprofilessummarydataget) | **GET** /v2/electricity/state-electricity-profiles/summary/data | |
|
|
39
|
+
| [**v2ElectricityStateElectricityProfilesSummaryDataPost**](SEPApi.md#v2electricitystateelectricityprofilessummarydatapost) | **POST** /v2/electricity/state-electricity-profiles/summary/data | Return sep summary Data |
|
|
40
|
+
| [**v2ElectricityStateElectricityProfilesSummaryFacetFacetIdGet**](SEPApi.md#v2electricitystateelectricityprofilessummaryfacetfacetidget) | **GET** /v2/electricity/state-electricity-profiles/summary/facet/{facet_id} | |
|
|
41
|
+
| [**v2ElectricityStateElectricityProfilesSummaryFacetGet**](SEPApi.md#v2electricitystateelectricityprofilessummaryfacetget) | **GET** /v2/electricity/state-electricity-profiles/summary/facet | |
|
|
42
|
+
| [**v2ElectricityStateElectricityProfilesSummaryGet**](SEPApi.md#v2electricitystateelectricityprofilessummaryget) | **GET** /v2/electricity/state-electricity-profiles/summary | |
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
## v2ElectricitySepGet
|
|
47
|
+
|
|
48
|
+
> RouteResponseContainer v2ElectricitySepGet()
|
|
49
|
+
|
|
50
|
+
Class SEPController
|
|
51
|
+
|
|
52
|
+
Nuclear Outages data set top-level controller.
|
|
53
|
+
|
|
54
|
+
### Example
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import {
|
|
58
|
+
Configuration,
|
|
59
|
+
SEPApi,
|
|
60
|
+
} from '';
|
|
61
|
+
import type { V2ElectricitySepGetRequest } from '';
|
|
62
|
+
|
|
63
|
+
async function example() {
|
|
64
|
+
console.log("🚀 Testing SDK...");
|
|
65
|
+
const config = new Configuration({
|
|
66
|
+
// To configure API key authorization: api_key
|
|
67
|
+
apiKey: "YOUR API KEY",
|
|
68
|
+
});
|
|
69
|
+
const api = new SEPApi(config);
|
|
70
|
+
|
|
71
|
+
try {
|
|
72
|
+
const data = await api.v2ElectricitySepGet();
|
|
73
|
+
console.log(data);
|
|
74
|
+
} catch (error) {
|
|
75
|
+
console.error(error);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// Run the test
|
|
80
|
+
example().catch(console.error);
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
This endpoint does not need any parameter.
|
|
86
|
+
|
|
87
|
+
### Return type
|
|
88
|
+
|
|
89
|
+
[**RouteResponseContainer**](RouteResponseContainer.md)
|
|
90
|
+
|
|
91
|
+
### Authorization
|
|
92
|
+
|
|
93
|
+
[api_key](../README.md#api_key)
|
|
94
|
+
|
|
95
|
+
### HTTP request headers
|
|
96
|
+
|
|
97
|
+
- **Content-Type**: Not defined
|
|
98
|
+
- **Accept**: `application/json`
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### HTTP response details
|
|
102
|
+
| Status code | Description | Response headers |
|
|
103
|
+
|-------------|-------------|------------------|
|
|
104
|
+
| **200** | List of API data sets | - |
|
|
105
|
+
|
|
106
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## v2ElectricityStateElectricityProfilesCapabilityDataGet
|
|
110
|
+
|
|
111
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesCapabilityDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
API data with query params
|
|
116
|
+
|
|
117
|
+
### Example
|
|
118
|
+
|
|
119
|
+
```ts
|
|
120
|
+
import {
|
|
121
|
+
Configuration,
|
|
122
|
+
SEPApi,
|
|
123
|
+
} from '';
|
|
124
|
+
import type { V2ElectricityStateElectricityProfilesCapabilityDataGetRequest } from '';
|
|
125
|
+
|
|
126
|
+
async function example() {
|
|
127
|
+
console.log("🚀 Testing SDK...");
|
|
128
|
+
const config = new Configuration({
|
|
129
|
+
// To configure API key authorization: api_key
|
|
130
|
+
apiKey: "YOUR API KEY",
|
|
131
|
+
});
|
|
132
|
+
const api = new SEPApi(config);
|
|
133
|
+
|
|
134
|
+
const body = {
|
|
135
|
+
// Array<string> | Data columns to filter by (optional)
|
|
136
|
+
data: ...,
|
|
137
|
+
// object | Facets to filter by (optional)
|
|
138
|
+
facets: Object,
|
|
139
|
+
// string | Frequency to filter by (optional)
|
|
140
|
+
frequency: frequency_example,
|
|
141
|
+
// string | Start date to filter by (optional)
|
|
142
|
+
start: start_example,
|
|
143
|
+
// string | End date to filter by (optional)
|
|
144
|
+
end: end_example,
|
|
145
|
+
// Sort | How to sort returned data (optional)
|
|
146
|
+
sort: ...,
|
|
147
|
+
// number | Max length of returned data (optional)
|
|
148
|
+
length: 56,
|
|
149
|
+
// number | Offset of returned data (optional)
|
|
150
|
+
offset: 56,
|
|
151
|
+
} satisfies V2ElectricityStateElectricityProfilesCapabilityDataGetRequest;
|
|
152
|
+
|
|
153
|
+
try {
|
|
154
|
+
const data = await api.v2ElectricityStateElectricityProfilesCapabilityDataGet(body);
|
|
155
|
+
console.log(data);
|
|
156
|
+
} catch (error) {
|
|
157
|
+
console.error(error);
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
// Run the test
|
|
162
|
+
example().catch(console.error);
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### Parameters
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
| Name | Type | Description | Notes |
|
|
169
|
+
|------------- | ------------- | ------------- | -------------|
|
|
170
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
171
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
172
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
173
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
174
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
175
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
176
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
177
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
178
|
+
|
|
179
|
+
### Return type
|
|
180
|
+
|
|
181
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
182
|
+
|
|
183
|
+
### Authorization
|
|
184
|
+
|
|
185
|
+
[api_key](../README.md#api_key)
|
|
186
|
+
|
|
187
|
+
### HTTP request headers
|
|
188
|
+
|
|
189
|
+
- **Content-Type**: Not defined
|
|
190
|
+
- **Accept**: `application/json`
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
### HTTP response details
|
|
194
|
+
| Status code | Description | Response headers |
|
|
195
|
+
|-------------|-------------|------------------|
|
|
196
|
+
| **400** | Invalid input | - |
|
|
197
|
+
| **200** | API Data | - |
|
|
198
|
+
|
|
199
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
## v2ElectricityStateElectricityProfilesCapabilityDataPost
|
|
203
|
+
|
|
204
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesCapabilityDataPost(dataParams)
|
|
205
|
+
|
|
206
|
+
Class CapabilityDataController
|
|
207
|
+
|
|
208
|
+
Electricity capability dataset controller.
|
|
209
|
+
|
|
210
|
+
### Example
|
|
211
|
+
|
|
212
|
+
```ts
|
|
213
|
+
import {
|
|
214
|
+
Configuration,
|
|
215
|
+
SEPApi,
|
|
216
|
+
} from '';
|
|
217
|
+
import type { V2ElectricityStateElectricityProfilesCapabilityDataPostRequest } from '';
|
|
218
|
+
|
|
219
|
+
async function example() {
|
|
220
|
+
console.log("🚀 Testing SDK...");
|
|
221
|
+
const config = new Configuration({
|
|
222
|
+
// To configure API key authorization: api_key
|
|
223
|
+
apiKey: "YOUR API KEY",
|
|
224
|
+
});
|
|
225
|
+
const api = new SEPApi(config);
|
|
226
|
+
|
|
227
|
+
const body = {
|
|
228
|
+
// DataParams | Parameters for data call
|
|
229
|
+
dataParams: ...,
|
|
230
|
+
} satisfies V2ElectricityStateElectricityProfilesCapabilityDataPostRequest;
|
|
231
|
+
|
|
232
|
+
try {
|
|
233
|
+
const data = await api.v2ElectricityStateElectricityProfilesCapabilityDataPost(body);
|
|
234
|
+
console.log(data);
|
|
235
|
+
} catch (error) {
|
|
236
|
+
console.error(error);
|
|
237
|
+
}
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
// Run the test
|
|
241
|
+
example().catch(console.error);
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Parameters
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
| Name | Type | Description | Notes |
|
|
248
|
+
|------------- | ------------- | ------------- | -------------|
|
|
249
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
250
|
+
|
|
251
|
+
### Return type
|
|
252
|
+
|
|
253
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
254
|
+
|
|
255
|
+
### Authorization
|
|
256
|
+
|
|
257
|
+
[api_key](../README.md#api_key)
|
|
258
|
+
|
|
259
|
+
### HTTP request headers
|
|
260
|
+
|
|
261
|
+
- **Content-Type**: `application/json`
|
|
262
|
+
- **Accept**: `application/json`
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
### HTTP response details
|
|
266
|
+
| Status code | Description | Response headers |
|
|
267
|
+
|-------------|-------------|------------------|
|
|
268
|
+
| **400** | Invalid input | - |
|
|
269
|
+
| **200** | API Data | - |
|
|
270
|
+
|
|
271
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
## v2ElectricityStateElectricityProfilesCapabilityFacetFacetIdGet
|
|
275
|
+
|
|
276
|
+
> FacetDetailsContainer v2ElectricityStateElectricityProfilesCapabilityFacetFacetIdGet(facetId)
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
### Example
|
|
281
|
+
|
|
282
|
+
```ts
|
|
283
|
+
import {
|
|
284
|
+
Configuration,
|
|
285
|
+
SEPApi,
|
|
286
|
+
} from '';
|
|
287
|
+
import type { V2ElectricityStateElectricityProfilesCapabilityFacetFacetIdGetRequest } from '';
|
|
288
|
+
|
|
289
|
+
async function example() {
|
|
290
|
+
console.log("🚀 Testing SDK...");
|
|
291
|
+
const config = new Configuration({
|
|
292
|
+
// To configure API key authorization: api_key
|
|
293
|
+
apiKey: "YOUR API KEY",
|
|
294
|
+
});
|
|
295
|
+
const api = new SEPApi(config);
|
|
296
|
+
|
|
297
|
+
const body = {
|
|
298
|
+
// string | Facet ID
|
|
299
|
+
facetId: facetId_example,
|
|
300
|
+
} satisfies V2ElectricityStateElectricityProfilesCapabilityFacetFacetIdGetRequest;
|
|
301
|
+
|
|
302
|
+
try {
|
|
303
|
+
const data = await api.v2ElectricityStateElectricityProfilesCapabilityFacetFacetIdGet(body);
|
|
304
|
+
console.log(data);
|
|
305
|
+
} catch (error) {
|
|
306
|
+
console.error(error);
|
|
307
|
+
}
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
// Run the test
|
|
311
|
+
example().catch(console.error);
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
### Parameters
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
| Name | Type | Description | Notes |
|
|
318
|
+
|------------- | ------------- | ------------- | -------------|
|
|
319
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
320
|
+
|
|
321
|
+
### Return type
|
|
322
|
+
|
|
323
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
324
|
+
|
|
325
|
+
### Authorization
|
|
326
|
+
|
|
327
|
+
[api_key](../README.md#api_key)
|
|
328
|
+
|
|
329
|
+
### HTTP request headers
|
|
330
|
+
|
|
331
|
+
- **Content-Type**: Not defined
|
|
332
|
+
- **Accept**: `application/json`
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
### HTTP response details
|
|
336
|
+
| Status code | Description | Response headers |
|
|
337
|
+
|-------------|-------------|------------------|
|
|
338
|
+
| **400** | Invalid input | - |
|
|
339
|
+
| **200** | Facet details | - |
|
|
340
|
+
|
|
341
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
## v2ElectricityStateElectricityProfilesCapabilityFacetGet
|
|
345
|
+
|
|
346
|
+
> FacetOptionListContainer v2ElectricityStateElectricityProfilesCapabilityFacetGet()
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
### Example
|
|
351
|
+
|
|
352
|
+
```ts
|
|
353
|
+
import {
|
|
354
|
+
Configuration,
|
|
355
|
+
SEPApi,
|
|
356
|
+
} from '';
|
|
357
|
+
import type { V2ElectricityStateElectricityProfilesCapabilityFacetGetRequest } from '';
|
|
358
|
+
|
|
359
|
+
async function example() {
|
|
360
|
+
console.log("🚀 Testing SDK...");
|
|
361
|
+
const config = new Configuration({
|
|
362
|
+
// To configure API key authorization: api_key
|
|
363
|
+
apiKey: "YOUR API KEY",
|
|
364
|
+
});
|
|
365
|
+
const api = new SEPApi(config);
|
|
366
|
+
|
|
367
|
+
try {
|
|
368
|
+
const data = await api.v2ElectricityStateElectricityProfilesCapabilityFacetGet();
|
|
369
|
+
console.log(data);
|
|
370
|
+
} catch (error) {
|
|
371
|
+
console.error(error);
|
|
372
|
+
}
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
// Run the test
|
|
376
|
+
example().catch(console.error);
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Parameters
|
|
380
|
+
|
|
381
|
+
This endpoint does not need any parameter.
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
[api_key](../README.md#api_key)
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: Not defined
|
|
394
|
+
- **Accept**: `application/json`
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
### HTTP response details
|
|
398
|
+
| Status code | Description | Response headers |
|
|
399
|
+
|-------------|-------------|------------------|
|
|
400
|
+
| **400** | Invalid input | - |
|
|
401
|
+
| **200** | List of facet options | - |
|
|
402
|
+
|
|
403
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
## v2ElectricityStateElectricityProfilesCapabilityGet
|
|
407
|
+
|
|
408
|
+
> FinalRouteResponseContainer v2ElectricityStateElectricityProfilesCapabilityGet()
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
### Example
|
|
413
|
+
|
|
414
|
+
```ts
|
|
415
|
+
import {
|
|
416
|
+
Configuration,
|
|
417
|
+
SEPApi,
|
|
418
|
+
} from '';
|
|
419
|
+
import type { V2ElectricityStateElectricityProfilesCapabilityGetRequest } from '';
|
|
420
|
+
|
|
421
|
+
async function example() {
|
|
422
|
+
console.log("🚀 Testing SDK...");
|
|
423
|
+
const config = new Configuration({
|
|
424
|
+
// To configure API key authorization: api_key
|
|
425
|
+
apiKey: "YOUR API KEY",
|
|
426
|
+
});
|
|
427
|
+
const api = new SEPApi(config);
|
|
428
|
+
|
|
429
|
+
try {
|
|
430
|
+
const data = await api.v2ElectricityStateElectricityProfilesCapabilityGet();
|
|
431
|
+
console.log(data);
|
|
432
|
+
} catch (error) {
|
|
433
|
+
console.error(error);
|
|
434
|
+
}
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
// Run the test
|
|
438
|
+
example().catch(console.error);
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
### Parameters
|
|
442
|
+
|
|
443
|
+
This endpoint does not need any parameter.
|
|
444
|
+
|
|
445
|
+
### Return type
|
|
446
|
+
|
|
447
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
448
|
+
|
|
449
|
+
### Authorization
|
|
450
|
+
|
|
451
|
+
[api_key](../README.md#api_key)
|
|
452
|
+
|
|
453
|
+
### HTTP request headers
|
|
454
|
+
|
|
455
|
+
- **Content-Type**: Not defined
|
|
456
|
+
- **Accept**: `application/json`
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
### HTTP response details
|
|
460
|
+
| Status code | Description | Response headers |
|
|
461
|
+
|-------------|-------------|------------------|
|
|
462
|
+
| **200** | List of API data sets | - |
|
|
463
|
+
|
|
464
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
## v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataGet
|
|
468
|
+
|
|
469
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
API data with query params
|
|
474
|
+
|
|
475
|
+
### Example
|
|
476
|
+
|
|
477
|
+
```ts
|
|
478
|
+
import {
|
|
479
|
+
Configuration,
|
|
480
|
+
SEPApi,
|
|
481
|
+
} from '';
|
|
482
|
+
import type { V2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataGetRequest } from '';
|
|
483
|
+
|
|
484
|
+
async function example() {
|
|
485
|
+
console.log("🚀 Testing SDK...");
|
|
486
|
+
const config = new Configuration({
|
|
487
|
+
// To configure API key authorization: api_key
|
|
488
|
+
apiKey: "YOUR API KEY",
|
|
489
|
+
});
|
|
490
|
+
const api = new SEPApi(config);
|
|
491
|
+
|
|
492
|
+
const body = {
|
|
493
|
+
// Array<string> | Data columns to filter by (optional)
|
|
494
|
+
data: ...,
|
|
495
|
+
// object | Facets to filter by (optional)
|
|
496
|
+
facets: Object,
|
|
497
|
+
// string | Frequency to filter by (optional)
|
|
498
|
+
frequency: frequency_example,
|
|
499
|
+
// string | Start date to filter by (optional)
|
|
500
|
+
start: start_example,
|
|
501
|
+
// string | End date to filter by (optional)
|
|
502
|
+
end: end_example,
|
|
503
|
+
// Sort | How to sort returned data (optional)
|
|
504
|
+
sort: ...,
|
|
505
|
+
// number | Max length of returned data (optional)
|
|
506
|
+
length: 56,
|
|
507
|
+
// number | Offset of returned data (optional)
|
|
508
|
+
offset: 56,
|
|
509
|
+
} satisfies V2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataGetRequest;
|
|
510
|
+
|
|
511
|
+
try {
|
|
512
|
+
const data = await api.v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataGet(body);
|
|
513
|
+
console.log(data);
|
|
514
|
+
} catch (error) {
|
|
515
|
+
console.error(error);
|
|
516
|
+
}
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
// Run the test
|
|
520
|
+
example().catch(console.error);
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
### Parameters
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
| Name | Type | Description | Notes |
|
|
527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
528
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
529
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
530
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
531
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
532
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
533
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
534
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
535
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
536
|
+
|
|
537
|
+
### Return type
|
|
538
|
+
|
|
539
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
540
|
+
|
|
541
|
+
### Authorization
|
|
542
|
+
|
|
543
|
+
[api_key](../README.md#api_key)
|
|
544
|
+
|
|
545
|
+
### HTTP request headers
|
|
546
|
+
|
|
547
|
+
- **Content-Type**: Not defined
|
|
548
|
+
- **Accept**: `application/json`
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
### HTTP response details
|
|
552
|
+
| Status code | Description | Response headers |
|
|
553
|
+
|-------------|-------------|------------------|
|
|
554
|
+
| **400** | Invalid input | - |
|
|
555
|
+
| **200** | API Data | - |
|
|
556
|
+
|
|
557
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
## v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataPost
|
|
561
|
+
|
|
562
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataPost(dataParams)
|
|
563
|
+
|
|
564
|
+
Return sep emissions-by-state-by-fuel Data
|
|
565
|
+
|
|
566
|
+
Class EmissionsByStateByFuelController Electricity emissions EmissionsByStateByFuelController dataset controller.
|
|
567
|
+
|
|
568
|
+
### Example
|
|
569
|
+
|
|
570
|
+
```ts
|
|
571
|
+
import {
|
|
572
|
+
Configuration,
|
|
573
|
+
SEPApi,
|
|
574
|
+
} from '';
|
|
575
|
+
import type { V2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataPostRequest } from '';
|
|
576
|
+
|
|
577
|
+
async function example() {
|
|
578
|
+
console.log("🚀 Testing SDK...");
|
|
579
|
+
const config = new Configuration({
|
|
580
|
+
// To configure API key authorization: api_key
|
|
581
|
+
apiKey: "YOUR API KEY",
|
|
582
|
+
});
|
|
583
|
+
const api = new SEPApi(config);
|
|
584
|
+
|
|
585
|
+
const body = {
|
|
586
|
+
// DataParams | Parameters for data call
|
|
587
|
+
dataParams: ...,
|
|
588
|
+
} satisfies V2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataPostRequest;
|
|
589
|
+
|
|
590
|
+
try {
|
|
591
|
+
const data = await api.v2ElectricityStateElectricityProfilesEmissionsByStateByFuelDataPost(body);
|
|
592
|
+
console.log(data);
|
|
593
|
+
} catch (error) {
|
|
594
|
+
console.error(error);
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
// Run the test
|
|
599
|
+
example().catch(console.error);
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
### Parameters
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
| Name | Type | Description | Notes |
|
|
606
|
+
|------------- | ------------- | ------------- | -------------|
|
|
607
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
608
|
+
|
|
609
|
+
### Return type
|
|
610
|
+
|
|
611
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
612
|
+
|
|
613
|
+
### Authorization
|
|
614
|
+
|
|
615
|
+
[api_key](../README.md#api_key)
|
|
616
|
+
|
|
617
|
+
### HTTP request headers
|
|
618
|
+
|
|
619
|
+
- **Content-Type**: `application/json`
|
|
620
|
+
- **Accept**: `application/json`
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
### HTTP response details
|
|
624
|
+
| Status code | Description | Response headers |
|
|
625
|
+
|-------------|-------------|------------------|
|
|
626
|
+
| **400** | Invalid input | - |
|
|
627
|
+
| **200** | API Data | - |
|
|
628
|
+
|
|
629
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
## v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetFacetIdGet
|
|
633
|
+
|
|
634
|
+
> FacetDetailsContainer v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetFacetIdGet(facetId)
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
### Example
|
|
639
|
+
|
|
640
|
+
```ts
|
|
641
|
+
import {
|
|
642
|
+
Configuration,
|
|
643
|
+
SEPApi,
|
|
644
|
+
} from '';
|
|
645
|
+
import type { V2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetFacetIdGetRequest } from '';
|
|
646
|
+
|
|
647
|
+
async function example() {
|
|
648
|
+
console.log("🚀 Testing SDK...");
|
|
649
|
+
const config = new Configuration({
|
|
650
|
+
// To configure API key authorization: api_key
|
|
651
|
+
apiKey: "YOUR API KEY",
|
|
652
|
+
});
|
|
653
|
+
const api = new SEPApi(config);
|
|
654
|
+
|
|
655
|
+
const body = {
|
|
656
|
+
// string | Facet ID
|
|
657
|
+
facetId: facetId_example,
|
|
658
|
+
} satisfies V2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetFacetIdGetRequest;
|
|
659
|
+
|
|
660
|
+
try {
|
|
661
|
+
const data = await api.v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetFacetIdGet(body);
|
|
662
|
+
console.log(data);
|
|
663
|
+
} catch (error) {
|
|
664
|
+
console.error(error);
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
|
|
668
|
+
// Run the test
|
|
669
|
+
example().catch(console.error);
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
### Parameters
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
| Name | Type | Description | Notes |
|
|
676
|
+
|------------- | ------------- | ------------- | -------------|
|
|
677
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
678
|
+
|
|
679
|
+
### Return type
|
|
680
|
+
|
|
681
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
682
|
+
|
|
683
|
+
### Authorization
|
|
684
|
+
|
|
685
|
+
[api_key](../README.md#api_key)
|
|
686
|
+
|
|
687
|
+
### HTTP request headers
|
|
688
|
+
|
|
689
|
+
- **Content-Type**: Not defined
|
|
690
|
+
- **Accept**: `application/json`
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
### HTTP response details
|
|
694
|
+
| Status code | Description | Response headers |
|
|
695
|
+
|-------------|-------------|------------------|
|
|
696
|
+
| **400** | Invalid input | - |
|
|
697
|
+
| **200** | Facet details | - |
|
|
698
|
+
|
|
699
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
## v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetGet
|
|
703
|
+
|
|
704
|
+
> FacetOptionListContainer v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetGet()
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
### Example
|
|
709
|
+
|
|
710
|
+
```ts
|
|
711
|
+
import {
|
|
712
|
+
Configuration,
|
|
713
|
+
SEPApi,
|
|
714
|
+
} from '';
|
|
715
|
+
import type { V2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetGetRequest } from '';
|
|
716
|
+
|
|
717
|
+
async function example() {
|
|
718
|
+
console.log("🚀 Testing SDK...");
|
|
719
|
+
const config = new Configuration({
|
|
720
|
+
// To configure API key authorization: api_key
|
|
721
|
+
apiKey: "YOUR API KEY",
|
|
722
|
+
});
|
|
723
|
+
const api = new SEPApi(config);
|
|
724
|
+
|
|
725
|
+
try {
|
|
726
|
+
const data = await api.v2ElectricityStateElectricityProfilesEmissionsByStateByFuelFacetGet();
|
|
727
|
+
console.log(data);
|
|
728
|
+
} catch (error) {
|
|
729
|
+
console.error(error);
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
|
|
733
|
+
// Run the test
|
|
734
|
+
example().catch(console.error);
|
|
735
|
+
```
|
|
736
|
+
|
|
737
|
+
### Parameters
|
|
738
|
+
|
|
739
|
+
This endpoint does not need any parameter.
|
|
740
|
+
|
|
741
|
+
### Return type
|
|
742
|
+
|
|
743
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
744
|
+
|
|
745
|
+
### Authorization
|
|
746
|
+
|
|
747
|
+
[api_key](../README.md#api_key)
|
|
748
|
+
|
|
749
|
+
### HTTP request headers
|
|
750
|
+
|
|
751
|
+
- **Content-Type**: Not defined
|
|
752
|
+
- **Accept**: `application/json`
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
### HTTP response details
|
|
756
|
+
| Status code | Description | Response headers |
|
|
757
|
+
|-------------|-------------|------------------|
|
|
758
|
+
| **400** | Invalid input | - |
|
|
759
|
+
| **200** | List of facet options | - |
|
|
760
|
+
|
|
761
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
## v2ElectricityStateElectricityProfilesEmissionsByStateByFuelGet
|
|
765
|
+
|
|
766
|
+
> FinalRouteResponseContainer v2ElectricityStateElectricityProfilesEmissionsByStateByFuelGet()
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
### Example
|
|
771
|
+
|
|
772
|
+
```ts
|
|
773
|
+
import {
|
|
774
|
+
Configuration,
|
|
775
|
+
SEPApi,
|
|
776
|
+
} from '';
|
|
777
|
+
import type { V2ElectricityStateElectricityProfilesEmissionsByStateByFuelGetRequest } from '';
|
|
778
|
+
|
|
779
|
+
async function example() {
|
|
780
|
+
console.log("🚀 Testing SDK...");
|
|
781
|
+
const config = new Configuration({
|
|
782
|
+
// To configure API key authorization: api_key
|
|
783
|
+
apiKey: "YOUR API KEY",
|
|
784
|
+
});
|
|
785
|
+
const api = new SEPApi(config);
|
|
786
|
+
|
|
787
|
+
try {
|
|
788
|
+
const data = await api.v2ElectricityStateElectricityProfilesEmissionsByStateByFuelGet();
|
|
789
|
+
console.log(data);
|
|
790
|
+
} catch (error) {
|
|
791
|
+
console.error(error);
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
|
|
795
|
+
// Run the test
|
|
796
|
+
example().catch(console.error);
|
|
797
|
+
```
|
|
798
|
+
|
|
799
|
+
### Parameters
|
|
800
|
+
|
|
801
|
+
This endpoint does not need any parameter.
|
|
802
|
+
|
|
803
|
+
### Return type
|
|
804
|
+
|
|
805
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
806
|
+
|
|
807
|
+
### Authorization
|
|
808
|
+
|
|
809
|
+
[api_key](../README.md#api_key)
|
|
810
|
+
|
|
811
|
+
### HTTP request headers
|
|
812
|
+
|
|
813
|
+
- **Content-Type**: Not defined
|
|
814
|
+
- **Accept**: `application/json`
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
### HTTP response details
|
|
818
|
+
| Status code | Description | Response headers |
|
|
819
|
+
|-------------|-------------|------------------|
|
|
820
|
+
| **200** | List of API data sets | - |
|
|
821
|
+
|
|
822
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
## v2ElectricityStateElectricityProfilesEnergyEfficiencyDataGet
|
|
826
|
+
|
|
827
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesEnergyEfficiencyDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
API data with query params
|
|
832
|
+
|
|
833
|
+
### Example
|
|
834
|
+
|
|
835
|
+
```ts
|
|
836
|
+
import {
|
|
837
|
+
Configuration,
|
|
838
|
+
SEPApi,
|
|
839
|
+
} from '';
|
|
840
|
+
import type { V2ElectricityStateElectricityProfilesEnergyEfficiencyDataGetRequest } from '';
|
|
841
|
+
|
|
842
|
+
async function example() {
|
|
843
|
+
console.log("🚀 Testing SDK...");
|
|
844
|
+
const config = new Configuration({
|
|
845
|
+
// To configure API key authorization: api_key
|
|
846
|
+
apiKey: "YOUR API KEY",
|
|
847
|
+
});
|
|
848
|
+
const api = new SEPApi(config);
|
|
849
|
+
|
|
850
|
+
const body = {
|
|
851
|
+
// Array<string> | Data columns to filter by (optional)
|
|
852
|
+
data: ...,
|
|
853
|
+
// object | Facets to filter by (optional)
|
|
854
|
+
facets: Object,
|
|
855
|
+
// string | Frequency to filter by (optional)
|
|
856
|
+
frequency: frequency_example,
|
|
857
|
+
// string | Start date to filter by (optional)
|
|
858
|
+
start: start_example,
|
|
859
|
+
// string | End date to filter by (optional)
|
|
860
|
+
end: end_example,
|
|
861
|
+
// Sort | How to sort returned data (optional)
|
|
862
|
+
sort: ...,
|
|
863
|
+
// number | Max length of returned data (optional)
|
|
864
|
+
length: 56,
|
|
865
|
+
// number | Offset of returned data (optional)
|
|
866
|
+
offset: 56,
|
|
867
|
+
} satisfies V2ElectricityStateElectricityProfilesEnergyEfficiencyDataGetRequest;
|
|
868
|
+
|
|
869
|
+
try {
|
|
870
|
+
const data = await api.v2ElectricityStateElectricityProfilesEnergyEfficiencyDataGet(body);
|
|
871
|
+
console.log(data);
|
|
872
|
+
} catch (error) {
|
|
873
|
+
console.error(error);
|
|
874
|
+
}
|
|
875
|
+
}
|
|
876
|
+
|
|
877
|
+
// Run the test
|
|
878
|
+
example().catch(console.error);
|
|
879
|
+
```
|
|
880
|
+
|
|
881
|
+
### Parameters
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
| Name | Type | Description | Notes |
|
|
885
|
+
|------------- | ------------- | ------------- | -------------|
|
|
886
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
887
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
888
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
889
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
890
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
891
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
892
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
893
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
894
|
+
|
|
895
|
+
### Return type
|
|
896
|
+
|
|
897
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
898
|
+
|
|
899
|
+
### Authorization
|
|
900
|
+
|
|
901
|
+
[api_key](../README.md#api_key)
|
|
902
|
+
|
|
903
|
+
### HTTP request headers
|
|
904
|
+
|
|
905
|
+
- **Content-Type**: Not defined
|
|
906
|
+
- **Accept**: `application/json`
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
### HTTP response details
|
|
910
|
+
| Status code | Description | Response headers |
|
|
911
|
+
|-------------|-------------|------------------|
|
|
912
|
+
| **400** | Invalid input | - |
|
|
913
|
+
| **200** | API Data | - |
|
|
914
|
+
|
|
915
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
## v2ElectricityStateElectricityProfilesEnergyEfficiencyDataPost
|
|
919
|
+
|
|
920
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesEnergyEfficiencyDataPost(dataParams)
|
|
921
|
+
|
|
922
|
+
Return sep energy-effiency Data
|
|
923
|
+
|
|
924
|
+
Class EnergyEfficiencyController Electricity EnergyEfficiencyController dataset controller.
|
|
925
|
+
|
|
926
|
+
### Example
|
|
927
|
+
|
|
928
|
+
```ts
|
|
929
|
+
import {
|
|
930
|
+
Configuration,
|
|
931
|
+
SEPApi,
|
|
932
|
+
} from '';
|
|
933
|
+
import type { V2ElectricityStateElectricityProfilesEnergyEfficiencyDataPostRequest } from '';
|
|
934
|
+
|
|
935
|
+
async function example() {
|
|
936
|
+
console.log("🚀 Testing SDK...");
|
|
937
|
+
const config = new Configuration({
|
|
938
|
+
// To configure API key authorization: api_key
|
|
939
|
+
apiKey: "YOUR API KEY",
|
|
940
|
+
});
|
|
941
|
+
const api = new SEPApi(config);
|
|
942
|
+
|
|
943
|
+
const body = {
|
|
944
|
+
// DataParams | Parameters for data call
|
|
945
|
+
dataParams: ...,
|
|
946
|
+
} satisfies V2ElectricityStateElectricityProfilesEnergyEfficiencyDataPostRequest;
|
|
947
|
+
|
|
948
|
+
try {
|
|
949
|
+
const data = await api.v2ElectricityStateElectricityProfilesEnergyEfficiencyDataPost(body);
|
|
950
|
+
console.log(data);
|
|
951
|
+
} catch (error) {
|
|
952
|
+
console.error(error);
|
|
953
|
+
}
|
|
954
|
+
}
|
|
955
|
+
|
|
956
|
+
// Run the test
|
|
957
|
+
example().catch(console.error);
|
|
958
|
+
```
|
|
959
|
+
|
|
960
|
+
### Parameters
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
| Name | Type | Description | Notes |
|
|
964
|
+
|------------- | ------------- | ------------- | -------------|
|
|
965
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
966
|
+
|
|
967
|
+
### Return type
|
|
968
|
+
|
|
969
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
970
|
+
|
|
971
|
+
### Authorization
|
|
972
|
+
|
|
973
|
+
[api_key](../README.md#api_key)
|
|
974
|
+
|
|
975
|
+
### HTTP request headers
|
|
976
|
+
|
|
977
|
+
- **Content-Type**: `application/json`
|
|
978
|
+
- **Accept**: `application/json`
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
### HTTP response details
|
|
982
|
+
| Status code | Description | Response headers |
|
|
983
|
+
|-------------|-------------|------------------|
|
|
984
|
+
| **400** | Invalid input | - |
|
|
985
|
+
| **200** | API Data | - |
|
|
986
|
+
|
|
987
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
## v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetFacetIdGet
|
|
991
|
+
|
|
992
|
+
> FacetDetailsContainer v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetFacetIdGet(facetId)
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
### Example
|
|
997
|
+
|
|
998
|
+
```ts
|
|
999
|
+
import {
|
|
1000
|
+
Configuration,
|
|
1001
|
+
SEPApi,
|
|
1002
|
+
} from '';
|
|
1003
|
+
import type { V2ElectricityStateElectricityProfilesEnergyEfficiencyFacetFacetIdGetRequest } from '';
|
|
1004
|
+
|
|
1005
|
+
async function example() {
|
|
1006
|
+
console.log("🚀 Testing SDK...");
|
|
1007
|
+
const config = new Configuration({
|
|
1008
|
+
// To configure API key authorization: api_key
|
|
1009
|
+
apiKey: "YOUR API KEY",
|
|
1010
|
+
});
|
|
1011
|
+
const api = new SEPApi(config);
|
|
1012
|
+
|
|
1013
|
+
const body = {
|
|
1014
|
+
// string | Facet ID
|
|
1015
|
+
facetId: facetId_example,
|
|
1016
|
+
} satisfies V2ElectricityStateElectricityProfilesEnergyEfficiencyFacetFacetIdGetRequest;
|
|
1017
|
+
|
|
1018
|
+
try {
|
|
1019
|
+
const data = await api.v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetFacetIdGet(body);
|
|
1020
|
+
console.log(data);
|
|
1021
|
+
} catch (error) {
|
|
1022
|
+
console.error(error);
|
|
1023
|
+
}
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
// Run the test
|
|
1027
|
+
example().catch(console.error);
|
|
1028
|
+
```
|
|
1029
|
+
|
|
1030
|
+
### Parameters
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
| Name | Type | Description | Notes |
|
|
1034
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1035
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
1036
|
+
|
|
1037
|
+
### Return type
|
|
1038
|
+
|
|
1039
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
1040
|
+
|
|
1041
|
+
### Authorization
|
|
1042
|
+
|
|
1043
|
+
[api_key](../README.md#api_key)
|
|
1044
|
+
|
|
1045
|
+
### HTTP request headers
|
|
1046
|
+
|
|
1047
|
+
- **Content-Type**: Not defined
|
|
1048
|
+
- **Accept**: `application/json`
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
### HTTP response details
|
|
1052
|
+
| Status code | Description | Response headers |
|
|
1053
|
+
|-------------|-------------|------------------|
|
|
1054
|
+
| **400** | Invalid input | - |
|
|
1055
|
+
| **200** | Facet details | - |
|
|
1056
|
+
|
|
1057
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
## v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetGet
|
|
1061
|
+
|
|
1062
|
+
> FacetOptionListContainer v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetGet()
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
### Example
|
|
1067
|
+
|
|
1068
|
+
```ts
|
|
1069
|
+
import {
|
|
1070
|
+
Configuration,
|
|
1071
|
+
SEPApi,
|
|
1072
|
+
} from '';
|
|
1073
|
+
import type { V2ElectricityStateElectricityProfilesEnergyEfficiencyFacetGetRequest } from '';
|
|
1074
|
+
|
|
1075
|
+
async function example() {
|
|
1076
|
+
console.log("🚀 Testing SDK...");
|
|
1077
|
+
const config = new Configuration({
|
|
1078
|
+
// To configure API key authorization: api_key
|
|
1079
|
+
apiKey: "YOUR API KEY",
|
|
1080
|
+
});
|
|
1081
|
+
const api = new SEPApi(config);
|
|
1082
|
+
|
|
1083
|
+
try {
|
|
1084
|
+
const data = await api.v2ElectricityStateElectricityProfilesEnergyEfficiencyFacetGet();
|
|
1085
|
+
console.log(data);
|
|
1086
|
+
} catch (error) {
|
|
1087
|
+
console.error(error);
|
|
1088
|
+
}
|
|
1089
|
+
}
|
|
1090
|
+
|
|
1091
|
+
// Run the test
|
|
1092
|
+
example().catch(console.error);
|
|
1093
|
+
```
|
|
1094
|
+
|
|
1095
|
+
### Parameters
|
|
1096
|
+
|
|
1097
|
+
This endpoint does not need any parameter.
|
|
1098
|
+
|
|
1099
|
+
### Return type
|
|
1100
|
+
|
|
1101
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
1102
|
+
|
|
1103
|
+
### Authorization
|
|
1104
|
+
|
|
1105
|
+
[api_key](../README.md#api_key)
|
|
1106
|
+
|
|
1107
|
+
### HTTP request headers
|
|
1108
|
+
|
|
1109
|
+
- **Content-Type**: Not defined
|
|
1110
|
+
- **Accept**: `application/json`
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
### HTTP response details
|
|
1114
|
+
| Status code | Description | Response headers |
|
|
1115
|
+
|-------------|-------------|------------------|
|
|
1116
|
+
| **400** | Invalid input | - |
|
|
1117
|
+
| **200** | List of facet options | - |
|
|
1118
|
+
|
|
1119
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
## v2ElectricityStateElectricityProfilesEnergyEfficiencyGet
|
|
1123
|
+
|
|
1124
|
+
> FinalRouteResponseContainer v2ElectricityStateElectricityProfilesEnergyEfficiencyGet()
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
### Example
|
|
1129
|
+
|
|
1130
|
+
```ts
|
|
1131
|
+
import {
|
|
1132
|
+
Configuration,
|
|
1133
|
+
SEPApi,
|
|
1134
|
+
} from '';
|
|
1135
|
+
import type { V2ElectricityStateElectricityProfilesEnergyEfficiencyGetRequest } from '';
|
|
1136
|
+
|
|
1137
|
+
async function example() {
|
|
1138
|
+
console.log("🚀 Testing SDK...");
|
|
1139
|
+
const config = new Configuration({
|
|
1140
|
+
// To configure API key authorization: api_key
|
|
1141
|
+
apiKey: "YOUR API KEY",
|
|
1142
|
+
});
|
|
1143
|
+
const api = new SEPApi(config);
|
|
1144
|
+
|
|
1145
|
+
try {
|
|
1146
|
+
const data = await api.v2ElectricityStateElectricityProfilesEnergyEfficiencyGet();
|
|
1147
|
+
console.log(data);
|
|
1148
|
+
} catch (error) {
|
|
1149
|
+
console.error(error);
|
|
1150
|
+
}
|
|
1151
|
+
}
|
|
1152
|
+
|
|
1153
|
+
// Run the test
|
|
1154
|
+
example().catch(console.error);
|
|
1155
|
+
```
|
|
1156
|
+
|
|
1157
|
+
### Parameters
|
|
1158
|
+
|
|
1159
|
+
This endpoint does not need any parameter.
|
|
1160
|
+
|
|
1161
|
+
### Return type
|
|
1162
|
+
|
|
1163
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
1164
|
+
|
|
1165
|
+
### Authorization
|
|
1166
|
+
|
|
1167
|
+
[api_key](../README.md#api_key)
|
|
1168
|
+
|
|
1169
|
+
### HTTP request headers
|
|
1170
|
+
|
|
1171
|
+
- **Content-Type**: Not defined
|
|
1172
|
+
- **Accept**: `application/json`
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
### HTTP response details
|
|
1176
|
+
| Status code | Description | Response headers |
|
|
1177
|
+
|-------------|-------------|------------------|
|
|
1178
|
+
| **200** | List of API data sets | - |
|
|
1179
|
+
|
|
1180
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
## v2ElectricityStateElectricityProfilesMetersDataGet
|
|
1184
|
+
|
|
1185
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesMetersDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
API data with query params
|
|
1190
|
+
|
|
1191
|
+
### Example
|
|
1192
|
+
|
|
1193
|
+
```ts
|
|
1194
|
+
import {
|
|
1195
|
+
Configuration,
|
|
1196
|
+
SEPApi,
|
|
1197
|
+
} from '';
|
|
1198
|
+
import type { V2ElectricityStateElectricityProfilesMetersDataGetRequest } from '';
|
|
1199
|
+
|
|
1200
|
+
async function example() {
|
|
1201
|
+
console.log("🚀 Testing SDK...");
|
|
1202
|
+
const config = new Configuration({
|
|
1203
|
+
// To configure API key authorization: api_key
|
|
1204
|
+
apiKey: "YOUR API KEY",
|
|
1205
|
+
});
|
|
1206
|
+
const api = new SEPApi(config);
|
|
1207
|
+
|
|
1208
|
+
const body = {
|
|
1209
|
+
// Array<string> | Data columns to filter by (optional)
|
|
1210
|
+
data: ...,
|
|
1211
|
+
// object | Facets to filter by (optional)
|
|
1212
|
+
facets: Object,
|
|
1213
|
+
// string | Frequency to filter by (optional)
|
|
1214
|
+
frequency: frequency_example,
|
|
1215
|
+
// string | Start date to filter by (optional)
|
|
1216
|
+
start: start_example,
|
|
1217
|
+
// string | End date to filter by (optional)
|
|
1218
|
+
end: end_example,
|
|
1219
|
+
// Sort | How to sort returned data (optional)
|
|
1220
|
+
sort: ...,
|
|
1221
|
+
// number | Max length of returned data (optional)
|
|
1222
|
+
length: 56,
|
|
1223
|
+
// number | Offset of returned data (optional)
|
|
1224
|
+
offset: 56,
|
|
1225
|
+
} satisfies V2ElectricityStateElectricityProfilesMetersDataGetRequest;
|
|
1226
|
+
|
|
1227
|
+
try {
|
|
1228
|
+
const data = await api.v2ElectricityStateElectricityProfilesMetersDataGet(body);
|
|
1229
|
+
console.log(data);
|
|
1230
|
+
} catch (error) {
|
|
1231
|
+
console.error(error);
|
|
1232
|
+
}
|
|
1233
|
+
}
|
|
1234
|
+
|
|
1235
|
+
// Run the test
|
|
1236
|
+
example().catch(console.error);
|
|
1237
|
+
```
|
|
1238
|
+
|
|
1239
|
+
### Parameters
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
| Name | Type | Description | Notes |
|
|
1243
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1244
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
1245
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
1246
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
1247
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
1248
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
1249
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
1250
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
1251
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
1252
|
+
|
|
1253
|
+
### Return type
|
|
1254
|
+
|
|
1255
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
1256
|
+
|
|
1257
|
+
### Authorization
|
|
1258
|
+
|
|
1259
|
+
[api_key](../README.md#api_key)
|
|
1260
|
+
|
|
1261
|
+
### HTTP request headers
|
|
1262
|
+
|
|
1263
|
+
- **Content-Type**: Not defined
|
|
1264
|
+
- **Accept**: `application/json`
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
### HTTP response details
|
|
1268
|
+
| Status code | Description | Response headers |
|
|
1269
|
+
|-------------|-------------|------------------|
|
|
1270
|
+
| **400** | Invalid input | - |
|
|
1271
|
+
| **200** | API Data | - |
|
|
1272
|
+
|
|
1273
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
## v2ElectricityStateElectricityProfilesMetersDataPost
|
|
1277
|
+
|
|
1278
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesMetersDataPost(dataParams)
|
|
1279
|
+
|
|
1280
|
+
Return sep meters Data
|
|
1281
|
+
|
|
1282
|
+
Class MetersController
|
|
1283
|
+
|
|
1284
|
+
### Example
|
|
1285
|
+
|
|
1286
|
+
```ts
|
|
1287
|
+
import {
|
|
1288
|
+
Configuration,
|
|
1289
|
+
SEPApi,
|
|
1290
|
+
} from '';
|
|
1291
|
+
import type { V2ElectricityStateElectricityProfilesMetersDataPostRequest } from '';
|
|
1292
|
+
|
|
1293
|
+
async function example() {
|
|
1294
|
+
console.log("🚀 Testing SDK...");
|
|
1295
|
+
const config = new Configuration({
|
|
1296
|
+
// To configure API key authorization: api_key
|
|
1297
|
+
apiKey: "YOUR API KEY",
|
|
1298
|
+
});
|
|
1299
|
+
const api = new SEPApi(config);
|
|
1300
|
+
|
|
1301
|
+
const body = {
|
|
1302
|
+
// DataParams | Parameters for data call
|
|
1303
|
+
dataParams: ...,
|
|
1304
|
+
} satisfies V2ElectricityStateElectricityProfilesMetersDataPostRequest;
|
|
1305
|
+
|
|
1306
|
+
try {
|
|
1307
|
+
const data = await api.v2ElectricityStateElectricityProfilesMetersDataPost(body);
|
|
1308
|
+
console.log(data);
|
|
1309
|
+
} catch (error) {
|
|
1310
|
+
console.error(error);
|
|
1311
|
+
}
|
|
1312
|
+
}
|
|
1313
|
+
|
|
1314
|
+
// Run the test
|
|
1315
|
+
example().catch(console.error);
|
|
1316
|
+
```
|
|
1317
|
+
|
|
1318
|
+
### Parameters
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
| Name | Type | Description | Notes |
|
|
1322
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1323
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
1324
|
+
|
|
1325
|
+
### Return type
|
|
1326
|
+
|
|
1327
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
1328
|
+
|
|
1329
|
+
### Authorization
|
|
1330
|
+
|
|
1331
|
+
[api_key](../README.md#api_key)
|
|
1332
|
+
|
|
1333
|
+
### HTTP request headers
|
|
1334
|
+
|
|
1335
|
+
- **Content-Type**: `application/json`
|
|
1336
|
+
- **Accept**: `application/json`
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
### HTTP response details
|
|
1340
|
+
| Status code | Description | Response headers |
|
|
1341
|
+
|-------------|-------------|------------------|
|
|
1342
|
+
| **400** | Invalid input | - |
|
|
1343
|
+
| **200** | API Data | - |
|
|
1344
|
+
|
|
1345
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
## v2ElectricityStateElectricityProfilesMetersFacetFacetIdGet
|
|
1349
|
+
|
|
1350
|
+
> FacetDetailsContainer v2ElectricityStateElectricityProfilesMetersFacetFacetIdGet(facetId)
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
### Example
|
|
1355
|
+
|
|
1356
|
+
```ts
|
|
1357
|
+
import {
|
|
1358
|
+
Configuration,
|
|
1359
|
+
SEPApi,
|
|
1360
|
+
} from '';
|
|
1361
|
+
import type { V2ElectricityStateElectricityProfilesMetersFacetFacetIdGetRequest } from '';
|
|
1362
|
+
|
|
1363
|
+
async function example() {
|
|
1364
|
+
console.log("🚀 Testing SDK...");
|
|
1365
|
+
const config = new Configuration({
|
|
1366
|
+
// To configure API key authorization: api_key
|
|
1367
|
+
apiKey: "YOUR API KEY",
|
|
1368
|
+
});
|
|
1369
|
+
const api = new SEPApi(config);
|
|
1370
|
+
|
|
1371
|
+
const body = {
|
|
1372
|
+
// string | Facet ID
|
|
1373
|
+
facetId: facetId_example,
|
|
1374
|
+
} satisfies V2ElectricityStateElectricityProfilesMetersFacetFacetIdGetRequest;
|
|
1375
|
+
|
|
1376
|
+
try {
|
|
1377
|
+
const data = await api.v2ElectricityStateElectricityProfilesMetersFacetFacetIdGet(body);
|
|
1378
|
+
console.log(data);
|
|
1379
|
+
} catch (error) {
|
|
1380
|
+
console.error(error);
|
|
1381
|
+
}
|
|
1382
|
+
}
|
|
1383
|
+
|
|
1384
|
+
// Run the test
|
|
1385
|
+
example().catch(console.error);
|
|
1386
|
+
```
|
|
1387
|
+
|
|
1388
|
+
### Parameters
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
| Name | Type | Description | Notes |
|
|
1392
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1393
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
1394
|
+
|
|
1395
|
+
### Return type
|
|
1396
|
+
|
|
1397
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
1398
|
+
|
|
1399
|
+
### Authorization
|
|
1400
|
+
|
|
1401
|
+
[api_key](../README.md#api_key)
|
|
1402
|
+
|
|
1403
|
+
### HTTP request headers
|
|
1404
|
+
|
|
1405
|
+
- **Content-Type**: Not defined
|
|
1406
|
+
- **Accept**: `application/json`
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
### HTTP response details
|
|
1410
|
+
| Status code | Description | Response headers |
|
|
1411
|
+
|-------------|-------------|------------------|
|
|
1412
|
+
| **400** | Invalid input | - |
|
|
1413
|
+
| **200** | Facet details | - |
|
|
1414
|
+
|
|
1415
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
## v2ElectricityStateElectricityProfilesMetersFacetGet
|
|
1419
|
+
|
|
1420
|
+
> FacetOptionListContainer v2ElectricityStateElectricityProfilesMetersFacetGet()
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
### Example
|
|
1425
|
+
|
|
1426
|
+
```ts
|
|
1427
|
+
import {
|
|
1428
|
+
Configuration,
|
|
1429
|
+
SEPApi,
|
|
1430
|
+
} from '';
|
|
1431
|
+
import type { V2ElectricityStateElectricityProfilesMetersFacetGetRequest } from '';
|
|
1432
|
+
|
|
1433
|
+
async function example() {
|
|
1434
|
+
console.log("🚀 Testing SDK...");
|
|
1435
|
+
const config = new Configuration({
|
|
1436
|
+
// To configure API key authorization: api_key
|
|
1437
|
+
apiKey: "YOUR API KEY",
|
|
1438
|
+
});
|
|
1439
|
+
const api = new SEPApi(config);
|
|
1440
|
+
|
|
1441
|
+
try {
|
|
1442
|
+
const data = await api.v2ElectricityStateElectricityProfilesMetersFacetGet();
|
|
1443
|
+
console.log(data);
|
|
1444
|
+
} catch (error) {
|
|
1445
|
+
console.error(error);
|
|
1446
|
+
}
|
|
1447
|
+
}
|
|
1448
|
+
|
|
1449
|
+
// Run the test
|
|
1450
|
+
example().catch(console.error);
|
|
1451
|
+
```
|
|
1452
|
+
|
|
1453
|
+
### Parameters
|
|
1454
|
+
|
|
1455
|
+
This endpoint does not need any parameter.
|
|
1456
|
+
|
|
1457
|
+
### Return type
|
|
1458
|
+
|
|
1459
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
1460
|
+
|
|
1461
|
+
### Authorization
|
|
1462
|
+
|
|
1463
|
+
[api_key](../README.md#api_key)
|
|
1464
|
+
|
|
1465
|
+
### HTTP request headers
|
|
1466
|
+
|
|
1467
|
+
- **Content-Type**: Not defined
|
|
1468
|
+
- **Accept**: `application/json`
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
### HTTP response details
|
|
1472
|
+
| Status code | Description | Response headers |
|
|
1473
|
+
|-------------|-------------|------------------|
|
|
1474
|
+
| **400** | Invalid input | - |
|
|
1475
|
+
| **200** | List of facet options | - |
|
|
1476
|
+
|
|
1477
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
## v2ElectricityStateElectricityProfilesMetersGet
|
|
1481
|
+
|
|
1482
|
+
> FinalRouteResponseContainer v2ElectricityStateElectricityProfilesMetersGet()
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
### Example
|
|
1487
|
+
|
|
1488
|
+
```ts
|
|
1489
|
+
import {
|
|
1490
|
+
Configuration,
|
|
1491
|
+
SEPApi,
|
|
1492
|
+
} from '';
|
|
1493
|
+
import type { V2ElectricityStateElectricityProfilesMetersGetRequest } from '';
|
|
1494
|
+
|
|
1495
|
+
async function example() {
|
|
1496
|
+
console.log("🚀 Testing SDK...");
|
|
1497
|
+
const config = new Configuration({
|
|
1498
|
+
// To configure API key authorization: api_key
|
|
1499
|
+
apiKey: "YOUR API KEY",
|
|
1500
|
+
});
|
|
1501
|
+
const api = new SEPApi(config);
|
|
1502
|
+
|
|
1503
|
+
try {
|
|
1504
|
+
const data = await api.v2ElectricityStateElectricityProfilesMetersGet();
|
|
1505
|
+
console.log(data);
|
|
1506
|
+
} catch (error) {
|
|
1507
|
+
console.error(error);
|
|
1508
|
+
}
|
|
1509
|
+
}
|
|
1510
|
+
|
|
1511
|
+
// Run the test
|
|
1512
|
+
example().catch(console.error);
|
|
1513
|
+
```
|
|
1514
|
+
|
|
1515
|
+
### Parameters
|
|
1516
|
+
|
|
1517
|
+
This endpoint does not need any parameter.
|
|
1518
|
+
|
|
1519
|
+
### Return type
|
|
1520
|
+
|
|
1521
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
1522
|
+
|
|
1523
|
+
### Authorization
|
|
1524
|
+
|
|
1525
|
+
[api_key](../README.md#api_key)
|
|
1526
|
+
|
|
1527
|
+
### HTTP request headers
|
|
1528
|
+
|
|
1529
|
+
- **Content-Type**: Not defined
|
|
1530
|
+
- **Accept**: `application/json`
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
### HTTP response details
|
|
1534
|
+
| Status code | Description | Response headers |
|
|
1535
|
+
|-------------|-------------|------------------|
|
|
1536
|
+
| **200** | List of API data sets | - |
|
|
1537
|
+
|
|
1538
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
## v2ElectricityStateElectricityProfilesNetMeteringDataGet
|
|
1542
|
+
|
|
1543
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesNetMeteringDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
API data with query params
|
|
1548
|
+
|
|
1549
|
+
### Example
|
|
1550
|
+
|
|
1551
|
+
```ts
|
|
1552
|
+
import {
|
|
1553
|
+
Configuration,
|
|
1554
|
+
SEPApi,
|
|
1555
|
+
} from '';
|
|
1556
|
+
import type { V2ElectricityStateElectricityProfilesNetMeteringDataGetRequest } from '';
|
|
1557
|
+
|
|
1558
|
+
async function example() {
|
|
1559
|
+
console.log("🚀 Testing SDK...");
|
|
1560
|
+
const config = new Configuration({
|
|
1561
|
+
// To configure API key authorization: api_key
|
|
1562
|
+
apiKey: "YOUR API KEY",
|
|
1563
|
+
});
|
|
1564
|
+
const api = new SEPApi(config);
|
|
1565
|
+
|
|
1566
|
+
const body = {
|
|
1567
|
+
// Array<string> | Data columns to filter by (optional)
|
|
1568
|
+
data: ...,
|
|
1569
|
+
// object | Facets to filter by (optional)
|
|
1570
|
+
facets: Object,
|
|
1571
|
+
// string | Frequency to filter by (optional)
|
|
1572
|
+
frequency: frequency_example,
|
|
1573
|
+
// string | Start date to filter by (optional)
|
|
1574
|
+
start: start_example,
|
|
1575
|
+
// string | End date to filter by (optional)
|
|
1576
|
+
end: end_example,
|
|
1577
|
+
// Sort | How to sort returned data (optional)
|
|
1578
|
+
sort: ...,
|
|
1579
|
+
// number | Max length of returned data (optional)
|
|
1580
|
+
length: 56,
|
|
1581
|
+
// number | Offset of returned data (optional)
|
|
1582
|
+
offset: 56,
|
|
1583
|
+
} satisfies V2ElectricityStateElectricityProfilesNetMeteringDataGetRequest;
|
|
1584
|
+
|
|
1585
|
+
try {
|
|
1586
|
+
const data = await api.v2ElectricityStateElectricityProfilesNetMeteringDataGet(body);
|
|
1587
|
+
console.log(data);
|
|
1588
|
+
} catch (error) {
|
|
1589
|
+
console.error(error);
|
|
1590
|
+
}
|
|
1591
|
+
}
|
|
1592
|
+
|
|
1593
|
+
// Run the test
|
|
1594
|
+
example().catch(console.error);
|
|
1595
|
+
```
|
|
1596
|
+
|
|
1597
|
+
### Parameters
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
| Name | Type | Description | Notes |
|
|
1601
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1602
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
1603
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
1604
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
1605
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
1606
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
1607
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
1608
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
1609
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
1610
|
+
|
|
1611
|
+
### Return type
|
|
1612
|
+
|
|
1613
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
1614
|
+
|
|
1615
|
+
### Authorization
|
|
1616
|
+
|
|
1617
|
+
[api_key](../README.md#api_key)
|
|
1618
|
+
|
|
1619
|
+
### HTTP request headers
|
|
1620
|
+
|
|
1621
|
+
- **Content-Type**: Not defined
|
|
1622
|
+
- **Accept**: `application/json`
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
### HTTP response details
|
|
1626
|
+
| Status code | Description | Response headers |
|
|
1627
|
+
|-------------|-------------|------------------|
|
|
1628
|
+
| **400** | Invalid input | - |
|
|
1629
|
+
| **200** | API Data | - |
|
|
1630
|
+
|
|
1631
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
## v2ElectricityStateElectricityProfilesNetMeteringDataPost
|
|
1635
|
+
|
|
1636
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesNetMeteringDataPost(dataParams)
|
|
1637
|
+
|
|
1638
|
+
Return sep net-metering Data
|
|
1639
|
+
|
|
1640
|
+
Class NetMeteringController Nuclear Outages data set top-level controller.
|
|
1641
|
+
|
|
1642
|
+
### Example
|
|
1643
|
+
|
|
1644
|
+
```ts
|
|
1645
|
+
import {
|
|
1646
|
+
Configuration,
|
|
1647
|
+
SEPApi,
|
|
1648
|
+
} from '';
|
|
1649
|
+
import type { V2ElectricityStateElectricityProfilesNetMeteringDataPostRequest } from '';
|
|
1650
|
+
|
|
1651
|
+
async function example() {
|
|
1652
|
+
console.log("🚀 Testing SDK...");
|
|
1653
|
+
const config = new Configuration({
|
|
1654
|
+
// To configure API key authorization: api_key
|
|
1655
|
+
apiKey: "YOUR API KEY",
|
|
1656
|
+
});
|
|
1657
|
+
const api = new SEPApi(config);
|
|
1658
|
+
|
|
1659
|
+
const body = {
|
|
1660
|
+
// DataParams | Parameters for data call
|
|
1661
|
+
dataParams: ...,
|
|
1662
|
+
} satisfies V2ElectricityStateElectricityProfilesNetMeteringDataPostRequest;
|
|
1663
|
+
|
|
1664
|
+
try {
|
|
1665
|
+
const data = await api.v2ElectricityStateElectricityProfilesNetMeteringDataPost(body);
|
|
1666
|
+
console.log(data);
|
|
1667
|
+
} catch (error) {
|
|
1668
|
+
console.error(error);
|
|
1669
|
+
}
|
|
1670
|
+
}
|
|
1671
|
+
|
|
1672
|
+
// Run the test
|
|
1673
|
+
example().catch(console.error);
|
|
1674
|
+
```
|
|
1675
|
+
|
|
1676
|
+
### Parameters
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
| Name | Type | Description | Notes |
|
|
1680
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1681
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
1682
|
+
|
|
1683
|
+
### Return type
|
|
1684
|
+
|
|
1685
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
1686
|
+
|
|
1687
|
+
### Authorization
|
|
1688
|
+
|
|
1689
|
+
[api_key](../README.md#api_key)
|
|
1690
|
+
|
|
1691
|
+
### HTTP request headers
|
|
1692
|
+
|
|
1693
|
+
- **Content-Type**: `application/json`
|
|
1694
|
+
- **Accept**: `application/json`
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
### HTTP response details
|
|
1698
|
+
| Status code | Description | Response headers |
|
|
1699
|
+
|-------------|-------------|------------------|
|
|
1700
|
+
| **400** | Invalid input | - |
|
|
1701
|
+
| **200** | API Data | - |
|
|
1702
|
+
|
|
1703
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
## v2ElectricityStateElectricityProfilesNetMeteringFacetFacetIdGet
|
|
1707
|
+
|
|
1708
|
+
> FacetDetailsContainer v2ElectricityStateElectricityProfilesNetMeteringFacetFacetIdGet(facetId)
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
### Example
|
|
1713
|
+
|
|
1714
|
+
```ts
|
|
1715
|
+
import {
|
|
1716
|
+
Configuration,
|
|
1717
|
+
SEPApi,
|
|
1718
|
+
} from '';
|
|
1719
|
+
import type { V2ElectricityStateElectricityProfilesNetMeteringFacetFacetIdGetRequest } from '';
|
|
1720
|
+
|
|
1721
|
+
async function example() {
|
|
1722
|
+
console.log("🚀 Testing SDK...");
|
|
1723
|
+
const config = new Configuration({
|
|
1724
|
+
// To configure API key authorization: api_key
|
|
1725
|
+
apiKey: "YOUR API KEY",
|
|
1726
|
+
});
|
|
1727
|
+
const api = new SEPApi(config);
|
|
1728
|
+
|
|
1729
|
+
const body = {
|
|
1730
|
+
// string | Facet ID
|
|
1731
|
+
facetId: facetId_example,
|
|
1732
|
+
} satisfies V2ElectricityStateElectricityProfilesNetMeteringFacetFacetIdGetRequest;
|
|
1733
|
+
|
|
1734
|
+
try {
|
|
1735
|
+
const data = await api.v2ElectricityStateElectricityProfilesNetMeteringFacetFacetIdGet(body);
|
|
1736
|
+
console.log(data);
|
|
1737
|
+
} catch (error) {
|
|
1738
|
+
console.error(error);
|
|
1739
|
+
}
|
|
1740
|
+
}
|
|
1741
|
+
|
|
1742
|
+
// Run the test
|
|
1743
|
+
example().catch(console.error);
|
|
1744
|
+
```
|
|
1745
|
+
|
|
1746
|
+
### Parameters
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
| Name | Type | Description | Notes |
|
|
1750
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1751
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
1752
|
+
|
|
1753
|
+
### Return type
|
|
1754
|
+
|
|
1755
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
1756
|
+
|
|
1757
|
+
### Authorization
|
|
1758
|
+
|
|
1759
|
+
[api_key](../README.md#api_key)
|
|
1760
|
+
|
|
1761
|
+
### HTTP request headers
|
|
1762
|
+
|
|
1763
|
+
- **Content-Type**: Not defined
|
|
1764
|
+
- **Accept**: `application/json`
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
### HTTP response details
|
|
1768
|
+
| Status code | Description | Response headers |
|
|
1769
|
+
|-------------|-------------|------------------|
|
|
1770
|
+
| **400** | Invalid input | - |
|
|
1771
|
+
| **200** | Facet details | - |
|
|
1772
|
+
|
|
1773
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
## v2ElectricityStateElectricityProfilesNetMeteringFacetGet
|
|
1777
|
+
|
|
1778
|
+
> FacetOptionListContainer v2ElectricityStateElectricityProfilesNetMeteringFacetGet()
|
|
1779
|
+
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
### Example
|
|
1783
|
+
|
|
1784
|
+
```ts
|
|
1785
|
+
import {
|
|
1786
|
+
Configuration,
|
|
1787
|
+
SEPApi,
|
|
1788
|
+
} from '';
|
|
1789
|
+
import type { V2ElectricityStateElectricityProfilesNetMeteringFacetGetRequest } from '';
|
|
1790
|
+
|
|
1791
|
+
async function example() {
|
|
1792
|
+
console.log("🚀 Testing SDK...");
|
|
1793
|
+
const config = new Configuration({
|
|
1794
|
+
// To configure API key authorization: api_key
|
|
1795
|
+
apiKey: "YOUR API KEY",
|
|
1796
|
+
});
|
|
1797
|
+
const api = new SEPApi(config);
|
|
1798
|
+
|
|
1799
|
+
try {
|
|
1800
|
+
const data = await api.v2ElectricityStateElectricityProfilesNetMeteringFacetGet();
|
|
1801
|
+
console.log(data);
|
|
1802
|
+
} catch (error) {
|
|
1803
|
+
console.error(error);
|
|
1804
|
+
}
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1807
|
+
// Run the test
|
|
1808
|
+
example().catch(console.error);
|
|
1809
|
+
```
|
|
1810
|
+
|
|
1811
|
+
### Parameters
|
|
1812
|
+
|
|
1813
|
+
This endpoint does not need any parameter.
|
|
1814
|
+
|
|
1815
|
+
### Return type
|
|
1816
|
+
|
|
1817
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
1818
|
+
|
|
1819
|
+
### Authorization
|
|
1820
|
+
|
|
1821
|
+
[api_key](../README.md#api_key)
|
|
1822
|
+
|
|
1823
|
+
### HTTP request headers
|
|
1824
|
+
|
|
1825
|
+
- **Content-Type**: Not defined
|
|
1826
|
+
- **Accept**: `application/json`
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
### HTTP response details
|
|
1830
|
+
| Status code | Description | Response headers |
|
|
1831
|
+
|-------------|-------------|------------------|
|
|
1832
|
+
| **400** | Invalid input | - |
|
|
1833
|
+
| **200** | List of facet options | - |
|
|
1834
|
+
|
|
1835
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
## v2ElectricityStateElectricityProfilesNetMeteringGet
|
|
1839
|
+
|
|
1840
|
+
> FinalRouteResponseContainer v2ElectricityStateElectricityProfilesNetMeteringGet()
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
### Example
|
|
1845
|
+
|
|
1846
|
+
```ts
|
|
1847
|
+
import {
|
|
1848
|
+
Configuration,
|
|
1849
|
+
SEPApi,
|
|
1850
|
+
} from '';
|
|
1851
|
+
import type { V2ElectricityStateElectricityProfilesNetMeteringGetRequest } from '';
|
|
1852
|
+
|
|
1853
|
+
async function example() {
|
|
1854
|
+
console.log("🚀 Testing SDK...");
|
|
1855
|
+
const config = new Configuration({
|
|
1856
|
+
// To configure API key authorization: api_key
|
|
1857
|
+
apiKey: "YOUR API KEY",
|
|
1858
|
+
});
|
|
1859
|
+
const api = new SEPApi(config);
|
|
1860
|
+
|
|
1861
|
+
try {
|
|
1862
|
+
const data = await api.v2ElectricityStateElectricityProfilesNetMeteringGet();
|
|
1863
|
+
console.log(data);
|
|
1864
|
+
} catch (error) {
|
|
1865
|
+
console.error(error);
|
|
1866
|
+
}
|
|
1867
|
+
}
|
|
1868
|
+
|
|
1869
|
+
// Run the test
|
|
1870
|
+
example().catch(console.error);
|
|
1871
|
+
```
|
|
1872
|
+
|
|
1873
|
+
### Parameters
|
|
1874
|
+
|
|
1875
|
+
This endpoint does not need any parameter.
|
|
1876
|
+
|
|
1877
|
+
### Return type
|
|
1878
|
+
|
|
1879
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
1880
|
+
|
|
1881
|
+
### Authorization
|
|
1882
|
+
|
|
1883
|
+
[api_key](../README.md#api_key)
|
|
1884
|
+
|
|
1885
|
+
### HTTP request headers
|
|
1886
|
+
|
|
1887
|
+
- **Content-Type**: Not defined
|
|
1888
|
+
- **Accept**: `application/json`
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
### HTTP response details
|
|
1892
|
+
| Status code | Description | Response headers |
|
|
1893
|
+
|-------------|-------------|------------------|
|
|
1894
|
+
| **200** | List of API data sets | - |
|
|
1895
|
+
|
|
1896
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
## v2ElectricityStateElectricityProfilesSourceDispositionDataGet
|
|
1900
|
+
|
|
1901
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesSourceDispositionDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
API data with query params
|
|
1906
|
+
|
|
1907
|
+
### Example
|
|
1908
|
+
|
|
1909
|
+
```ts
|
|
1910
|
+
import {
|
|
1911
|
+
Configuration,
|
|
1912
|
+
SEPApi,
|
|
1913
|
+
} from '';
|
|
1914
|
+
import type { V2ElectricityStateElectricityProfilesSourceDispositionDataGetRequest } from '';
|
|
1915
|
+
|
|
1916
|
+
async function example() {
|
|
1917
|
+
console.log("🚀 Testing SDK...");
|
|
1918
|
+
const config = new Configuration({
|
|
1919
|
+
// To configure API key authorization: api_key
|
|
1920
|
+
apiKey: "YOUR API KEY",
|
|
1921
|
+
});
|
|
1922
|
+
const api = new SEPApi(config);
|
|
1923
|
+
|
|
1924
|
+
const body = {
|
|
1925
|
+
// Array<string> | Data columns to filter by (optional)
|
|
1926
|
+
data: ...,
|
|
1927
|
+
// object | Facets to filter by (optional)
|
|
1928
|
+
facets: Object,
|
|
1929
|
+
// string | Frequency to filter by (optional)
|
|
1930
|
+
frequency: frequency_example,
|
|
1931
|
+
// string | Start date to filter by (optional)
|
|
1932
|
+
start: start_example,
|
|
1933
|
+
// string | End date to filter by (optional)
|
|
1934
|
+
end: end_example,
|
|
1935
|
+
// Sort | How to sort returned data (optional)
|
|
1936
|
+
sort: ...,
|
|
1937
|
+
// number | Max length of returned data (optional)
|
|
1938
|
+
length: 56,
|
|
1939
|
+
// number | Offset of returned data (optional)
|
|
1940
|
+
offset: 56,
|
|
1941
|
+
} satisfies V2ElectricityStateElectricityProfilesSourceDispositionDataGetRequest;
|
|
1942
|
+
|
|
1943
|
+
try {
|
|
1944
|
+
const data = await api.v2ElectricityStateElectricityProfilesSourceDispositionDataGet(body);
|
|
1945
|
+
console.log(data);
|
|
1946
|
+
} catch (error) {
|
|
1947
|
+
console.error(error);
|
|
1948
|
+
}
|
|
1949
|
+
}
|
|
1950
|
+
|
|
1951
|
+
// Run the test
|
|
1952
|
+
example().catch(console.error);
|
|
1953
|
+
```
|
|
1954
|
+
|
|
1955
|
+
### Parameters
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
| Name | Type | Description | Notes |
|
|
1959
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1960
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
1961
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
1962
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
1963
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
1964
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
1965
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
1966
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
1967
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
1968
|
+
|
|
1969
|
+
### Return type
|
|
1970
|
+
|
|
1971
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
1972
|
+
|
|
1973
|
+
### Authorization
|
|
1974
|
+
|
|
1975
|
+
[api_key](../README.md#api_key)
|
|
1976
|
+
|
|
1977
|
+
### HTTP request headers
|
|
1978
|
+
|
|
1979
|
+
- **Content-Type**: Not defined
|
|
1980
|
+
- **Accept**: `application/json`
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
### HTTP response details
|
|
1984
|
+
| Status code | Description | Response headers |
|
|
1985
|
+
|-------------|-------------|------------------|
|
|
1986
|
+
| **400** | Invalid input | - |
|
|
1987
|
+
| **200** | API Data | - |
|
|
1988
|
+
|
|
1989
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
## v2ElectricityStateElectricityProfilesSourceDispositionDataPost
|
|
1993
|
+
|
|
1994
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesSourceDispositionDataPost(dataParams)
|
|
1995
|
+
|
|
1996
|
+
Return sep source-disposition Data
|
|
1997
|
+
|
|
1998
|
+
Class SourceDispositionDataController Electricity SourceDisposition dataset controller.
|
|
1999
|
+
|
|
2000
|
+
### Example
|
|
2001
|
+
|
|
2002
|
+
```ts
|
|
2003
|
+
import {
|
|
2004
|
+
Configuration,
|
|
2005
|
+
SEPApi,
|
|
2006
|
+
} from '';
|
|
2007
|
+
import type { V2ElectricityStateElectricityProfilesSourceDispositionDataPostRequest } from '';
|
|
2008
|
+
|
|
2009
|
+
async function example() {
|
|
2010
|
+
console.log("🚀 Testing SDK...");
|
|
2011
|
+
const config = new Configuration({
|
|
2012
|
+
// To configure API key authorization: api_key
|
|
2013
|
+
apiKey: "YOUR API KEY",
|
|
2014
|
+
});
|
|
2015
|
+
const api = new SEPApi(config);
|
|
2016
|
+
|
|
2017
|
+
const body = {
|
|
2018
|
+
// DataParams | Parameters for data call
|
|
2019
|
+
dataParams: ...,
|
|
2020
|
+
} satisfies V2ElectricityStateElectricityProfilesSourceDispositionDataPostRequest;
|
|
2021
|
+
|
|
2022
|
+
try {
|
|
2023
|
+
const data = await api.v2ElectricityStateElectricityProfilesSourceDispositionDataPost(body);
|
|
2024
|
+
console.log(data);
|
|
2025
|
+
} catch (error) {
|
|
2026
|
+
console.error(error);
|
|
2027
|
+
}
|
|
2028
|
+
}
|
|
2029
|
+
|
|
2030
|
+
// Run the test
|
|
2031
|
+
example().catch(console.error);
|
|
2032
|
+
```
|
|
2033
|
+
|
|
2034
|
+
### Parameters
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
| Name | Type | Description | Notes |
|
|
2038
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2039
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
2040
|
+
|
|
2041
|
+
### Return type
|
|
2042
|
+
|
|
2043
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
2044
|
+
|
|
2045
|
+
### Authorization
|
|
2046
|
+
|
|
2047
|
+
[api_key](../README.md#api_key)
|
|
2048
|
+
|
|
2049
|
+
### HTTP request headers
|
|
2050
|
+
|
|
2051
|
+
- **Content-Type**: `application/json`
|
|
2052
|
+
- **Accept**: `application/json`
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
### HTTP response details
|
|
2056
|
+
| Status code | Description | Response headers |
|
|
2057
|
+
|-------------|-------------|------------------|
|
|
2058
|
+
| **400** | Invalid input | - |
|
|
2059
|
+
| **200** | API Data | - |
|
|
2060
|
+
|
|
2061
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
## v2ElectricityStateElectricityProfilesSourceDispositionFacetFacetIdGet
|
|
2065
|
+
|
|
2066
|
+
> FacetDetailsContainer v2ElectricityStateElectricityProfilesSourceDispositionFacetFacetIdGet(facetId)
|
|
2067
|
+
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
### Example
|
|
2071
|
+
|
|
2072
|
+
```ts
|
|
2073
|
+
import {
|
|
2074
|
+
Configuration,
|
|
2075
|
+
SEPApi,
|
|
2076
|
+
} from '';
|
|
2077
|
+
import type { V2ElectricityStateElectricityProfilesSourceDispositionFacetFacetIdGetRequest } from '';
|
|
2078
|
+
|
|
2079
|
+
async function example() {
|
|
2080
|
+
console.log("🚀 Testing SDK...");
|
|
2081
|
+
const config = new Configuration({
|
|
2082
|
+
// To configure API key authorization: api_key
|
|
2083
|
+
apiKey: "YOUR API KEY",
|
|
2084
|
+
});
|
|
2085
|
+
const api = new SEPApi(config);
|
|
2086
|
+
|
|
2087
|
+
const body = {
|
|
2088
|
+
// string | Facet ID
|
|
2089
|
+
facetId: facetId_example,
|
|
2090
|
+
} satisfies V2ElectricityStateElectricityProfilesSourceDispositionFacetFacetIdGetRequest;
|
|
2091
|
+
|
|
2092
|
+
try {
|
|
2093
|
+
const data = await api.v2ElectricityStateElectricityProfilesSourceDispositionFacetFacetIdGet(body);
|
|
2094
|
+
console.log(data);
|
|
2095
|
+
} catch (error) {
|
|
2096
|
+
console.error(error);
|
|
2097
|
+
}
|
|
2098
|
+
}
|
|
2099
|
+
|
|
2100
|
+
// Run the test
|
|
2101
|
+
example().catch(console.error);
|
|
2102
|
+
```
|
|
2103
|
+
|
|
2104
|
+
### Parameters
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
| Name | Type | Description | Notes |
|
|
2108
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2109
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
2110
|
+
|
|
2111
|
+
### Return type
|
|
2112
|
+
|
|
2113
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
2114
|
+
|
|
2115
|
+
### Authorization
|
|
2116
|
+
|
|
2117
|
+
[api_key](../README.md#api_key)
|
|
2118
|
+
|
|
2119
|
+
### HTTP request headers
|
|
2120
|
+
|
|
2121
|
+
- **Content-Type**: Not defined
|
|
2122
|
+
- **Accept**: `application/json`
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
### HTTP response details
|
|
2126
|
+
| Status code | Description | Response headers |
|
|
2127
|
+
|-------------|-------------|------------------|
|
|
2128
|
+
| **400** | Invalid input | - |
|
|
2129
|
+
| **200** | Facet details | - |
|
|
2130
|
+
|
|
2131
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
## v2ElectricityStateElectricityProfilesSourceDispositionFacetGet
|
|
2135
|
+
|
|
2136
|
+
> FacetOptionListContainer v2ElectricityStateElectricityProfilesSourceDispositionFacetGet()
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
### Example
|
|
2141
|
+
|
|
2142
|
+
```ts
|
|
2143
|
+
import {
|
|
2144
|
+
Configuration,
|
|
2145
|
+
SEPApi,
|
|
2146
|
+
} from '';
|
|
2147
|
+
import type { V2ElectricityStateElectricityProfilesSourceDispositionFacetGetRequest } from '';
|
|
2148
|
+
|
|
2149
|
+
async function example() {
|
|
2150
|
+
console.log("🚀 Testing SDK...");
|
|
2151
|
+
const config = new Configuration({
|
|
2152
|
+
// To configure API key authorization: api_key
|
|
2153
|
+
apiKey: "YOUR API KEY",
|
|
2154
|
+
});
|
|
2155
|
+
const api = new SEPApi(config);
|
|
2156
|
+
|
|
2157
|
+
try {
|
|
2158
|
+
const data = await api.v2ElectricityStateElectricityProfilesSourceDispositionFacetGet();
|
|
2159
|
+
console.log(data);
|
|
2160
|
+
} catch (error) {
|
|
2161
|
+
console.error(error);
|
|
2162
|
+
}
|
|
2163
|
+
}
|
|
2164
|
+
|
|
2165
|
+
// Run the test
|
|
2166
|
+
example().catch(console.error);
|
|
2167
|
+
```
|
|
2168
|
+
|
|
2169
|
+
### Parameters
|
|
2170
|
+
|
|
2171
|
+
This endpoint does not need any parameter.
|
|
2172
|
+
|
|
2173
|
+
### Return type
|
|
2174
|
+
|
|
2175
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
2176
|
+
|
|
2177
|
+
### Authorization
|
|
2178
|
+
|
|
2179
|
+
[api_key](../README.md#api_key)
|
|
2180
|
+
|
|
2181
|
+
### HTTP request headers
|
|
2182
|
+
|
|
2183
|
+
- **Content-Type**: Not defined
|
|
2184
|
+
- **Accept**: `application/json`
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
### HTTP response details
|
|
2188
|
+
| Status code | Description | Response headers |
|
|
2189
|
+
|-------------|-------------|------------------|
|
|
2190
|
+
| **400** | Invalid input | - |
|
|
2191
|
+
| **200** | List of facet options | - |
|
|
2192
|
+
|
|
2193
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2194
|
+
|
|
2195
|
+
|
|
2196
|
+
## v2ElectricityStateElectricityProfilesSourceDispositionGet
|
|
2197
|
+
|
|
2198
|
+
> FinalRouteResponseContainer v2ElectricityStateElectricityProfilesSourceDispositionGet()
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
### Example
|
|
2203
|
+
|
|
2204
|
+
```ts
|
|
2205
|
+
import {
|
|
2206
|
+
Configuration,
|
|
2207
|
+
SEPApi,
|
|
2208
|
+
} from '';
|
|
2209
|
+
import type { V2ElectricityStateElectricityProfilesSourceDispositionGetRequest } from '';
|
|
2210
|
+
|
|
2211
|
+
async function example() {
|
|
2212
|
+
console.log("🚀 Testing SDK...");
|
|
2213
|
+
const config = new Configuration({
|
|
2214
|
+
// To configure API key authorization: api_key
|
|
2215
|
+
apiKey: "YOUR API KEY",
|
|
2216
|
+
});
|
|
2217
|
+
const api = new SEPApi(config);
|
|
2218
|
+
|
|
2219
|
+
try {
|
|
2220
|
+
const data = await api.v2ElectricityStateElectricityProfilesSourceDispositionGet();
|
|
2221
|
+
console.log(data);
|
|
2222
|
+
} catch (error) {
|
|
2223
|
+
console.error(error);
|
|
2224
|
+
}
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
// Run the test
|
|
2228
|
+
example().catch(console.error);
|
|
2229
|
+
```
|
|
2230
|
+
|
|
2231
|
+
### Parameters
|
|
2232
|
+
|
|
2233
|
+
This endpoint does not need any parameter.
|
|
2234
|
+
|
|
2235
|
+
### Return type
|
|
2236
|
+
|
|
2237
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
2238
|
+
|
|
2239
|
+
### Authorization
|
|
2240
|
+
|
|
2241
|
+
[api_key](../README.md#api_key)
|
|
2242
|
+
|
|
2243
|
+
### HTTP request headers
|
|
2244
|
+
|
|
2245
|
+
- **Content-Type**: Not defined
|
|
2246
|
+
- **Accept**: `application/json`
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
### HTTP response details
|
|
2250
|
+
| Status code | Description | Response headers |
|
|
2251
|
+
|-------------|-------------|------------------|
|
|
2252
|
+
| **200** | List of API data sets | - |
|
|
2253
|
+
|
|
2254
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
## v2ElectricityStateElectricityProfilesSummaryDataGet
|
|
2258
|
+
|
|
2259
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesSummaryDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
API data with query params
|
|
2264
|
+
|
|
2265
|
+
### Example
|
|
2266
|
+
|
|
2267
|
+
```ts
|
|
2268
|
+
import {
|
|
2269
|
+
Configuration,
|
|
2270
|
+
SEPApi,
|
|
2271
|
+
} from '';
|
|
2272
|
+
import type { V2ElectricityStateElectricityProfilesSummaryDataGetRequest } from '';
|
|
2273
|
+
|
|
2274
|
+
async function example() {
|
|
2275
|
+
console.log("🚀 Testing SDK...");
|
|
2276
|
+
const config = new Configuration({
|
|
2277
|
+
// To configure API key authorization: api_key
|
|
2278
|
+
apiKey: "YOUR API KEY",
|
|
2279
|
+
});
|
|
2280
|
+
const api = new SEPApi(config);
|
|
2281
|
+
|
|
2282
|
+
const body = {
|
|
2283
|
+
// Array<string> | Data columns to filter by (optional)
|
|
2284
|
+
data: ...,
|
|
2285
|
+
// object | Facets to filter by (optional)
|
|
2286
|
+
facets: Object,
|
|
2287
|
+
// string | Frequency to filter by (optional)
|
|
2288
|
+
frequency: frequency_example,
|
|
2289
|
+
// string | Start date to filter by (optional)
|
|
2290
|
+
start: start_example,
|
|
2291
|
+
// string | End date to filter by (optional)
|
|
2292
|
+
end: end_example,
|
|
2293
|
+
// Sort | How to sort returned data (optional)
|
|
2294
|
+
sort: ...,
|
|
2295
|
+
// number | Max length of returned data (optional)
|
|
2296
|
+
length: 56,
|
|
2297
|
+
// number | Offset of returned data (optional)
|
|
2298
|
+
offset: 56,
|
|
2299
|
+
} satisfies V2ElectricityStateElectricityProfilesSummaryDataGetRequest;
|
|
2300
|
+
|
|
2301
|
+
try {
|
|
2302
|
+
const data = await api.v2ElectricityStateElectricityProfilesSummaryDataGet(body);
|
|
2303
|
+
console.log(data);
|
|
2304
|
+
} catch (error) {
|
|
2305
|
+
console.error(error);
|
|
2306
|
+
}
|
|
2307
|
+
}
|
|
2308
|
+
|
|
2309
|
+
// Run the test
|
|
2310
|
+
example().catch(console.error);
|
|
2311
|
+
```
|
|
2312
|
+
|
|
2313
|
+
### Parameters
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
| Name | Type | Description | Notes |
|
|
2317
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2318
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
2319
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
2320
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
2321
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
2322
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
2323
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
2324
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
2325
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
2326
|
+
|
|
2327
|
+
### Return type
|
|
2328
|
+
|
|
2329
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
2330
|
+
|
|
2331
|
+
### Authorization
|
|
2332
|
+
|
|
2333
|
+
[api_key](../README.md#api_key)
|
|
2334
|
+
|
|
2335
|
+
### HTTP request headers
|
|
2336
|
+
|
|
2337
|
+
- **Content-Type**: Not defined
|
|
2338
|
+
- **Accept**: `application/json`
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
### HTTP response details
|
|
2342
|
+
| Status code | Description | Response headers |
|
|
2343
|
+
|-------------|-------------|------------------|
|
|
2344
|
+
| **400** | Invalid input | - |
|
|
2345
|
+
| **200** | API Data | - |
|
|
2346
|
+
|
|
2347
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
## v2ElectricityStateElectricityProfilesSummaryDataPost
|
|
2351
|
+
|
|
2352
|
+
> DataResponseContainer v2ElectricityStateElectricityProfilesSummaryDataPost(dataParams)
|
|
2353
|
+
|
|
2354
|
+
Return sep summary Data
|
|
2355
|
+
|
|
2356
|
+
Class SourceSummaryDataController Electricity SourceSummary dataset controller.
|
|
2357
|
+
|
|
2358
|
+
### Example
|
|
2359
|
+
|
|
2360
|
+
```ts
|
|
2361
|
+
import {
|
|
2362
|
+
Configuration,
|
|
2363
|
+
SEPApi,
|
|
2364
|
+
} from '';
|
|
2365
|
+
import type { V2ElectricityStateElectricityProfilesSummaryDataPostRequest } from '';
|
|
2366
|
+
|
|
2367
|
+
async function example() {
|
|
2368
|
+
console.log("🚀 Testing SDK...");
|
|
2369
|
+
const config = new Configuration({
|
|
2370
|
+
// To configure API key authorization: api_key
|
|
2371
|
+
apiKey: "YOUR API KEY",
|
|
2372
|
+
});
|
|
2373
|
+
const api = new SEPApi(config);
|
|
2374
|
+
|
|
2375
|
+
const body = {
|
|
2376
|
+
// DataParams | Parameters for data call
|
|
2377
|
+
dataParams: ...,
|
|
2378
|
+
} satisfies V2ElectricityStateElectricityProfilesSummaryDataPostRequest;
|
|
2379
|
+
|
|
2380
|
+
try {
|
|
2381
|
+
const data = await api.v2ElectricityStateElectricityProfilesSummaryDataPost(body);
|
|
2382
|
+
console.log(data);
|
|
2383
|
+
} catch (error) {
|
|
2384
|
+
console.error(error);
|
|
2385
|
+
}
|
|
2386
|
+
}
|
|
2387
|
+
|
|
2388
|
+
// Run the test
|
|
2389
|
+
example().catch(console.error);
|
|
2390
|
+
```
|
|
2391
|
+
|
|
2392
|
+
### Parameters
|
|
2393
|
+
|
|
2394
|
+
|
|
2395
|
+
| Name | Type | Description | Notes |
|
|
2396
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2397
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
2398
|
+
|
|
2399
|
+
### Return type
|
|
2400
|
+
|
|
2401
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
2402
|
+
|
|
2403
|
+
### Authorization
|
|
2404
|
+
|
|
2405
|
+
[api_key](../README.md#api_key)
|
|
2406
|
+
|
|
2407
|
+
### HTTP request headers
|
|
2408
|
+
|
|
2409
|
+
- **Content-Type**: `application/json`
|
|
2410
|
+
- **Accept**: `application/json`
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
### HTTP response details
|
|
2414
|
+
| Status code | Description | Response headers |
|
|
2415
|
+
|-------------|-------------|------------------|
|
|
2416
|
+
| **400** | Invalid input | - |
|
|
2417
|
+
| **200** | API Data | - |
|
|
2418
|
+
|
|
2419
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
## v2ElectricityStateElectricityProfilesSummaryFacetFacetIdGet
|
|
2423
|
+
|
|
2424
|
+
> FacetDetailsContainer v2ElectricityStateElectricityProfilesSummaryFacetFacetIdGet(facetId)
|
|
2425
|
+
|
|
2426
|
+
|
|
2427
|
+
|
|
2428
|
+
### Example
|
|
2429
|
+
|
|
2430
|
+
```ts
|
|
2431
|
+
import {
|
|
2432
|
+
Configuration,
|
|
2433
|
+
SEPApi,
|
|
2434
|
+
} from '';
|
|
2435
|
+
import type { V2ElectricityStateElectricityProfilesSummaryFacetFacetIdGetRequest } from '';
|
|
2436
|
+
|
|
2437
|
+
async function example() {
|
|
2438
|
+
console.log("🚀 Testing SDK...");
|
|
2439
|
+
const config = new Configuration({
|
|
2440
|
+
// To configure API key authorization: api_key
|
|
2441
|
+
apiKey: "YOUR API KEY",
|
|
2442
|
+
});
|
|
2443
|
+
const api = new SEPApi(config);
|
|
2444
|
+
|
|
2445
|
+
const body = {
|
|
2446
|
+
// string | Facet ID
|
|
2447
|
+
facetId: facetId_example,
|
|
2448
|
+
} satisfies V2ElectricityStateElectricityProfilesSummaryFacetFacetIdGetRequest;
|
|
2449
|
+
|
|
2450
|
+
try {
|
|
2451
|
+
const data = await api.v2ElectricityStateElectricityProfilesSummaryFacetFacetIdGet(body);
|
|
2452
|
+
console.log(data);
|
|
2453
|
+
} catch (error) {
|
|
2454
|
+
console.error(error);
|
|
2455
|
+
}
|
|
2456
|
+
}
|
|
2457
|
+
|
|
2458
|
+
// Run the test
|
|
2459
|
+
example().catch(console.error);
|
|
2460
|
+
```
|
|
2461
|
+
|
|
2462
|
+
### Parameters
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
| Name | Type | Description | Notes |
|
|
2466
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2467
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
2468
|
+
|
|
2469
|
+
### Return type
|
|
2470
|
+
|
|
2471
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
2472
|
+
|
|
2473
|
+
### Authorization
|
|
2474
|
+
|
|
2475
|
+
[api_key](../README.md#api_key)
|
|
2476
|
+
|
|
2477
|
+
### HTTP request headers
|
|
2478
|
+
|
|
2479
|
+
- **Content-Type**: Not defined
|
|
2480
|
+
- **Accept**: `application/json`
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
### HTTP response details
|
|
2484
|
+
| Status code | Description | Response headers |
|
|
2485
|
+
|-------------|-------------|------------------|
|
|
2486
|
+
| **400** | Invalid input | - |
|
|
2487
|
+
| **200** | Facet details | - |
|
|
2488
|
+
|
|
2489
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
## v2ElectricityStateElectricityProfilesSummaryFacetGet
|
|
2493
|
+
|
|
2494
|
+
> FacetOptionListContainer v2ElectricityStateElectricityProfilesSummaryFacetGet()
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
### Example
|
|
2499
|
+
|
|
2500
|
+
```ts
|
|
2501
|
+
import {
|
|
2502
|
+
Configuration,
|
|
2503
|
+
SEPApi,
|
|
2504
|
+
} from '';
|
|
2505
|
+
import type { V2ElectricityStateElectricityProfilesSummaryFacetGetRequest } from '';
|
|
2506
|
+
|
|
2507
|
+
async function example() {
|
|
2508
|
+
console.log("🚀 Testing SDK...");
|
|
2509
|
+
const config = new Configuration({
|
|
2510
|
+
// To configure API key authorization: api_key
|
|
2511
|
+
apiKey: "YOUR API KEY",
|
|
2512
|
+
});
|
|
2513
|
+
const api = new SEPApi(config);
|
|
2514
|
+
|
|
2515
|
+
try {
|
|
2516
|
+
const data = await api.v2ElectricityStateElectricityProfilesSummaryFacetGet();
|
|
2517
|
+
console.log(data);
|
|
2518
|
+
} catch (error) {
|
|
2519
|
+
console.error(error);
|
|
2520
|
+
}
|
|
2521
|
+
}
|
|
2522
|
+
|
|
2523
|
+
// Run the test
|
|
2524
|
+
example().catch(console.error);
|
|
2525
|
+
```
|
|
2526
|
+
|
|
2527
|
+
### Parameters
|
|
2528
|
+
|
|
2529
|
+
This endpoint does not need any parameter.
|
|
2530
|
+
|
|
2531
|
+
### Return type
|
|
2532
|
+
|
|
2533
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
2534
|
+
|
|
2535
|
+
### Authorization
|
|
2536
|
+
|
|
2537
|
+
[api_key](../README.md#api_key)
|
|
2538
|
+
|
|
2539
|
+
### HTTP request headers
|
|
2540
|
+
|
|
2541
|
+
- **Content-Type**: Not defined
|
|
2542
|
+
- **Accept**: `application/json`
|
|
2543
|
+
|
|
2544
|
+
|
|
2545
|
+
### HTTP response details
|
|
2546
|
+
| Status code | Description | Response headers |
|
|
2547
|
+
|-------------|-------------|------------------|
|
|
2548
|
+
| **400** | Invalid input | - |
|
|
2549
|
+
| **200** | List of facet options | - |
|
|
2550
|
+
|
|
2551
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2552
|
+
|
|
2553
|
+
|
|
2554
|
+
## v2ElectricityStateElectricityProfilesSummaryGet
|
|
2555
|
+
|
|
2556
|
+
> FinalRouteResponseContainer v2ElectricityStateElectricityProfilesSummaryGet()
|
|
2557
|
+
|
|
2558
|
+
|
|
2559
|
+
|
|
2560
|
+
### Example
|
|
2561
|
+
|
|
2562
|
+
```ts
|
|
2563
|
+
import {
|
|
2564
|
+
Configuration,
|
|
2565
|
+
SEPApi,
|
|
2566
|
+
} from '';
|
|
2567
|
+
import type { V2ElectricityStateElectricityProfilesSummaryGetRequest } from '';
|
|
2568
|
+
|
|
2569
|
+
async function example() {
|
|
2570
|
+
console.log("🚀 Testing SDK...");
|
|
2571
|
+
const config = new Configuration({
|
|
2572
|
+
// To configure API key authorization: api_key
|
|
2573
|
+
apiKey: "YOUR API KEY",
|
|
2574
|
+
});
|
|
2575
|
+
const api = new SEPApi(config);
|
|
2576
|
+
|
|
2577
|
+
try {
|
|
2578
|
+
const data = await api.v2ElectricityStateElectricityProfilesSummaryGet();
|
|
2579
|
+
console.log(data);
|
|
2580
|
+
} catch (error) {
|
|
2581
|
+
console.error(error);
|
|
2582
|
+
}
|
|
2583
|
+
}
|
|
2584
|
+
|
|
2585
|
+
// Run the test
|
|
2586
|
+
example().catch(console.error);
|
|
2587
|
+
```
|
|
2588
|
+
|
|
2589
|
+
### Parameters
|
|
2590
|
+
|
|
2591
|
+
This endpoint does not need any parameter.
|
|
2592
|
+
|
|
2593
|
+
### Return type
|
|
2594
|
+
|
|
2595
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
2596
|
+
|
|
2597
|
+
### Authorization
|
|
2598
|
+
|
|
2599
|
+
[api_key](../README.md#api_key)
|
|
2600
|
+
|
|
2601
|
+
### HTTP request headers
|
|
2602
|
+
|
|
2603
|
+
- **Content-Type**: Not defined
|
|
2604
|
+
- **Accept**: `application/json`
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
### HTTP response details
|
|
2608
|
+
| Status code | Description | Response headers |
|
|
2609
|
+
|-------------|-------------|------------------|
|
|
2610
|
+
| **200** | List of API data sets | - |
|
|
2611
|
+
|
|
2612
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2613
|
+
|