Getting Started

API Reference

Dashboard

Examples

SDKs & Libraries

Official SDKs

Use our official SDKs to integrate ForecastAPI into your applications quickly and easily. All SDKs are generated from our OpenAPI specification and provide full type safety.

Our SDKs are designed to make integration with ForecastAPI seamless. They provide type safety, automatic request signing, and handle response parsing for you. All SDKs are generated from our OpenAPI specification to ensure they're always up-to-date with the latest API features.

Available SDKs

PHP

Composer Package

Official PHP SDK with full support for Laravel integration.

PHP 8.1+

Composer

View on GitHub →

Python

PyPI Package

Official Python SDK with support for asyncio and data science workflows.

Python 3.8+

pip

View on GitHub →

JavaScript / TypeScript

NPM Package

Official TypeScript SDK with full type definitions and browser support.

TypeScript

npm/yarn

View on GitHub →

Go

Go Module

Official Go SDK with high performance and minimal dependencies.

Go 1.19+

go get

View on GitHub →

Ruby

RubyGem

Official Ruby SDK with Rails integration and idiomatic Ruby code.

Ruby 2.7+

gem

View on GitHub →

Java

Maven Package

Official Java SDK with Spring Boot integration and async support.

Java 11+

Maven

View on GitHub →

Quick Start

All SDKs follow a similar pattern. Here are examples to get you started:

Installation

composer require forecastapi/php-sdk

Usage

use ForecastAPI\Client;

$client = new Client('your-api-key');
$forecast = $client->forecast([
    'data' => [
        ['date' => '2024-01', 'value' => 100],
        ['date' => '2024-02', 'value' => 120],
        ['date' => '2024-03', 'value' => 110],
    ],
    'periods' => 6,
    'frequency' => 'M',
    'data_type' => 'sales'
]);

echo $forecast['result']['forecast_value'];

Installation

pip install forecastapi

Usage

from forecastapi import ForecastAPI

client = ForecastAPI(api_key='your-api-key')
forecast = client.forecast(
    data=[
        {'date': '2024-01', 'value': 100},
        {'date': '2024-02', 'value': 120},
        {'date': '2024-03', 'value': 110},
    ],
    periods=6,
    frequency='M',
    data_type='sales'
)

print(forecast['result']['forecast_value'])

Installation

npm install @forecastapi/client
# or
yarn add @forecastapi/client

Usage

import { ForecastAPI } from '@forecastapi/client';

const client = new ForecastAPI('your-api-key');
const forecast = await client.forecast({
    data: [
        { date: '2024-01', value: 100 },
        { date: '2024-02', value: 120 },
        { date: '2024-03', value: 110 },
    ],
    periods: 6,
    frequency: 'M',
    dataType: 'sales'
});

console.log(forecast.result.forecastValue);

Installation

go get github.com/forecastapi/go-sdk

Usage

import "github.com/forecastapi/go-sdk"

client := forecastapi.NewClient("your-api-key")
forecast, err := client.Forecast(&forecastapi.ForecastRequest{
    Data: []forecastapi.DataPoint{
        {Date: "2024-01", Value: 100},
        {Date: "2024-02", Value: 120},
        {Date: "2024-03", Value: 110},
    },
    Periods:   6,
    Frequency: "M",
    DataType:  "sales",
})

if err != nil {
    log.Fatal(err)
}
fmt.Println(forecast.Result.ForecastValue)

OpenAPI Specification

Our OpenAPI specification allows you to generate SDKs for any language or framework that supports OpenAPI 3.0.3. This is perfect if you need:

Custom Integrations

Generate SDKs for specific frameworks or languages not covered by our official SDKs.

Type Safety

Generate typed clients that match our API schema exactly.

Documentation

Use the spec to generate interactive API documentation.

Download OpenAPI Spec

Download openapi.yaml

Download our complete OpenAPI 3.0.3 specification and use it with tools like:

OpenAPI Generator Swagger Codegen Postman Insomnia

Need Help?

If you need help with any SDK or have questions about integration, our support team is here to help.

Contact Support Open an Issue