GET xrefs/id/:id

Perform lookups of identifiers and retrieve their external references in other databases

Parameters

Required

NameTypeDescriptionDefaultExample Values
id String A Stable ID - ENSG00000157764

Optional

NameTypeDescriptionDefaultExample Values
all_levels Boolean Set to find all genetic features linked to the stable ID, and fetch all external references for them. Specifying this on a gene will also return values from its transcripts and translations 0 1
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
db_type String Restrict the search to a database other than the default. Useful if you need to use a DB other than core core core
external_db String Filter by external database - EntrezGene
object_type String Filter by feature type - gene
transcript
species String Species name/alias - brugia_malayi_prjna10729

Example Requests

/rest-19/xrefs/id/WBGene00221255?content-type=application/json


use strict;
use warnings;

use HTTP::Tiny;

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

my $server = 'https://parasite.wormbase.org';
my $ext = '/rest-19/xrefs/id/WBGene00221255?';
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 = "https://parasite.wormbase.org"
ext = "/rest-19/xrefs/id/WBGene00221255?"

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

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

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

import requests, sys

server = "https://parasite.wormbase.org"
ext = "/rest-19/xrefs/id/WBGene00221255?"

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

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

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

require 'net/http'
require 'uri'

server='https://parasite.wormbase.org'
path = '/rest-19/xrefs/id/WBGene00221255?'

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 = "https://parasite.wormbase.org";
    String ext = "/rest-19/xrefs/id/WBGene00221255?";
    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);
  }
}


curl 'https://parasite.wormbase.org/rest-19/xrefs/id/WBGene00221255?' -H 'Content-type:application/json'

wget -q --header='Content-type:application/json' 'https://parasite.wormbase.org/rest-19/xrefs/id/WBGene00221255?'  -O -

/rest-19/xrefs/id/Bm4789.1?object_type=transcript;content-type=application/json;all_levels=1;external_db=GO


use strict;
use warnings;

use HTTP::Tiny;

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

my $server = 'https://parasite.wormbase.org';
my $ext = '/rest-19/xrefs/id/Bm4789.1?external_db=GO;all_levels=1;object_type=transcript';
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 = "https://parasite.wormbase.org"
ext = "/rest-19/xrefs/id/Bm4789.1?external_db=GO;all_levels=1;object_type=transcript"

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

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

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

import requests, sys

server = "https://parasite.wormbase.org"
ext = "/rest-19/xrefs/id/Bm4789.1?external_db=GO;all_levels=1;object_type=transcript"

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

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

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

require 'net/http'
require 'uri'

server='https://parasite.wormbase.org'
path = '/rest-19/xrefs/id/Bm4789.1?external_db=GO;all_levels=1;object_type=transcript'

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 = "https://parasite.wormbase.org";
    String ext = "/rest-19/xrefs/id/Bm4789.1?external_db=GO;all_levels=1;object_type=transcript";
    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);
  }
}


curl 'https://parasite.wormbase.org/rest-19/xrefs/id/Bm4789.1?external_db=GO;all_levels=1;object_type=transcript' -H 'Content-type:application/json'

wget -q --header='Content-type:application/json' 'https://parasite.wormbase.org/rest-19/xrefs/id/Bm4789.1?external_db=GO;all_levels=1;object_type=transcript'  -O -

Resource Information

MethodsGET
Response formatsjson
xml
jsonp