> ## Documentation Index
> Fetch the complete documentation index at: https://docs.axionquant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FinancialsAPI

> Financial statements and metrics

## revenue()

```typescript theme={null}
revenue(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get revenue data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

### Example

```typescript theme={null}
const revenue = await client.financials.revenue('AAPL', { periods: 8 });
```

## netIncome()

```typescript theme={null}
netIncome(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get net income data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

### Example

```typescript theme={null}
const netIncome = await client.financials.netIncome('AAPL');
```

## totalAssets()

```typescript theme={null}
totalAssets(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get total assets data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## totalLiabilities()

```typescript theme={null}
totalLiabilities(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get total liabilities data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## stockholdersEquity()

```typescript theme={null}
stockholdersEquity(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get stockholders equity data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## currentAssets()

```typescript theme={null}
currentAssets(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get current assets data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## currentLiabilities()

```typescript theme={null}
currentLiabilities(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get current liabilities data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## operatingCashFlow()

```typescript theme={null}
operatingCashFlow(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get operating cash flow data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## capitalExpenditures()

```typescript theme={null}
capitalExpenditures(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get capital expenditures data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## freeCashFlow()

```typescript theme={null}
freeCashFlow(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get free cash flow data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## sharesOutstandingBasic()

```typescript theme={null}
sharesOutstandingBasic(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get basic shares outstanding data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## sharesOutstandingDiluted()

```typescript theme={null}
sharesOutstandingDiluted(ticker: string, params?: { periods?: number }): Promise<ApiResponse>
```

Get diluted shares outstanding data.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

<ParamField path="params.periods" type="number" optional>
  Number of periods to return
</ParamField>

## metrics()

```typescript theme={null}
metrics(ticker: string): Promise<ApiResponse>
```

Get calculated financial metrics.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

### Example

```typescript theme={null}
const metrics = await client.financials.metrics('AAPL');
```

## snapshot()

```typescript theme={null}
snapshot(ticker: string): Promise<ApiResponse>
```

Get financial data snapshot.

<ParamField path="ticker" type="string" required>
  Stock ticker symbol
</ParamField>

### Example

```typescript theme={null}
const snapshot = await client.financials.snapshot('AAPL');
```