Peptide Search Asynchronous RESTful API



Client sends POST query

POST a query to https://peptidesearch.uniprot.org/asyncrest/

POST https://peptidesearch.uniprot.org/asyncrest/ HTTP/1.1
Content-type: application/x-www-form-urlencoded ; version=1.1

peps:AAVEEGIVLGGGCALLR,STKKSVQY
taxIds:9606,10090
lEQi:on                    		
spOnly:on                    		
The query consists of a list of comma separated list of peptides, comma separated list of NCBI taxIds and option flag "lEQi" which indicates whether to treat Leucine (L) and Isoleucine (I) as equivalent or not. It is most likely to be a checkbox value.

Note: Peptide Search service supports query peptide with three and more amino acids. However, shorter peptide takes more time to search and generate report.

Server responds 202 (Accepted)

Once the server received the query, it creates a background job to run the peptide search and return a message tells the client that the server has accepted the request, but has not processed (or still is busy processing) the request. Instead of the URI of the actual search result resource, it would send a location to a job status resource.
HTTP/1.1 202 Accepted
Location: https://peptidesearch.uniprot.org/asyncrest/jobs/PM201602291d5444276668425dbb05a2044c4c15c4

Client requests the job status

GET https://peptidesearch.uniprot.org/asyncrest/jobs/PM201602291d5444276668425dbb05a2044c4c15c4 HTTP/1.1

Server responds 303 (See Other) and Retry-After (30 seconds) - If the job is still running

HTTP/1.1 303 See Other
Retry-After: 30

Server responds 200 (OK) and matched protein accessions - If the job is finished

HTTP/1.1 200 OK			

A0A024R3X4,B3GQS7,B3KNN9,B4DX43,B7Z4F6,B7Z597,B7Z5E7,E9Q3Q6,E9Q4G8,F5GXJ9,P10809,P63038,P63038-2,Q13740,Q13740-2,Q13740-3,Q54AJ5,Q5MPX5,Q61490

Client gets the job parameters

GET https://peptidesearch.uniprot.org/asyncrest/jobs/PM202203143cfba27c0ded4cb488377eaee526fbb5/parameters HTTP/1.1

Server responds 200 (OK) and job parameters

HTTP/1.1 200 OK			

QueryPetides:AAVEEGIVLGGGCALLR,STKKSVQY
TaxonIds:9606,10090
lEqi:Y
swissProtOnly:Y