{"openapi":"3.1.0","info":{"title":"AlphaCitation reference lookup","version":"1.0.0","description":"For one medicine, one market, one proposition and one date: which regulator record settles the claim, what its checked content says, and what is unresolved. Open: no key, no fee, the same answer for every caller. No label text is returned: every record is a pointer, a locator, a version and a hash."},"servers":[{"url":"https://alphacitation.com"}],"paths":{"/api/v1/reference/lookup":{"get":{"summary":"Which source settles a claim about a medicine","parameters":[{"name":"medicine","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":80},"description":"A brand or active substance name, exactly."},{"name":"market","in":"query","required":true,"schema":{"type":"string","maxLength":120},"description":"An ISO 3166-1 alpha-2 code, or EU."},{"name":"proposition","in":"query","required":true,"schema":{"type":"string","enum":["P1","P2"]},"description":"P1: registered or authorised. P2: authorised for an indication."},{"name":"date","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"The date the claim is about. Defaults to today (UTC); never in the future."},{"name":"indication","in":"query","required":false,"schema":{"type":"string","enum":["osa_with_obesity","t2dm_cv_risk_reduction","t2dm_glycaemic_control","weight_management"]},"description":"Required for P2: an identifier from the published list (GET /api/v1/reference/indications)."},{"name":"populationMinAgeYears","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":120},"description":"Optional for P2: the youngest age the claim says the indication covers."}],"responses":{"200":{"description":"The evidence bundle. Every unresolved state is a 200: unknown is an answer, never an error.","content":{"application/json":{"schema":{"type":"object","required":["status","relation","summary","records","unresolved","scope"],"properties":{"status":{"type":"string","enum":["settled","settling_record_identified","supported_attested","reference_only","unresolved"]},"relation":{"type":"string","enum":["agrees","agrees_narrower","disagrees","insufficient"]},"summary":{"type":"string"},"competentAuthorities":{"type":"array","items":{"type":"object"}},"records":{"type":"array","items":{"type":"object"},"description":"Each record: its role, issuer, pointer, locator, version, effective date and its basis, sha256, last verification, the standard's verdict and the relation."},"comparison":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"unresolved":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"detail":{"type":"string"},"retryAfter":{"type":"integer"}}}},"scope":{"type":"object"}}}}}},"400":{"description":"A malformed request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"field":{"type":"string"}}}}}},"429":{"description":"Over 240 requests an hour from one address. Retry-After is set.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"field":{"type":"string"}}}}}},"503":{"description":"The service is switched off or briefly unavailable. Retry-After is set.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"field":{"type":"string"}}}}}}}},"post":{"summary":"The same lookup, with the query in a JSON body (keeps it out of the URL)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"medicine":{"type":"string","minLength":2,"maxLength":80},"market":{"type":"string","maxLength":120},"proposition":{"type":"string","enum":["P1","P2"]},"date":{"type":"string","format":"date"},"indication":{"type":"string","enum":["osa_with_obesity","t2dm_cv_risk_reduction","t2dm_glycaemic_control","weight_management"]},"populationMinAgeYears":{"type":"integer","minimum":0,"maximum":120}},"required":["medicine","market","proposition"]}}}},"responses":{"200":{"description":"The evidence bundle.","content":{"application/json":{"schema":{"type":"object","required":["status","relation","summary","records","unresolved","scope"],"properties":{"status":{"type":"string","enum":["settled","settling_record_identified","supported_attested","reference_only","unresolved"]},"relation":{"type":"string","enum":["agrees","agrees_narrower","disagrees","insufficient"]},"summary":{"type":"string"},"competentAuthorities":{"type":"array","items":{"type":"object"}},"records":{"type":"array","items":{"type":"object"},"description":"Each record: its role, issuer, pointer, locator, version, effective date and its basis, sha256, last verification, the standard's verdict and the relation."},"comparison":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"unresolved":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"detail":{"type":"string"},"retryAfter":{"type":"integer"}}}},"scope":{"type":"object"}}}}}},"400":{"description":"A malformed request."},"413":{"description":"The body is over 4 KiB."},"429":{"description":"Over the hourly limit."},"503":{"description":"Unavailable."}}}},"/api/v1/reference/indications":{"get":{"summary":"The published indication list","responses":{"200":{"description":"Each entry: its identifier, label and the population it covers.","content":{"application/json":{"schema":{"type":"object","properties":{"indications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"population":{"type":"string"}}}}}}}}}}}}}}