zhoub / fmpcloud-go

Go API client for Financial Modeling Prep (fmpcloud.io)

Go API client for Financial Modeling Prep (fmpcloud.io)

Overview

• API documentation FmpCloud or Financial Modeling Prep
• API version: 3/4
• Package version: 2.7.0

Support Methods

• Company Valuation

• Calendars

• Institutional Fund

• International Filings

• Stock Time Series

• Market Indexes

• Commodities

• ETF

• Mutual Funds

• EuroNext

• TSX

• Stock Market

• Cryptocurrencies

• Forex (FX)

• Technical Indicators

• Stock Analysis

• Economic Calendar

• Formulas

• Status

• Insider Trading

• Alternative Data

• Bulk Endpoints

Installation

go get -u github.com/zhoub/fmpcloud-go@v2.1.0

Example:

APIClient, err := NewAPIClient(Config{APIKey: "YOU_KEY"})
if err != nil {
    log.Println("Error init api client: " + err.Error())
}

// Get rating by symbol
rating, err := APIClient.CompanyValuation.Rating("AAPL")
if err != nil {
    log.Println("Error get rating: " + err.Error())
}

// Get Company profile by symbol
profile, err := APIClient.Stock.CompanyProfile("AAPL")
if err != nil {
    log.Println("Error get company profile: " + err.Error())
}

// Get real-time single quote
quote, err := APIClient.Stock.Quote("AAPL")
if err != nil {
    log.Println("Error get quote: " + err.Error())
}

// Crypto avalible symbol list
cList, err := APIClient.Crypto.AvalibleSymbols()
if err != nil {
    log.Println("Error get crypto symbols list: " + err.Error())
}

// Crypto quotes list
cQuotes, err := APIClient.Crypto.Quotes()
if err != nil {
    log.Println("Error get crypto quotes: " + err.Error())
}

// Forex avalible symbol list
fList, err := APIClient.Forex.AvalibleSymbols()
if err != nil {
    log.Println("Error get forex symbols list: " + err.Error())
}

// Forex quotes list
fQuotes, err := APIClient.Forex.Quotes()
if err != nil {
    log.Println("Error get forex quotes: " + err.Error())
}

Example custom client:

// Init new instance for zap logger and config custom
cfg := zap.NewProductionConfig()
cfg.EncoderConfig.EncodeTime = zapcore.RFC3339TimeEncoder

logger, err := cfg.Build()
if err != nil {
    return nil, errors.Wrap(err, "Logger Error: init")
}

// Init your custome API client
APIClient, err := NewAPIClient(Config{
    APIKey:  "YOU_KEY",      // Set Your API Key from site, default: demo
    Debug:   true,           // Set flag for debug request and response, default: false
    Timeout: 60,             // Set timeout for http client, default: 25
    APIUrl:  APIFmpcloudURL, // Set custom url (APIFmpcloudURL || APIFinancialModelingPrepURL), default: APIFinancialModelingPrepURL
    Logger:  logger,         // Set your (zap) logger, default: init new
})

if err != nil {
    log.Println("Error init api client: " + err.Error())
}

FAQ

Historical candles support (count) (Daily from 1980):

• 1 minute 400 periods (1 day)
• 5 minutes 400 periods (1 week)
• 15 min 200 periods (2 days)
• 30 minutes 200 periods (4 days)
• 1 hour 200 periods (8 days)
• 4 hours 200 periods (33 days)

License

MIT