|
|
|
# Ensembl REST APIs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ensembl REST API provides language agnostic bindings to Ensembl data.
|
|
|
|
|
|
|
|
- Access it from http://rest.ensembl.org
|
|
|
|
- Access our GRCh37 site from http://grch37.rest.ensembl.org ([click here for more info](GRCh37-REST-server))
|
|
|
|
|
|
|
|
## Ensembl REST 3.0 User Guide
|
|
|
|
|
|
|
|
The following guide refers to the 3.0 release of the Ensembl REST API. For support please contact [helpdesk or our dev mailing list](http://www.ensembl.org/info/about/contact).
|
|
|
|
|
|
|
|
### Contents
|
|
|
|
|
|
|
|
1. [Writing Your First Client](Writing-Your-First-Client)
|
|
|
|
2. Example Clients (all query for a Gene and look for overlapping variation)
|
|
|
|
- [Example Java Client](Example-Java-Client)
|
|
|
|
- [Example Perl Client](Example-Perl-Client)
|
|
|
|
- [Example Python Client](Example-Python-Client)
|
|
|
|
- [Example Ruby Client](Example-Ruby-Client)
|
|
|
|
2. [URL Structure](URL-Structure)
|
|
|
|
3. [Parameters](Parameters)
|
|
|
|
4. [API Versioning](API-Versioning)
|
|
|
|
5. [Output formats](Output-formats)
|
|
|
|
6. [HTTP Response Codes](HTTP-Response-Codes)
|
|
|
|
7. [HTTP Headers](HTTP-Headers)
|
|
|
|
8. [Rate Limits](Rate-Limits)
|
|
|
|
9. [Cross Origin Resource Sharing and JSON-P](CORS-And-JSONP)
|
|
|
|
10. [POST Requests (VEP & Archive)](POST-Requests)
|
|
|
|
11. Version Migration
|
|
|
|
- [1.0 to 2.0](1.0-To-2.0-Migration)
|
|
|
|
- [1.0 to 3.0](1.0-To-3.0-Migration) (Beta to Gamma)
|
|
|
|
12. [REST Installation and Development](REST-Installation-and-Development)
|
|
|
|
|
|
|
|
### Licensing
|
|
|
|
|
|
|
|
The Ensembl REST API & associated Ensembl Perl APIs are available under an Apache 2 license. Please consult the [LICENSE](https://raw.githubusercontent.com/Ensembl/ensembl-rest/master/LICENSE) file for more information. Your usage of the data returned by the service is subject to same conditions as laid out on the [Ensembl website](http://www.ensembl.org/info/about/legal/index.html).
|
|
|
|
|
|
|
|
### Citing
|
|
|
|
|
|
|
|
To cite your usage of the Ensembl REST API please use our most recent Nucleic Acids Review paper. Details of which can be found on [Ensembl's publication page](http://www.ensembl.org/info/about/publications.html).
|
|
|
|
|
|
|
|
### Example Clients
|
|
|
|
|
|
|
|
All example clients attempt to find variants overlapping the human Gene BRAF. They also attempt to rate limit themselves to 15 requests per second but also look for the `Retry-After` header to ensure they are not rate limited due to shared IP addresses.
|
|
|
|
|
|
|
|
- [Perl](Example-Perl-Client)
|
|
|
|
- [Python](Example-Python-Client)
|
|
|
|
- [Java](Example-Java-Client)
|
|
|
|
# Ensembl REST APIs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ensembl REST API provides language agnostic bindings to Ensembl data.
|
|
|
|
|
|
|
|
- Access it from http://rest.ensembl.org
|
|
|
|
- Access our GRCh37 site from http://grch37.rest.ensembl.org ([click here for more info](GRCh37-REST-server))
|
|
|
|
|
|
|
|
## Ensembl REST 3.0 User Guide
|
|
|
|
|
|
|
|
The following guide refers to the 3.0 release of the Ensembl REST API. For support please contact [helpdesk or our dev mailing list](http://www.ensembl.org/info/about/contact).
|
|
|
|
|
|
|
|
### Contents
|
|
|
|
|
|
|
|
1. [Writing Your First Client](Writing-Your-First-Client)
|
|
|
|
2. Example Clients (all query for a Gene and look for overlapping variation)
|
|
|
|
- [Example Java Client](Example-Java-Client)
|
|
|
|
- [Example Perl Client](Example-Perl-Client)
|
|
|
|
- [Example Python Client](Example-Python-Client)
|
|
|
|
- [Example Ruby Client](Example-Ruby-Client)
|
|
|
|
2. [URL Structure](URL-Structure)
|
|
|
|
3. [Parameters](Parameters)
|
|
|
|
4. [API Versioning](API-Versioning)
|
|
|
|
5. [Output formats](Output-formats)
|
|
|
|
6. [HTTP Response Codes](HTTP-Response-Codes)
|
|
|
|
7. [HTTP Headers](HTTP-Headers)
|
|
|
|
8. [Rate Limits](Rate-Limits)
|
|
|
|
9. [Cross Origin Resource Sharing and JSON-P](CORS-And-JSONP)
|
|
|
|
10. [POST Requests (VEP & Archive)](POST-Requests)
|
|
|
|
11. Version Migration
|
|
|
|
- [1.0 to 2.0](1.0-To-2.0-Migration)
|
|
|
|
- [1.0 to 3.0](1.0-To-3.0-Migration) (Beta to Gamma)
|
|
|
|
12. [REST Installation and Development](REST-Installation-and-Development)
|
|
|
|
|
|
|
|
### Licensing
|
|
|
|
|
|
|
|
The Ensembl REST API & associated Ensembl Perl APIs are available under an Apache 2 license. Please consult the [LICENSE](https://raw.githubusercontent.com/Ensembl/ensembl-rest/master/LICENSE) file for more information. Your usage of the data returned by the service is subject to same conditions as laid out on the [Ensembl website](http://www.ensembl.org/info/about/legal/index.html).
|
|
|
|
|
|
|
|
### Citing
|
|
|
|
|
|
|
|
To cite your usage of the Ensembl REST API please use our most recent Nucleic Acids Review paper. Details of which can be found on [Ensembl's publication page](http://www.ensembl.org/info/about/publications.html).
|
|
|
|
|
|
|
|
### Example Clients
|
|
|
|
|
|
|
|
All example clients attempt to find variants overlapping the human Gene BRAF. They also attempt to rate limit themselves to 15 requests per second but also look for the `Retry-After` header to ensure they are not rate limited due to shared IP addresses.
|
|
|
|
|
|
|
|
- [Perl](Example-Perl-Client)
|
|
|
|
- [Python](Example-Python-Client)
|
|
|
|
- [Java](Example-Java-Client)
|
|
|
|
- [Ruby](Example-Ruby-Client) |
|
|
\ No newline at end of file |
