GET Variables

This endpoint returns the list of available variables for a given model, grouped by surface and upper air variables, as well as the vertical levels used by the model.

forecasts/v1/<model>/variablesforecasts/v1/<model>/variables

windborne variableswindborne variables

from windborne import get_variablesfrom windborne import get_variables

WeatherMesh-6

WeatherMesh-6 processes its 128 member-ensemble to output a number of summary statistics, including mean, standard deviation, percentiles, and threshold probabilities. The distribution_details field in the response below shows which fields are available for each parameter.

Query parameters

The curl command does not support any additional parameters.

Name	Description
-m --model	Set to wm-6 .

Name	Description
-m --model	Set to wm-6-3km .

Name	Description
-m --model	Set to mm .

Name	Description
-m --model	Set to wm-5c .

Name	Description
-m --model	Set to wm-4 .

Name	Description
-m --model	Set to ecmwf-det .

Name	Description
-m --model	Set to ecmwf-ens .

Name	Description
-m --model	Set to aifs .

Name	Description
-m --model	Set to gfs .

Name	Description
-m --model	Set to hrrr .

Name	Description
model	Set to wm-6 .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to wm-6-3km .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to mm .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to wm-5c .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to wm-4 .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to ecmwf-det .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to ecmwf-ens .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to aifs .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to gfs .
print_response Optional	Whether to print formatted output. Default: false

Name	Description
model	Set to hrrr .
print_response Optional	Whether to print formatted output. Default: false

Response parameters

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-
distribution_details	object	Available distribution outputs grouped by surface and upper-air variables.	-
sfc_variables	object	Surface variables, each mapping to an array of available distribution outputs.	-
<variable>	array	Available distribution outputs for this surface variable. Values: mean, std, members, percentiles, or thresholds.	-
upper_variables	object	Upper-air variables, each mapping to an object keyed by pressure level.	-
<variable>	object	Available distribution outputs for this upper-air variable, keyed by level.	-
default	array	Distribution outputs available at all pressure levels. Typically mean and std.	-
<level>	array	Statistics available at this specific level, overriding default. May include additional percentiles (p01–p99) beyond mean and std.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Name	Type	Description	Format
sfc_variables	array	List of surface-level variable identifiers.	-
variable	string	Surface variable identifier.	-
upper_variables	array	List of upper-air variable identifiers.	-
variable	string	Upper-air variable identifier.	-
levels	array	Available vertical levels supported by the model.	numbers or strings
level	string \| number	Level name or pressure level.	-

Examples

curl -H "Authorization: Bearer $WB_API_KEY" "https://api.windbornesystems.com/forecasts/v1/wm-6/variables"curl -H "Authorization: Bearer $WB_API_KEY" "https://api.windbornesystems.com/forecasts/v1/wm-6/variables"

content-type: application/json

1 {{

2 "sfc_variables": [ "sfc_variables": [

3 "boundary_layer_height", "boundary_layer_height",

4 "cape", "cape",

5 "cloud_base_height", "cloud_base_height",

6 "dewpoint_2m", "dewpoint_2m",

7 "direct_solar_radiation_3h", "direct_solar_radiation_3h",

8 "forecast_surface_roughness", "forecast_surface_roughness",

9 "high_cloud_cover", "high_cloud_cover",

10 "latent_heat_flux_3h", "latent_heat_flux_3h",

11 "low_cloud_cover", "low_cloud_cover",

12 "max_temperature_2m_3h", "max_temperature_2m_3h",

13 "mean_total_precipitation_rate", "mean_total_precipitation_rate",

14 "medium_cloud_cover", "medium_cloud_cover",

15 "min_temperature_2m_3h", "min_temperature_2m_3h",

16 "pressure_msl", "pressure_msl",

17 "runoff_3h", "runoff_3h",

18 "sensible_heat_flux_3h", "sensible_heat_flux_3h",

19 "short_wave_radiation", "short_wave_radiation",

20 "skin_temperature", "skin_temperature",

21 "snowfall_3h", "snowfall_3h",

22 "soil_moisture_level_1", "soil_moisture_level_1",

23 "soil_moisture_level_2", "soil_moisture_level_2",

24 "soil_temperature_level_1", "soil_temperature_level_1",

25 "soil_temperature_level_2", "soil_temperature_level_2",

26 "solar_radiation_downwards_3h", "solar_radiation_downwards_3h",

27 "surface_pressure", "surface_pressure",

28 "surface_solar_radiation_3h", "surface_solar_radiation_3h",

29 "temperature_2m", "temperature_2m",

30 "thermal_radiation_downwards_3h", "thermal_radiation_downwards_3h",

31 "top_solar_radiation_3h", "top_solar_radiation_3h",

32 "total_cloud_cover", "total_cloud_cover",

33 "total_column_water_vapour", "total_column_water_vapour",

34 "total_precipitation_3h", "total_precipitation_3h",

35 "wind_speed_100m", "wind_speed_100m",

36 "wind_speed_10m", "wind_speed_10m",

37 "wind_speed_250", "wind_speed_250",

38 "wind_u_100m", "wind_u_100m",

39 "wind_u_10m", "wind_u_10m",

40 "wind_v_100m", "wind_v_100m",

41 "wind_v_10m" "wind_v_10m"

42 ], ],

43 "upper_variables": [ "upper_variables": [

44 "geopotential", "geopotential",

45 "specific_humidity", "specific_humidity",

46 "temperature", "temperature",

47 "wind_u", "wind_u",

48 "wind_v" "wind_v"

49 ], ],

50 "levels": [ "levels": [

51 10, 10,

52 30, 30,

53 50, 50,

54 70, 70,

55 100, 100,

56 150, 150,

57 200, 200,

58 250, 250,

59 300, 300,

60 350, 350,

61 400, 400,

62 450, 450,

63 500, 500,

64 550, 550,

65 600, 600,

66 650, 650,

67 700, 700,

68 750, 750,

69 800, 800,

70 850, 850,

71 900, 900,

72 925, 925,

73 950, 950,

74 975, 975,

75 1000 1000

76 ], ],

77 "distribution_details": { "distribution_details": {

78 "sfc_variables": { "sfc_variables": {

79 "cape": [ "cape": [

80 "mean", "mean",

81 "std" "std"

82 ], ],

83 "runoff_3h": [ "runoff_3h": [

84 "mean", "mean",

85 "std" "std"

86 ], ],

87 "wind_u_10m": [ "wind_u_10m": [

88 "mean", "mean",

89 "std", "std",

90 "members" "members"

91 ], ],

92 "wind_v_10m": [ "wind_v_10m": [

93 "mean", "mean",

94 "std", "std",

95 "members" "members"

96 ], ],

97 "dewpoint_2m": [ "dewpoint_2m": [

98 "mean", "mean",

99 "std", "std",

100 "members", "members",

101 "p01", "p01",

102 "p05", "p05",

103 "p10", "p10",

104 "p25", "p25",

105 "p75", "p75",

106 "p90", "p90",

107 "p95", "p95",

108 "p99" "p99"

109 ], ],

110 "snowfall_3h": [ "snowfall_3h": [

111 "mean", "mean",

112 "std" "std"

113 ], ],

114 "wind_u_100m": [ "wind_u_100m": [

115 "mean", "mean",

116 "std", "std",

117 "members" "members"

118 ], ],

119 "wind_v_100m": [ "wind_v_100m": [

120 "mean", "mean",

121 "std", "std",

122 "members" "members"

123 ], ],

124 "pressure_msl": [ "pressure_msl": [

125 "mean", "mean",

126 "std", "std",

127 "members", "members",

128 "p01", "p01",

129 "p05", "p05",

130 "p10", "p10",

131 "p25", "p25",

132 "p75", "p75",

133 "p90", "p90",

134 "p95", "p95",

135 "p99" "p99"

136 ], ],

137 "temperature_2m": [ "temperature_2m": [

138 "mean", "mean",

139 "std", "std",

140 "members", "members",

141 "p01", "p01",

142 "p05", "p05",

143 "p10", "p10",

144 "p25", "p25",

145 "p75", "p75",

146 "p90", "p90",

147 "p95", "p95",

148 "p99" "p99"

149 ], ],

150 "wind_speed_10m": [ "wind_speed_10m": [

151 "mean", "mean",

152 "std", "std",

153 "p01", "p01",

154 "p05", "p05",

155 "p10", "p10",

156 "p25", "p25",

157 "p75", "p75",

158 "p90", "p90",

159 "p95", "p95",

160 "p99" "p99"

161 ], ],

162 "wind_speed_250": [ "wind_speed_250": [

163 "mean", "mean",

164 "std", "std",

165 "p01", "p01",

166 "p05", "p05",

167 "p10", "p10",

168 "p25", "p25",

169 "p75", "p75",

170 "p90", "p90",

171 "p95", "p95",

172 "p99" "p99"

173 ], ],

174 "low_cloud_cover": [ "low_cloud_cover": [

175 "mean", "mean",

176 "std" "std"

177 ], ],

178 "wind_speed_100m": [ "wind_speed_100m": [

179 "mean", "mean",

180 "std", "std",

181 "p01", "p01",

182 "p05", "p05",

183 "p10", "p10",

184 "p25", "p25",

185 "p75", "p75",

186 "p90", "p90",

187 "p95", "p95",

188 "p99" "p99"

189 ], ],

190 "high_cloud_cover": [ "high_cloud_cover": [

191 "mean", "mean",

192 "std" "std"

193 ], ],

194 "skin_temperature": [ "skin_temperature": [

195 "mean", "mean",

196 "std" "std"

197 ], ],

198 "surface_pressure": [ "surface_pressure": [

199 "mean", "mean",

200 "std" "std"

201 ], ],

202 "cloud_base_height": [ "cloud_base_height": [

203 "mean", "mean",

204 "std" "std"

205 ], ],

206 "total_cloud_cover": [ "total_cloud_cover": [

207 "mean", "mean",

208 "std" "std"

209 ], ],

210 "medium_cloud_cover": [ "medium_cloud_cover": [

211 "mean", "mean",

212 "std" "std"

213 ], ],

214 "latent_heat_flux_3h": [ "latent_heat_flux_3h": [

215 "mean", "mean",

216 "std" "std"

217 ], ],

218 "short_wave_radiation": [ "short_wave_radiation": [

219 "mean", "mean",

220 "std" "std"

221 ], ],

222 "boundary_layer_height": [ "boundary_layer_height": [

223 "mean", "mean",

224 "std" "std"

225 ], ],

226 "max_temperature_2m_3h": [ "max_temperature_2m_3h": [

227 "mean", "mean",

228 "std", "std",

229 "p01", "p01",

230 "p05", "p05",

231 "p10", "p10",

232 "p25", "p25",

233 "p75", "p75",

234 "p90", "p90",

235 "p95", "p95",

236 "p99" "p99"

237 ], ],

238 "min_temperature_2m_3h": [ "min_temperature_2m_3h": [

239 "mean", "mean",

240 "std", "std",

241 "p01", "p01",

242 "p05", "p05",

243 "p10", "p10",

244 "p25", "p25",

245 "p75", "p75",

246 "p90", "p90",

247 "p95", "p95",

248 "p99" "p99"

249 ], ],

250 "sensible_heat_flux_3h": [ "sensible_heat_flux_3h": [

251 "mean", "mean",

252 "std" "std"

253 ], ],

254 "soil_moisture_level_1": [ "soil_moisture_level_1": [

255 "mean", "mean",

256 "std" "std"

257 ], ],

258 "soil_moisture_level_2": [ "soil_moisture_level_2": [

259 "mean", "mean",

260 "std" "std"

261 ], ],

262 "top_solar_radiation_3h": [ "top_solar_radiation_3h": [

263 "mean", "mean",

264 "std" "std"

265 ], ],

266 "total_precipitation_3h": [ "total_precipitation_3h": [

267 "mean", "mean",

268 "std", "std",

269 "members", "members",

270 "gt_0p25mm", "gt_0p25mm",

271 "gt_2p5mm", "gt_2p5mm",

272 "gt_6mm", "gt_6mm",

273 "gt_12p5mm", "gt_12p5mm",

274 "gt_25mm", "gt_25mm",

275 "gt_50mm" "gt_50mm"

276 ], ],

277 "soil_temperature_level_1": [ "soil_temperature_level_1": [

278 "mean", "mean",

279 "std" "std"

280 ], ],

281 "soil_temperature_level_2": [ "soil_temperature_level_2": [

282 "mean", "mean",

283 "std" "std"

284 ], ],

285 "direct_solar_radiation_3h": [ "direct_solar_radiation_3h": [

286 "mean", "mean",

287 "std" "std"

288 ], ],

289 "total_column_water_vapour": [ "total_column_water_vapour": [

290 "mean", "mean",

291 "std" "std"

292 ], ],

293 "forecast_surface_roughness": [ "forecast_surface_roughness": [

294 "mean", "mean",

295 "std" "std"

296 ], ],

297 "surface_solar_radiation_3h": [ "surface_solar_radiation_3h": [

298 "mean", "mean",

299 "std" "std"

300 ], ],

301 "solar_radiation_downwards_3h": [ "solar_radiation_downwards_3h": [

302 "mean", "mean",

303 "std", "std",

304 "members", "members",

305 "p01", "p01",

306 "p05", "p05",

307 "p10", "p10",

308 "p25", "p25",

309 "p75", "p75",

310 "p90", "p90",

311 "p95", "p95",

312 "p99" "p99"

313 ], ],

314 "mean_total_precipitation_rate": [ "mean_total_precipitation_rate": [

315 "mean", "mean",

316 "std" "std"

317 ], ],

318 "thermal_radiation_downwards_3h": [ "thermal_radiation_downwards_3h": [

319 "mean", "mean",

320 "std" "std"

321 ] ]

322 }, },

323 "upper_variables": { "upper_variables": {

324 "wind_u": { "wind_u": {

325 "default": [ "default": [

326 "mean", "mean",

327 "std" "std"

328 ] ]

329 }, },

330 "wind_v": { "wind_v": {

331 "default": [ "default": [

332 "mean", "mean",

333 "std" "std"

334 ] ]

335 }, },

336 "temperature": { "temperature": {

337 "250": [ "250": [

338 "mean", "mean",

339 "std", "std",

340 "p01", "p01",

341 "p05", "p05",

342 "p10", "p10",

343 "p25", "p25",

344 "p75", "p75",

345 "p90", "p90",

346 "p95", "p95",

347 "p99" "p99"

348 ], ],

349 "850": [ "850": [

350 "mean", "mean",

351 "std", "std",

352 "p01", "p01",

353 "p05", "p05",

354 "p10", "p10",

355 "p25", "p25",

356 "p75", "p75",

357 "p90", "p90",

358 "p95", "p95",

359 "p99" "p99"

360 ], ],

361 "default": [ "default": [

362 "mean", "mean",

363 "std" "std"

364 ] ]

365 }, },

366 "geopotential": { "geopotential": {

367 "500": [ "500": [

368 "mean", "mean",

369 "std", "std",

370 "members", "members",

371 "p01", "p01",

372 "p05", "p05",

373 "p10", "p10",

374 "p25", "p25",

375 "p75", "p75",

376 "p90", "p90",

377 "p95", "p95",

378 "p99" "p99"

379 ], ],

380 "default": [ "default": [

381 "mean", "mean",

382 "std" "std"

383 ] ]

384 }, },

385 "specific_humidity": { "specific_humidity": {

386 "default": [ "default": [

387 "mean", "mean",

388 "std" "std"

389 ] ]

390 } }

391 } }

392 } }

393 }}