{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/research:europepmc/annotations-by-article":{"get":{"operationId":"research_europepmc_annotations_by_article","summary":"Annotations By Article","description":"Text-mined annotations (genes, diseases, organisms, …) for articles, e.g. MED:28585529 or PMC:PMC4357394.","tags":["research"],"parameters":[{"name":"articleIds","in":"query","required":true,"schema":{"type":"string"},"example":"MED:28585529"},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["Gene_Proteins","Chemicals","Diseases","Organisms","Accession Numbers","Gene Ontology","Sequence Ontology","Experimental Methods","Cell","Cell Line","Body Part"]}},{"name":"section","in":"query","required":false,"schema":{"type":"string","enum":["Title","Abstract","Introduction","Methods","Results","Discussion","Conclusion"]}},{"name":"annotationProvider","in":"query","required":false,"schema":{"type":"string"},"example":"Europe PMC"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/annotations-by-provider":{"get":{"operationId":"research_europepmc_annotations_by_provider","summary":"Annotations By Provider","description":"Page through all articles annotated by a given provider.","tags":["research"],"parameters":[{"name":"annotationProvider","in":"query","required":true,"schema":{"type":"string"},"example":"Europe PMC"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":8,"minimum":1,"maximum":8,"description":"Results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/article":{"get":{"operationId":"research_europepmc_article","summary":"Article","description":"Core metadata (incl. abstract) for one article by source + ID.","tags":["research"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"33301246"},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["MED","PMC","PPR","AGR","CBA","CTX","ETH","HIR","PAT","NBK"],"default":"MED"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/citations":{"get":{"operationId":"research_europepmc_citations","summary":"Citations","description":"Articles that cite the given article.","tags":["research"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"33301246"},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["MED","PMC","PPR","AGR","CBA","CTX","ETH","HIR","PAT","NBK"],"default":"MED"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":1000,"description":"Results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/database-links":{"get":{"operationId":"research_europepmc_database_links","summary":"Database Links","description":"Cross-references from an article to biological databases (UniProt, PDB, ENA, …).","tags":["research"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"33301246"},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["MED","PMC","PPR","AGR","CBA","CTX","ETH","HIR","PAT","NBK"],"default":"MED"}},{"name":"database","in":"query","required":false,"schema":{"type":"string"},"example":"UNIPROT"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":1000,"description":"Results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/full-text":{"get":{"operationId":"research_europepmc_full_text","summary":"Full Text","description":"Open-access full text (JATS XML) of a PMC article, with title, abstract and plain-text body.","tags":["research"],"parameters":[{"name":"pmcid","in":"query","required":true,"schema":{"type":"string"},"example":"PMC3531190"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/labs-links":{"get":{"operationId":"research_europepmc_labs_links","summary":"Labs Links","description":"External 'Labs' links (data, reviews, recommendations) for an article.","tags":["research"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"33301246"},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["MED","PMC","PPR","AGR","CBA","CTX","ETH","HIR","PAT","NBK"],"default":"MED"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/profile":{"get":{"operationId":"research_europepmc_profile","summary":"Profile","description":"Hit counts for a query broken down by source and publication type.","tags":["research"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"malaria"},{"name":"synonym","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/references":{"get":{"operationId":"research_europepmc_references","summary":"References","description":"Reference list of the given article.","tags":["research"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"33301246"},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["MED","PMC","PPR","AGR","CBA","CTX","ETH","HIR","PAT","NBK"],"default":"MED"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":1000,"description":"Results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/search-post":{"post":{"operationId":"research_europepmc_search_post","summary":"Search Post","description":"Same as search, but takes a JSON body (for very long queries).","tags":["research"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string"},"resultType":{"type":"string","enum":["idlist","lite","core"],"default":"lite"},"cursor":{"type":"string","description":"nextCursor from a previous page"},"limit":{"type":"integer","default":25,"minimum":1,"maximum":1000,"description":"Results per page"},"sort":{"type":"string","enum":["relevance","dateAsc","dateDesc","citedAsc","citedDesc"],"default":"relevance"},"synonym":{"type":"boolean","default":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":900,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:europepmc/search":{"get":{"operationId":"research_europepmc_search","summary":"Search","description":"Search Europe PMC publications with its query syntax; paginate with `cursor`.","tags":["research"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"malaria AND OPEN_ACCESS:y"},{"name":"resultType","in":"query","required":false,"schema":{"type":"string","enum":["idlist","lite","core"],"default":"lite"}},{"name":"cursor","in":"query","required":false,"description":"nextCursor from a previous page","schema":{"type":"string","description":"nextCursor from a previous page"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":1000,"description":"Results per page"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["relevance","dateAsc","dateDesc","citedAsc","citedDesc"],"default":"relevance"}},{"name":"synonym","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":900,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}