Live Glitch 🌞Demo🌞
TypeScript library for querying the Solcast API async/Promise based
This module allows a registered users to query the Solcast API https://api.solcast.com.au. You will need to register your user account to obtain an API key https://solcast.com.au/api/register. Without an API key you will not be able to successfully obtain valid API results.
Returns a PowerForecast promise at the location of the LatLng point input
export interface PowerForecast {
forecasts: Forecast[];
}
export interface Forecast {
period_end: Date;
period: string;
pv_estimate: number;
}Return RadiationForecast promise at the location of the LatLng point input
export interface RadiationForecast {
forecasts: Forecast[];
}
export interface Forecast {
ghi: number;
ghi90: number;
ghi10: number;
ebh: number;
dni: number;
dni10: number;
dni90: number;
dhi: number;
air_temp: number;
zenith: number;
azimuth: number;
cloud_opacity: number;
period_end: Date;
period: string;
}You can use standard environment variables to hold your API key and not need to pass the optional {Radiation|Power}Options object to each function
Environment variable names
SOLCAST_API_KEY
SOLCAST_API_URL
Accessible through common process environment variable.
process.env.SOLCAST_API_KEY
process.env.SOLCAST_API_URL
import * as solcast from 'solcast';
const point = solcast.latLng(-33.865143, 151.209900); // Sydney, Australia
const radiationOptions = solcast.Options.radiation();
radiationOptions.APIKey = 'YOUR API KEY HERE';
const promiseFn = solcast.Radiation.forecast(point, radiationOptions);
promiseFn.then(results => {
console.log(results);
})
.catch(err => {
console.log(err);
});const solcast = require('solcast');
const point = solcast.latLng(-33.865143, 151.209900); // Sydney, Australia
const radiationOptions = solcast.Options.radiation();
radiationOptions.APIKey = 'YOUR API KEY HERE';
const fn = async function() {
return await solcast.Radiation.forecast(point, radiationOptions)
};
fn().then(results => {
console.log(results);
})
.catch(err => {
console.log(err);
});const solcast = require('solcast');
const point = solcast.latLng(-33.865143, 151.209900); // Sydney, Australia
const radiationOptions = solcast.Options.radiation();
radiationOptions.APIKey = 'YOUR API KEY HERE';
const results = solcast.Radiation.forecast(point, radiationOptions);
results.then(results => {
console.log(results);
})
.catch(err => {
console.log(err);
});{ forecasts:
[ { ghi: 0,
ghi90: 0,
ghi10: 0,
ebh: 0,
dni: 0,
dni10: 0,
dni90: 0,
dhi: 0,
air_temp: 10,
zenith: 103,
azimuth: -88,
cloud_opacity: 3,
period_end: '2017-08-31T19:30:00.0000000Z',
period: 'PT30M' },
...
]
}
- Copy
.env.json.sampleto.env.json - Set
SOLCAST_API_KEYon json file after register from https://solcast.com.au/api/register/
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent