# Hedgewise SDK ## Overview Access to Hedgewise data provided by EarthDaily. ### Available Operations * [postFuturesForecasts](#postfuturesforecasts) - Get forecasts for a future supporting multiple date ranges and model selection * [getFuturesForecastsModels](#getfuturesforecastsmodels) - Get Forecast Models for a future * [getModelOutput](#getmodeloutput) - Get the output of a model for a given symbol * [getSupplyPhenology](#getsupplyphenology) - Get phenology stages information for a crop and country and or region * [userRegistration](#userregistration) - Register a user and generate an API Key ## postFuturesForecasts Returns a list of all forecasts made for a given future symbol, date range, and model name. Forecasts are made at various horizons, and can be interpolated to daily values. Forecasted prices, estimated lower and upper bounds, and market drivers are available for each forecast. ### Example Usage ```typescript import { Hedgewise } from "hedgewise"; const hedgewise = new Hedgewise({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const result = await hedgewise.postFuturesForecasts({ symbol: "ZC", postAssetForecastsRequest: { strategy: [ { startDate: "2025-04-24", endDate: "2025-04-24", trajectory: [], }, ], }, }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { HedgewiseCore } from "hedgewise/core.js"; import { postFuturesForecasts } from "hedgewise/funcs/postFuturesForecasts.js"; // Use `HedgewiseCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const hedgewise = new HedgewiseCore({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const res = await postFuturesForecasts(hedgewise, { symbol: "ZC", postAssetForecastsRequest: { strategy: [ { startDate: "2025-04-24", endDate: "2025-04-24", trajectory: [], }, ], }, }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("postFuturesForecasts failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostFuturesForecastsRequest](../../models/operations/postfuturesforecastsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.PostAssetForecastsResponse](../../models/components/postassetforecastsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.HTTPValidationError | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## getFuturesForecastsModels Return a list of all forecast models for a given future symbol. Forecast models generate forecasts at various horizons ### Example Usage ```typescript import { Hedgewise } from "hedgewise"; const hedgewise = new Hedgewise({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const result = await hedgewise.getFuturesForecastsModels({ symbol: "ZC", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { HedgewiseCore } from "hedgewise/core.js"; import { getFuturesForecastsModels } from "hedgewise/funcs/getFuturesForecastsModels.js"; // Use `HedgewiseCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const hedgewise = new HedgewiseCore({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const res = await getFuturesForecastsModels(hedgewise, { symbol: "ZC", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("getFuturesForecastsModels failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetFuturesForecastsModelsRequest](../../models/operations/getfuturesforecastsmodelsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.GetAssetForecastsModelsResponse](../../models/components/getassetforecastsmodelsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.HTTPValidationError | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## getModelOutput Returns all output from a requested model over a given time span. The model ### Example Usage ```typescript import { Hedgewise } from "hedgewise"; const hedgewise = new Hedgewise({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const result = await hedgewise.getModelOutput({ symbol: "KC", model: "coffee_arabica_v1_3", startDate: "2025-04-24", endDate: "2025-04-24", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { HedgewiseCore } from "hedgewise/core.js"; import { getModelOutput } from "hedgewise/funcs/getModelOutput.js"; // Use `HedgewiseCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const hedgewise = new HedgewiseCore({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const res = await getModelOutput(hedgewise, { symbol: "KC", model: "coffee_arabica_v1_3", startDate: "2025-04-24", endDate: "2025-04-24", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("getModelOutput failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetModelOutputRequest](../../models/operations/getmodeloutputrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.GetModelOutputResponse](../../models/components/getmodeloutputresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.HTTPValidationError | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## getSupplyPhenology Returns the month day of the beginning and end of phenology stages for a given crop and region ### Example Usage ```typescript import { Hedgewise } from "hedgewise"; const hedgewise = new Hedgewise({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const result = await hedgewise.getSupplyPhenology({ symbol: "KC", countryRegion: "brazil", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { HedgewiseCore } from "hedgewise/core.js"; import { getSupplyPhenology } from "hedgewise/funcs/getSupplyPhenology.js"; // Use `HedgewiseCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const hedgewise = new HedgewiseCore({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const res = await getSupplyPhenology(hedgewise, { symbol: "KC", countryRegion: "brazil", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("getSupplyPhenology failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetSupplyPhenologyRequest](../../models/operations/getsupplyphenologyrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.GetSupplyPhenologyResponse](../../models/components/getsupplyphenologyresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.HTTPValidationError | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## userRegistration Registers a user in Hedgewise and provides an API key ### Example Usage ```typescript import { Hedgewise } from "hedgewise"; const hedgewise = new Hedgewise({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { await hedgewise.userRegistration({ firstName: "Marquise", lastName: "Larkin", companyName: "Hoppe - Leannon", emailAddress: "Terrill.Harris@hotmail.com", }); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { HedgewiseCore } from "hedgewise/core.js"; import { userRegistration } from "hedgewise/funcs/userRegistration.js"; // Use `HedgewiseCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const hedgewise = new HedgewiseCore({ serverURL: "https://api.example.com", bearerAuth: process.env["HEDGEWISE_BEARER_AUTH"] ?? "", }); async function run() { const res = await userRegistration(hedgewise, { firstName: "Marquise", lastName: "Larkin", companyName: "Hoppe - Leannon", emailAddress: "Terrill.Harris@hotmail.com", }); if (res.ok) { const { value: result } = res; } else { console.log("userRegistration failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [components.UserRegistration](../../models/components/userregistration.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\** ### Errors | Error Type | Status Code | Content Type | | -------------------------------------- | -------------------------------------- | -------------------------------------- | | errors.GetUserRegistrationReponseError | 401 | application/json | | errors.HTTPValidationError | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* |