---
title: "Get supply benchmark data"
method: POST
path: "/supply"
tags: ["Supply"]
---

# Get supply benchmark data

`POST /supply`

Lightcast aggregates online social profiles from all over the web. The details in this endpoint provide aggregate totals for the top employers, top titles, and top skills associated with the profiles matching your search. Supply data is based on profiles that were updated within the last two years.

Advanced filtering is available for this endpoint. For more details, take a look at [Advanced Filtering](#advanced-filtering) section of this documentation.

## Request body

- Schema — unresolved $ref

## Response `200`

OK

- object
  - `searchParams` object, required
    - `area` union, required — This field will return a list of area objects if `advanced` filter was used. Otherwise, it will be an area object.
      - object
        - `id` string, required
        - `name` string, required
        - `level` string, required
      - object[]
        - `id` string, required
        - `name` string, required
        - `level` string, required
    - `title` object, nullable, required
      - `id` string, nullable, required
      - `name` string, nullable, required
    - `occupations` object[], required
      - `id` string, required
      - `name` string, required
    - `skills` object[], required
      - `id` string, required
      - `name` string, required
  - `data` object, required
    - `summary` object, required
      - `benchmarkIndex` number, nullable, required — Our supply benchmark index is a multiplier, comparing regional supply to national supply. `1.0` indicates the region is on par with national supply `null` indicates a lack of information to estimate the index.
      - `profiles` integer, required
      - `companies` integer, required
      - `supplyRating` string, nullable, required — `null` if there's no modeled supply rating or insufficient data for given filters. Only MSA areas are modeled at this time.
    - `companies` object[], required
      - `id` string, required
      - `name` string, required
      - `profiles` integer, required
    - `titles` object[], required
      - `id` string, required
      - `name` string, required
      - `profiles` integer, required
    - `skills` object[], required
      - `id` string, required
      - `name` string, required
      - `profiles` integer, required

## Other responses

- `400` — bad request
- `401` — unauthorized request
- `404` — requested resource not found

---

[API](https://skmtc.net/lightcast/apis/alumni-pathways-2-0.md) · [All operations](https://skmtc.net/lightcast/apis/alumni-pathways-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightcast/alumni-pathways-2-0/revisions/fc66b9877391/schema)