Profiles API

Access company profiles, statistics, and calendar events

The Profiles API provides comprehensive company information including profiles, recommendations, statistics, summaries, and calendar events.

Get Company Profile

Retrieve detailed profile information for a company.

const profile = await axion.profiles.profile('AAPL');

ticker · string · required

The stock ticker symbol (e.g., ‘AAPL’, ‘TSLA’)

data · object

Company profile data including business description, sector, industry, and key details

Get Recommendation Trend

Retrieve analyst recommendation trends for a company.

const recommendations = await axion.profiles.recommendation('AAPL');

ticker · string · required

The stock ticker symbol

data · object

Recommendation trend data showing buy, hold, and sell ratings over time

Get Key Statistics

Retrieve key financial statistics for a company.

const stats = await axion.profiles.statistics('AAPL');

ticker · string · required

The stock ticker symbol

data · object

Key statistics including market cap, P/E ratio, dividend yield, and more

Get Summary Detail

Retrieve summary details for a company.

const summary = await axion.profiles.summary('AAPL');

ticker · string · required

The stock ticker symbol

data · object

Summary detail data including price information and market metrics

Get Calendar Events

Retrieve upcoming calendar events including earnings and dividend dates.

const calendar = await axion.profiles.calendar('AAPL');

ticker · string · required

The stock ticker symbol

data · object

Calendar events including earnings dates, ex-dividend dates, and dividend payment dates

Get Company Info

Retrieve summary company information and profile.

const info = await axion.profiles.info('AAPL');

ticker · string · required

The stock ticker symbol

data · object

Company information including business summary, sector, industry, employees, and contact details

Example Usage

Here’s a complete example showing how to fetch various profile data:

import { Axion } from 'axion-sdk';

const axion = new Axion('your-api-key');

async function getCompanyOverview(ticker: string) {
  try {
    // Get basic company info
    const info = await axion.profiles.info(ticker);
    console.log('Company:', info.data.longName);
    console.log('Sector:', info.data.sector);
    
    // Get key statistics
    const stats = await axion.profiles.statistics(ticker);
    console.log('Market Cap:', stats.data.marketCap);
    console.log('P/E Ratio:', stats.data.trailingPE);
    
    // Get upcoming events
    const calendar = await axion.profiles.calendar(ticker);
    console.log('Next Earnings:', calendar.data.earningsDate);
    
    // Get analyst recommendations
    const recommendations = await axion.profiles.recommendation(ticker);
    console.log('Recommendations:', recommendations.data);
    
  } catch (error) {
    console.error('Error fetching profile data:', error);
  }
}

getCompanyOverview('AAPL');