# Revenue Segmentation

`GET` `/v1/revenue-segmentation/{ticker}`

Retrieve revenue broken down by business segment for equity tickers. Choose dimension product or geographic and period annual or quarterly. Each period includes segment labels and reported revenue amounts in the issuer’s reporting currency - the same data shown in company profile revenue segmentation charts.

## Use cases

- Product-line and geographic revenue mix analysis
- Segment trend charts on equity research pages
- Comparing segment growth across fiscal periods
- Feeding segment breakdowns into models and screeners

## Input parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `ticker` | string | Yes | Ticker. |
| `dimension` | string | No | product | geographic (default product). |
| `period` | string | No | annual | quarterly (default annual). |

## Output parameters

| Name | Type | Description |
| --- | --- | --- |
| `ticker` | string | Ticker. |
| `dimension` | string | product or geographic. |
| `period` | string | annual or quarterly. |
| `results` | array | Segmentation periods, most recent first. |
| `results[].fiscalYear` | integer | Fiscal year. |
| `results[].period` | string | Fiscal period label (e.g. FY or Q1). |
| `results[].date` | string | Period end date (YYYY-MM-DD). |
| `results[].reportedCurrency` | string | Reporting currency. |
| `results[].data` | object | Segment label → revenue amount map. |
| `count` | integer | Number of periods returned. |
| `syncedAt` | string | Segmentation sync timestamp (ISO 8601). |

## Example response

```json
{
  "ticker": "AAPL",
  "dimension": "product",
  "period": "annual",
  "results": [
    {
      "ticker": "AAPL",
      "fiscalYear": 2025,
      "period": "FY",
      "date": "2025-09-27",
      "reportedCurrency": "USD",
      "data": {
        "iPhone": 209580000000,
        "Services": 96169000000,
        "Mac": 29984000000,
        "Wearables, Home and Accessories": 35686000000,
        "iPad": 28023000000
      }
    }
  ],
  "count": 1,
  "syncedAt": "2026-06-05T22:02:50-04:00"
}
```

## Examples

### cURL

```bash
curl "https://api.vantafin.com/v1/revenue-segmentation/AAPL?dimension=product&period=annual&apiKey=$VANTAFIN_API_KEY"
```

### Python

```python
from vantafin import RESTClient

client = RESTClient("vf-live-your_api_key")

result = client.get_revenue_segmentation("AAPL", dimension="product", period="annual")

print(result)
```

### JavaScript

```javascript
import { RestClient } from "vantafin";

const client = new RestClient("vf-live-your_api_key");

const result = await client.getRevenueSegmentation("AAPL", { dimension: "product", period: "annual" });

console.log(result);
```

### Go

```go
package main

import (
	"fmt"
	"log"

	"github.com/vantafin/vantafin-go"
)

func main() {
	client := vantafin.NewClient("vf-live-your_api_key")

	result, err := client.GetRevenueSegmentation("AAPL", vantafin.Params{"dimension": "product", "period": "annual"})
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(result)
}
```

### Java

```java
import com.vantafin.RestClient;
import com.vantafin.Params;

public class Example {
    public static void main(String[] args) throws Exception {
        RestClient client = new RestClient("vf-live-your_api_key");

        Object result = client.getRevenueSegmentation("AAPL", Params.of().set("dimension", "product").set("period", "annual"));

        System.out.println(result);
    }
}
```

### Ruby

```ruby
require "vantafin"

client = Vantafin::RestClient.new("vf-live-your_api_key")

result = client.get_revenue_segmentation("AAPL", dimension: "product", period: "annual")

pp result
```