Documentação / Referência da API

Contar os registros de um nome

GET/v1/drugs/overview

Conta os registros de um país que trazem um nome exato, como um princípio ativo ou uma marca: quantos são, de quais tipos, de quais detentores e em quais situações administrativas e de prescrição. O nome é comparado por inteiro, ignorando acentos e diferenças entre maiúsculas e minúsculas, então uma associação que apenas o contenha não é contada. Para listar os registros em si, busque com match=exact.

Parâmetros

country string Obrigatório
Código de país ISO 3166-1 de duas letras, em minúsculas. Cada busca é restrita a um único país.
name string Obrigatório
O nome exato a contar, de 3 a 120 caracteres. Acentos e diferenças entre maiúsculas e minúsculas são ignorados.
kinds string
Conta apenas estes tipos de registro, informados como pares sourceId:kind do país solicitado, separados por vírgula, no máximo 12.

Retorna

country string
O país da busca.
name string
O nome contado, tal como foi comparado.
records integer
Quantos registros trazem o nome.
truncated boolean
Verdadeiro quando mais de 20.000 registros trazem o nome; nesse caso, todas as contagens abrangem os primeiros 20.000.
holders integer
Quantos detentores distintos esses registros citam, no campo holder, labeler ou sponsor que a fonte publica.
kinds object[]
Os registros por fonte e tipo, no formato { sourceId, kind, records }, com os maiores primeiro.
administrativeStatuses object[]
Os registros por situação administrativa, no formato { value, records }, nas palavras da própria fonte; unknown quando ela não informa nenhuma.
prescriptionCategories object[]
Os registros por categoria de prescrição, no formato { value, records }.
topHolders object[]
Os 25 detentores com mais registros, no formato { name, records }, com a grafia usada pela fonte.

Erros

400 401 403 429 503 · Erros e limites de requisições

GET /v1/drugs/overview
curl -G https://api.medifontis.com/v1/drugs/overview \
  -H "Authorization: Bearer $MEDIFONTIS_API_KEY" \
  --data-urlencode "country=br" \
  --data-urlencode "name=dipirona sodica"
Resposta
{
  "country": "br",
  "name": "dipirona sodica",
  "records": 37,
  "truncated": false,
  "holders": 11,
  "kinds": [
    {
      "sourceId": "br.anvisa.cmed-prices",
      "kind": "presentations",
      "records": 37
    }
  ],
  "administrativeStatuses": [
    {
      "value": "unknown",
      "records": 37
    }
  ],
  "prescriptionCategories": [
    {
      "value": "non-prescription",
      "records": 32
    },
    {
      "value": "unknown",
      "records": 5
    }
  ],
  "topHolders": [
    {
      "name": "PRATI DONADUZZI & CIA LTDA",
      "records": 10
    },
    {
      "name": "BRAINFARMA INDÚSTRIA QUÍMICA E FARMACÊUTICA S.A",
      "records": 6
    },
    {
      "name": "FARMACE INDÚSTRIA QUÍMICO-FARMACÊUTICA CEARENSE LTDA",
      "records": 4
    },
    {
      "name": "ACHÉ LABORATÓRIOS FARMACÊUTICOS S.A",
      "records": 3
    },
    {
      "name": "BELFAR LTDA",
      "records": 3
    },
    {
      "name": "GREENPHARMA QUÍMICA E FARMACÊUTICA LTDA",
      "records": 3
    },
    {
      "name": "GEOLAB INDÚSTRIA FARMACÊUTICA S/A",
      "records": 2
    },
    {
      "name": "NATIVITA IND. COM. LTDA.",
      "records": 2
    },
    {
      "name": "SANOFI MEDLEY FARMACÊUTICA LTDA.",
      "records": 2
    },
    {
      "name": "EMS S/A",
      "records": 1
    },
    {
      "name": "INDÚSTRIA QUÍMICA DO ESTADO DE GOIÁS S/A - IQUEGO",
      "records": 1
    }
  ]
}