Conventions

​

Ids, not names

​

Free text: q

​

Filters

​

Dates

​

Sorting

​

Views

​

Paging

{ "data": [...], "next_cursor": "eyJyIjoi...", "total": 123 }

• Pass next_cursor back as cursor. It is absent on the last page.
• Pages never skip or repeat rows, at any depth.
• total is the exact match count. It is absent for relevance-ranked q results, which end after 1,000 rows.
• A cursor works only with the same endpoint and sort.

curl -G https://api.pav.bio/v1/programs \
  -H "Authorization: Bearer $PAV_API_KEY" \
  --data-urlencode "company_id=218" \
  --data-urlencode "phase=3" \
  --data-urlencode "view=slim" \
  --data-urlencode "limit=20"

import os
import requests

params = {"company_id": 218, "phase": "3", "view": "slim", "limit": 20}
rows = []
while True:
    resp = requests.get(
        "https://api.pav.bio/v1/programs",
        headers={"Authorization": f"Bearer {os.environ['PAV_API_KEY']}"},
        params=params,
    )
    resp.raise_for_status()
    page = resp.json()
    rows += page["data"]
    if "next_cursor" not in page:
        break
    params["cursor"] = page["next_cursor"]
print(len(rows), "of", page["total"])

​

Responses and errors

{
  "error": {
    "code": "validation_error",
    "message": "query.sort: `sort` is not allowed with `q`; results are ranked by relevance",
    "request_id": "58eb108c626c45d58df6038898a5cce5"
  }
}

​

Changes in 2.0

• Name filters company, short_name, drug, sponsor removed: use ids.
• include_subsidiaries removed: company_id always includes owned companies.
• offset, include_total, direction, date_field removed: use cursor, total, sort=-field, from/to.
• condition is now indication; deals event_type is now status; patents state is now status and include_members is now view.
• Programs are identified by program_id and carry last_updated.
• /v1/programs/autocomplete, /v1/companies/{company_id}/programs and /v1/companies/{company_id}/changes removed: use /v1/search, /v1/programs?company_id= and /v1/changes?company_id=.
• /v1/fda list removed: one list per FDA record type.