Ensembl GRCh37 Rest API - GET lookup/symbol/:species/:symbol

Find the species and database for a symbol in a linked external database

Parameters

Required

Name	Type	Description	Default	Example Values
species	`String`	Species name/alias	`-`	`homo_sapiens` `human`
symbol	`String`	A name or symbol from an annotation source has been linked to a genetic feature	`-`	`BRCA2`

Optional

Name	Type	Description	Default	Example Values
callback	`String`	Name of the callback subroutine to be returned by the requested JSONP response. Required ONLY when using JSONP as the serialisation method. Please see the user guide.	`-`	`randomlygeneratedname`
expand	`Boolean(0,1)`	Expands the search to include any connected features. e.g. If the object is a gene, its transcripts, translations and exons will be returned as well.	`NULL`	`-`
format	`Enum(full,condensed)`	Specify the layout of the response	`full`	`-`

Example Requests

/lookup/symbol/homo_sapiens/BRCA2?expand=1;content-type=application/json

use strict;
use warnings;

use HTTP::Tiny;

my $http = HTTP::Tiny->new();

my $server = 'http://grch37.rest.ensembl.org';
my $ext = '/lookup/symbol/homo_sapiens/BRCA2?expand=1';
my $response = $http->get($server.$ext, {
  headers => { 'Content-type' => 'application/json' }
});

die "Failed!\n" unless $response->{success};


use JSON;
use Data::Dumper;
if(length $response->{content}) {
  my $hash = decode_json($response->{content});
  local $Data::Dumper::Terse = 1;
  local $Data::Dumper::Indent = 1;
  print Dumper $hash;
  print "\n";
}

import requests, sys

server = "http://grch37.rest.ensembl.org"
ext = "/lookup/symbol/homo_sapiens/BRCA2?expand=1"

r = requests.get(server+ext, headers={ "Content-Type" : "application/json"})

if not r.ok:
  r.raise_for_status()
  sys.exit()

decoded = r.json()
print repr(decoded)

import requests, sys

server = "http://grch37.rest.ensembl.org"
ext = "/lookup/symbol/homo_sapiens/BRCA2?expand=1"

r = requests.get(server+ext, headers={ "Content-Type" : "application/json"})

if not r.ok:
  r.raise_for_status()
  sys.exit()

decoded = r.json()
print(repr(decoded))

require 'net/http'
require 'uri'

server='http://grch37.rest.ensembl.org'
path = '/lookup/symbol/homo_sapiens/BRCA2?expand=1'

url = URI.parse(server)
http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(path, {'Content-Type' => 'application/json'})

response = http.request(request)

if response.code != "200"
  puts "Invalid response: #{response.code}"
  puts response.body
  exit
end


require 'rubygems'
require 'json'
require 'yaml'

result = JSON.parse(response.body)
puts YAML::dump(result)

import java.net.URL;
import java.net.URLConnection;
import java.net.HttpURLConnection;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.IOException;
import java.io.Reader;


public class EnsemblRest {

  public static void main(String[] args) throws Exception {
    String server = "http://grch37.rest.ensembl.org";
    String ext = "/lookup/symbol/homo_sapiens/BRCA2?expand=1";
    URL url = new URL(server + ext);

    URLConnection connection = url.openConnection();
    HttpURLConnection httpConnection = (HttpURLConnection)connection;
    
    httpConnection.setRequestProperty("Content-Type", "application/json");
    

    InputStream response = connection.getInputStream();
    int responseCode = httpConnection.getResponseCode();

    if(responseCode != 200) {
      throw new RuntimeException("Response code was not 200. Detected response was "+responseCode);
    }

    String output;
    Reader reader = null;
    try {
      reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
      StringBuilder builder = new StringBuilder();
      char[] buffer = new char[8192];
      int read;
      while ((read = reader.read(buffer, 0, buffer.length)) > 0) {
        builder.append(buffer, 0, read);
      }
      output = builder.toString();
    } 
    finally {
        if (reader != null) try {
          reader.close(); 
        } catch (IOException logOrIgnore) {
          logOrIgnore.printStackTrace();
        }
    }

    System.out.println(output);
  }
}

library(httr)
library(jsonlite)
library(xml2)

server <- "http://grch37.rest.ensembl.org"
ext <- "/lookup/symbol/homo_sapiens/BRCA2?expand=1"

r <- GET(paste(server, ext, sep = ""), content_type("application/json"))

stop_for_status(r)

# use this if you get a simple nested list back, otherwise inspect its structure
# head(data.frame(t(sapply(content(r),c))))
head(fromJSON(toJSON(content(r))))


curl 'http://grch37.rest.ensembl.org/lookup/symbol/homo_sapiens/BRCA2?expand=1' -H 'Content-type:application/json'

wget -q --header='Content-type:application/json' 'http://grch37.rest.ensembl.org/lookup/symbol/homo_sapiens/BRCA2?expand=1'  -O -

/lookup/symbol/homo_sapiens/BRCA2?content-type=application/json

use strict;
use warnings;

use HTTP::Tiny;

my $http = HTTP::Tiny->new();

my $server = 'http://grch37.rest.ensembl.org';
my $ext = '/lookup/symbol/homo_sapiens/BRCA2?';
my $response = $http->get($server.$ext, {
  headers => { 'Content-type' => 'application/json' }
});

die "Failed!\n" unless $response->{success};


use JSON;
use Data::Dumper;
if(length $response->{content}) {
  my $hash = decode_json($response->{content});
  local $Data::Dumper::Terse = 1;
  local $Data::Dumper::Indent = 1;
  print Dumper $hash;
  print "\n";
}

import requests, sys

server = "http://grch37.rest.ensembl.org"
ext = "/lookup/symbol/homo_sapiens/BRCA2?"

r = requests.get(server+ext, headers={ "Content-Type" : "application/json"})

if not r.ok:
  r.raise_for_status()
  sys.exit()

decoded = r.json()
print repr(decoded)

import requests, sys

server = "http://grch37.rest.ensembl.org"
ext = "/lookup/symbol/homo_sapiens/BRCA2?"

r = requests.get(server+ext, headers={ "Content-Type" : "application/json"})

if not r.ok:
  r.raise_for_status()
  sys.exit()

decoded = r.json()
print(repr(decoded))

require 'net/http'
require 'uri'

server='http://grch37.rest.ensembl.org'
path = '/lookup/symbol/homo_sapiens/BRCA2?'

url = URI.parse(server)
http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(path, {'Content-Type' => 'application/json'})

response = http.request(request)

if response.code != "200"
  puts "Invalid response: #{response.code}"
  puts response.body
  exit
end


require 'rubygems'
require 'json'
require 'yaml'

result = JSON.parse(response.body)
puts YAML::dump(result)

import java.net.URL;
import java.net.URLConnection;
import java.net.HttpURLConnection;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.IOException;
import java.io.Reader;


public class EnsemblRest {

  public static void main(String[] args) throws Exception {
    String server = "http://grch37.rest.ensembl.org";
    String ext = "/lookup/symbol/homo_sapiens/BRCA2?";
    URL url = new URL(server + ext);

    URLConnection connection = url.openConnection();
    HttpURLConnection httpConnection = (HttpURLConnection)connection;
    
    httpConnection.setRequestProperty("Content-Type", "application/json");
    

    InputStream response = connection.getInputStream();
    int responseCode = httpConnection.getResponseCode();

    if(responseCode != 200) {
      throw new RuntimeException("Response code was not 200. Detected response was "+responseCode);
    }

    String output;
    Reader reader = null;
    try {
      reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
      StringBuilder builder = new StringBuilder();
      char[] buffer = new char[8192];
      int read;
      while ((read = reader.read(buffer, 0, buffer.length)) > 0) {
        builder.append(buffer, 0, read);
      }
      output = builder.toString();
    } 
    finally {
        if (reader != null) try {
          reader.close(); 
        } catch (IOException logOrIgnore) {
          logOrIgnore.printStackTrace();
        }
    }

    System.out.println(output);
  }
}

library(httr)
library(jsonlite)
library(xml2)

server <- "http://grch37.rest.ensembl.org"
ext <- "/lookup/symbol/homo_sapiens/BRCA2?"

r <- GET(paste(server, ext, sep = ""), content_type("application/json"))

stop_for_status(r)

# use this if you get a simple nested list back, otherwise inspect its structure
# head(data.frame(t(sapply(content(r),c))))
head(fromJSON(toJSON(content(r))))


curl 'http://grch37.rest.ensembl.org/lookup/symbol/homo_sapiens/BRCA2?' -H 'Content-type:application/json'

wget -q --header='Content-type:application/json' 'http://grch37.rest.ensembl.org/lookup/symbol/homo_sapiens/BRCA2?'  -O -

/lookup/symbol/homo_sapiens/BRCA2?format=condensed;content-type=text/xml;db_type=core

use strict;
use warnings;

use HTTP::Tiny;

my $http = HTTP::Tiny->new();

my $server = 'http://grch37.rest.ensembl.org';
my $ext = '/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed';
my $response = $http->get($server.$ext, {
  headers => { 'Content-type' => 'text/xml' }
});

die "Failed!\n" unless $response->{success};


print "$response->{content}\n";

import requests, sys

server = "http://grch37.rest.ensembl.org"
ext = "/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed"

r = requests.get(server+ext, headers={ "Content-Type" : "text/xml"})

if not r.ok:
  r.raise_for_status()
  sys.exit()


print r.text

import requests, sys

server = "http://grch37.rest.ensembl.org"
ext = "/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed"

r = requests.get(server+ext, headers={ "Content-Type" : "text/xml"})

if not r.ok:
  r.raise_for_status()
  sys.exit()


print(r.text)

require 'net/http'
require 'uri'

server='http://grch37.rest.ensembl.org'
path = '/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed'

url = URI.parse(server)
http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(path, {'Content-Type' => 'text/xml'})

response = http.request(request)

if response.code != "200"
  puts "Invalid response: #{response.code}"
  puts response.body
  exit
end


puts response.body

import java.net.URL;
import java.net.URLConnection;
import java.net.HttpURLConnection;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.IOException;
import java.io.Reader;


public class EnsemblRest {

  public static void main(String[] args) throws Exception {
    String server = "http://grch37.rest.ensembl.org";
    String ext = "/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed";
    URL url = new URL(server + ext);

    URLConnection connection = url.openConnection();
    HttpURLConnection httpConnection = (HttpURLConnection)connection;
    
    httpConnection.setRequestProperty("Content-Type", "text/xml");
    

    InputStream response = connection.getInputStream();
    int responseCode = httpConnection.getResponseCode();

    if(responseCode != 200) {
      throw new RuntimeException("Response code was not 200. Detected response was "+responseCode);
    }

    String output;
    Reader reader = null;
    try {
      reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
      StringBuilder builder = new StringBuilder();
      char[] buffer = new char[8192];
      int read;
      while ((read = reader.read(buffer, 0, buffer.length)) > 0) {
        builder.append(buffer, 0, read);
      }
      output = builder.toString();
    } 
    finally {
        if (reader != null) try {
          reader.close(); 
        } catch (IOException logOrIgnore) {
          logOrIgnore.printStackTrace();
        }
    }

    System.out.println(output);
  }
}

library(httr)
library(jsonlite)
library(xml2)

server <- "http://grch37.rest.ensembl.org"
ext <- "/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed"

r <- GET(paste(server, ext, sep = ""), content_type("text/xml"))

stop_for_status(r)


print(content(r))


curl 'http://grch37.rest.ensembl.org/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed' -H 'Content-type:text/xml'

wget -q --header='Content-type:text/xml' 'http://grch37.rest.ensembl.org/lookup/symbol/homo_sapiens/BRCA2?db_type=core;format=condensed'  -O -

Resource Information

Methods	GET
Response formats	json xml jsonp