PrankWeb HTTP API

In the rest of this document {code} corresponds to either PDB code or {PDB Code}_{chains}. Where {chains} is comma-separated list of chains.

Version 2

{database} is the name of the databse, it depends on your deploy options. Some endpoints returns same/similar data as in version 1. In such case an equivalent endpoint in version 1 is specified.

Endpoint	V1 Endpoint	Content type	Description
./api/v1/task/{database}/{code}		JSON	Can be used to create new task or get information about existing task.
./api/v1/task/{database}/{code}/public/structure.pdb	./api/{database}/pdb/{code}
./api/v1/task/{database}/{code}/public/prediction.pdb	./api/{database}/csv/{code}
./api/v1/task/{database}/{code}/public/sequence.pdb	./api/{database}/seq/{code}
./api/v1/task/{database}/{code}/public/visualizations.zip	./api/{database}/vis/{code}
./api/v1/task/{database}/{code}/stdout		text	Execution log

Version 1

{database} is either id or id_noconser. You can not access the resource directly you must first trigger the computation by accessing ./analyze/{database}/{code} where you can read status from HTML code.

Endpoint	Content type	Description
./api/{database}/pdb/{code}	PDB file	PDB file
./api/{database}/csv/{code}	JSON	Information about p2rank prediction.
./api/{database}/seq/{code}	JSON	Sequence and conservation.
./api/{database}/msa/{code}	ZIP	Zip with fasta files that contains MSA.
./api/{database}/hom/{code}	ZIP	Zip with conservation scores.
./api/{database}/vis/{code}	ZIP	Zip with PyMol visualisation files.
./api/{database}/all/{code}	ZIP	Zip with all files relevant for given prediction.