---
title: "GET /api/public/home"
method: GET
path: "/api/public/home"
tags: ["Public"]
---

# GET /api/public/home

`GET /api/public/home`

## Request

- Base URL: `https://idkrx.com`
- URL: `https://idkrx.com/api/public/home`
- Auth: none required

Trending medications, top reported activity and the newest shortages, as on the home page

## Response `200`

Cached for 10 minutes

- PublicHome
  - `top` TopActivitySnapshot, nullable, required
    - `ts` string, required
    - `data` TopActivity, required
      - `day` TopActivityItem[], required
        - `nName` string, required
        - `disp` string, required
        - `locs` integer, required
        - `av` integer, required
        - `li` integer, required
        - `un` integer, required
        - `rep` boolean
        - `t` boolean
        - `brand` string
        - `generic` string
        - `cat` string
      - `week` TopActivityItem[], required
        - `nName` string, required
        - `disp` string, required
        - `locs` integer, required
        - `av` integer, required
        - `li` integer, required
        - `un` integer, required
        - `rep` boolean
        - `t` boolean
        - `brand` string
        - `generic` string
        - `cat` string
      - `month` TopActivityItem[], required
        - `nName` string, required
        - `disp` string, required
        - `locs` integer, required
        - `av` integer, required
        - `li` integer, required
        - `un` integer, required
        - `rep` boolean
        - `t` boolean
        - `brand` string
        - `generic` string
        - `cat` string
      - `all` TopActivityItem[], required
        - `nName` string, required
        - `disp` string, required
        - `locs` integer, required
        - `av` integer, required
        - `li` integer, required
        - `un` integer, required
        - `rep` boolean
        - `t` boolean
        - `brand` string
        - `generic` string
        - `cat` string
  - `trends` TrendingSnapshot, nullable, required
    - `ts` string, required
    - `data` TrendingMedication[], required
      - `nName` string, required
      - `disp` string, required
      - `isBrand` boolean
  - `geo` HomeGeoSnapshot, nullable, required
    - `ts` string, required
    - `data` object, required
    - `cmap` object, required
  - `geoCountry` string, required
  - `recentShortages` ShortageGroup[], required
    - `id` string, required
    - `med` object, required
      - `n` union, required
        - string
        - string[]
      - `nName` string, required
      - `disp` string, required
      - `t` boolean, required
      - `cat` string
      - `brand` string
      - `brandId` union
        - string
        - object
          - `_id` string, required
          - `nName` string, required
          - `disp` string, required
          - `t` boolean, required
      - `genericId` union
        - string
        - object
          - `_id` string, required
          - `nName` string, required
          - `disp` string, required
          - `t` boolean, required
      - `generic` union
        - string[]
        - string
      - `nForm` string
      - `nAmount` string
      - `form` string
      - `amount` union
        - string
        - string[]
      - `labels` union
        - string
        - string[]
      - `thera_cat` string, required
      - `formId` string, required
      - `medId` string, required
      - `amountId` string, required
      - `release` string
    - `manufacturerGroups` object[], required
      - `key` string, required
      - `details` object[], required
        - `company_name` string, required
        - `parent_company_name` string
        - `labeler` string, required
        - `product_ndc` string, required
        - `supply_status` string, required
        - `resolved_note` string
        - `status` string, required
        - `update_type` string, required
        - `packages` string[], required
        - `phone` string
        - `email` string
        - `related_info` string
        - `shortage_reason` string
        - `change_date` string
        - `update_date` string, required
        - `initial_posting_date` string
        - `discontinuation_date` string
        - `est_last` string
        - `est_recovery` string
        - `est_resupply` string
        - `est_shortage` string
        - `rxr` string
        - `rxs` string
        - `rxo` string
        - `rxl` string
        - `rx_score` number
        - `st` string
    - `status` object, required
      - `label` string, required
      - `description` string, required
      - `counts` object, required
      - `records` object[], required
      - `latest` string, nullable, required
      - `prod_nums` number, required
      - `summaryStatus` string
      - `summaryCount` number

## Other responses

- `429`: Rate limited

---

[API](https://skmtc.dev/idkrx/apis/idkrx-api.md) · [All operations](https://skmtc.dev/idkrx/apis/idkrx-api/llms.txt) · [OpenAPI document](https://skmtc.dev/idkrx/apis/idkrx-api/revisions/086725fb5578?raw)