Developer Information

Overview

BLAST is public domain software.

Web service interface

The NCBI supports two (similar) RESTful interfaces to programmatically submit BLAST searches. Users of the service at the NCBI should respect the usage guidelines below.

REST

Two similar RESTful interfaces are supported for submission of BLAST searches via an HTTP-based interface:

  1. NCBI. Searches are submitted to the NCBI servers. Documentation and sample perl code are available. This is a public resource, so usage limitations apply. Projects that involve a large number of BLAST searches should use the RESTful interface at a cloud provider or stand-alone BLAST.

Usage Guidelines

The NCBI BLAST servers are a shared resource. We give priority to interactive users. In order to ensure availability of the service to the entire community, we may limit searches for some high volume users. Interactive users of the NCBI webpages through a web browser should not encounter problems. We will move searches of users who submit more than 100 searches in a 24 hour period to a slower queue, or, in extreme cases, will block the requests. To avoid problems, API users should comply with the following guidelines:

  1. Do not contact the server more often than once every 10 seconds.
  2. Do not poll for any single RID more often than once a minute.
  3. Use the URL parameter email and tool, so that the NCBI can contact you if there is a problem.
  4. Run scripts weekends or between 9 pm and 5 am Eastern time on weekdays if more than 50 searches will be submitted.
BLAST often runs more efficiently if multiple queries are sent as one search rather than if each query is sent as an individual search. This is especially true for blastn, megablast, and tblastn. If your queries are short (less than a few hundred bases) we suggest you merge them into one search of up to 1,000 bases

The NCBI servers are a shared resource and not intended for projects that involve a large number of BLAST searches. We provide Stand-alone BLAST and the RESTful API at a cloud provider for such projects.

C++ Toolkit implementation

The currently-maintained implementation of BLAST is part of the NCBI C++ Toolkit. The algorithm core is written in C and a documented C++ API is available. The source code may be downloaded by FTP and browsed with LXR .

References