Service logo

GET xrefs/symbol/:species/:symbol

Looks up an external symbol and returns all objects linked to it. This can be a display name for a gene/transcript/translation, a synonym or an externally linked reference. If a gene's transcript is linked to the supplied symbol the service will return both gene and transcript (it supports transient links).

Parameters

Required

NameTypeDescriptionDefaultExample Values
species String Species name/alias - brugia_malayi_prjna10729
symbol String Symbol or display name of a gene - Bm994

Optional

NameTypeDescriptionDefaultExample 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
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

Example Requests

/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?content-type=application/json


  1. use strict;
  2. use warnings;
  3.  
  4. use HTTP::Tiny;
  5.  
  6. my $http = HTTP::Tiny->new();
  7.  
  8. my $server = 'https://parasite.wormbase.org';
  9. my $ext = '/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?';
  10. my $response = $http->get($server.$ext, {
  11.   headers => { 'Content-type' => 'application/json' }
  12. });
  13.  
  14. die "Failed!\n" unless $response->{success};
  15.  
  16.  
  17. use JSON;
  18. use Data::Dumper;
  19. if(length $response->{content}) {
  20.   my $hash = decode_json($response->{content});
  21.   local $Data::Dumper::Terse = 1;
  22.   local $Data::Dumper::Indent = 1;
  23.   print Dumper $hash;
  24.   print "\n";
  25. }
  26.  
  1. import requests, sys
  2.  
  3. server = "https://parasite.wormbase.org"
  4. ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?"
  5.  
  6. r = requests.get(server+ext, headers={ "Content-Type" : "application/json", "Accept" : ""})
  7.  
  8. if not r.ok:
  9.   r.raise_for_status()
  10.   sys.exit()
  11.  
  12. decoded = r.json()
  13. print repr(decoded)
  14.  
  1. import requests, sys
  2.  
  3. server = "https://parasite.wormbase.org"
  4. ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?"
  5.  
  6. r = requests.get(server+ext, headers={ "Content-Type" : "application/json", "Accept" : ""})
  7.  
  8. if not r.ok:
  9.   r.raise_for_status()
  10.   sys.exit()
  11.  
  12. decoded = r.json()
  13. print(repr(decoded))
  14.  
  1. require 'net/http'
  2. require 'uri'
  3.  
  4. server='https://parasite.wormbase.org'
  5. path = '/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?'
  6.  
  7. url = URI.parse(server)
  8. http = Net::HTTP.new(url.host, url.port)
  9.  
  10. request = Net::HTTP::Get.new(path, {'Content-Type' => 'application/json'})
  11.  
  12. response = http.request(request)
  13.  
  14. if response.code != "200"
  15.   puts "Invalid response: #{response.code}"
  16.   puts response.body
  17.   exit
  18. end
  19.  
  20.  
  21. require 'rubygems'
  22. require 'json'
  23. require 'yaml'
  24.  
  25. result = JSON.parse(response.body)
  26. puts YAML::dump(result)
  27.  
  1. import java.net.URL;
  2. import java.net.URLConnection;
  3. import java.net.HttpURLConnection;
  4. import java.io.BufferedReader;
  5. import java.io.InputStream;
  6. import java.io.InputStreamReader;
  7. import java.io.IOException;
  8. import java.io.Reader;
  9.  
  10.  
  11. public class EnsemblRest {
  12.  
  13.   public static void main(String[] args) throws Exception {
  14.     String server = "https://parasite.wormbase.org";
  15.     String ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?";
  16.     URL url = new URL(server + ext);
  17.  
  18.     URLConnection connection = url.openConnection();
  19.     HttpURLConnection httpConnection = (HttpURLConnection)connection;
  20.     
  21.     httpConnection.setRequestProperty("Content-Type", "application/json");
  22.     
  23.  
  24.     InputStream response = connection.getInputStream();
  25.     int responseCode = httpConnection.getResponseCode();
  26.  
  27.     if(responseCode != 200) {
  28.       throw new RuntimeException("Response code was not 200. Detected response was "+responseCode);
  29.     }
  30.  
  31.     String output;
  32.     Reader reader = null;
  33.     try {
  34.       reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
  35.       StringBuilder builder = new StringBuilder();
  36.       char[] buffer = new char[8192];
  37.       int read;
  38.       while ((read = reader.read(buffer, 0, buffer.length)) > 0) {
  39.         builder.append(buffer, 0, read);
  40.       }
  41.       output = builder.toString();
  42.     } 
  43.     finally {
  44.         if (reader != null) try {
  45.           reader.close(); 
  46.         } catch (IOException logOrIgnore) {
  47.           logOrIgnore.printStackTrace();
  48.         }
  49.     }
  50.  
  51.     System.out.println(output);
  52.   }
  53. }
  54.  
  1.  
  2. curl 'https://parasite.wormbase.org/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?' -H 'Content-type:application/json'
  3.  
  1. wget -q --header='Content-type:application/json' 'https://parasite.wormbase.org/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?'  -O -
  2.  

/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene;content-type=application/json


  1. use strict;
  2. use warnings;
  3.  
  4. use HTTP::Tiny;
  5.  
  6. my $http = HTTP::Tiny->new();
  7.  
  8. my $server = 'https://parasite.wormbase.org';
  9. my $ext = '/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene';
  10. my $response = $http->get($server.$ext, {
  11.   headers => { 'Content-type' => 'application/json' }
  12. });
  13.  
  14. die "Failed!\n" unless $response->{success};
  15.  
  16.  
  17. use JSON;
  18. use Data::Dumper;
  19. if(length $response->{content}) {
  20.   my $hash = decode_json($response->{content});
  21.   local $Data::Dumper::Terse = 1;
  22.   local $Data::Dumper::Indent = 1;
  23.   print Dumper $hash;
  24.   print "\n";
  25. }
  26.  
  1. import requests, sys
  2.  
  3. server = "https://parasite.wormbase.org"
  4. ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene"
  5.  
  6. r = requests.get(server+ext, headers={ "Content-Type" : "application/json", "Accept" : ""})
  7.  
  8. if not r.ok:
  9.   r.raise_for_status()
  10.   sys.exit()
  11.  
  12. decoded = r.json()
  13. print repr(decoded)
  14.  
  1. import requests, sys
  2.  
  3. server = "https://parasite.wormbase.org"
  4. ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene"
  5.  
  6. r = requests.get(server+ext, headers={ "Content-Type" : "application/json", "Accept" : ""})
  7.  
  8. if not r.ok:
  9.   r.raise_for_status()
  10.   sys.exit()
  11.  
  12. decoded = r.json()
  13. print(repr(decoded))
  14.  
  1. require 'net/http'
  2. require 'uri'
  3.  
  4. server='https://parasite.wormbase.org'
  5. path = '/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene'
  6.  
  7. url = URI.parse(server)
  8. http = Net::HTTP.new(url.host, url.port)
  9.  
  10. request = Net::HTTP::Get.new(path, {'Content-Type' => 'application/json'})
  11.  
  12. response = http.request(request)
  13.  
  14. if response.code != "200"
  15.   puts "Invalid response: #{response.code}"
  16.   puts response.body
  17.   exit
  18. end
  19.  
  20.  
  21. require 'rubygems'
  22. require 'json'
  23. require 'yaml'
  24.  
  25. result = JSON.parse(response.body)
  26. puts YAML::dump(result)
  27.  
  1. import java.net.URL;
  2. import java.net.URLConnection;
  3. import java.net.HttpURLConnection;
  4. import java.io.BufferedReader;
  5. import java.io.InputStream;
  6. import java.io.InputStreamReader;
  7. import java.io.IOException;
  8. import java.io.Reader;
  9.  
  10.  
  11. public class EnsemblRest {
  12.  
  13.   public static void main(String[] args) throws Exception {
  14.     String server = "https://parasite.wormbase.org";
  15.     String ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene";
  16.     URL url = new URL(server + ext);
  17.  
  18.     URLConnection connection = url.openConnection();
  19.     HttpURLConnection httpConnection = (HttpURLConnection)connection;
  20.     
  21.     httpConnection.setRequestProperty("Content-Type", "application/json");
  22.     
  23.  
  24.     InputStream response = connection.getInputStream();
  25.     int responseCode = httpConnection.getResponseCode();
  26.  
  27.     if(responseCode != 200) {
  28.       throw new RuntimeException("Response code was not 200. Detected response was "+responseCode);
  29.     }
  30.  
  31.     String output;
  32.     Reader reader = null;
  33.     try {
  34.       reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
  35.       StringBuilder builder = new StringBuilder();
  36.       char[] buffer = new char[8192];
  37.       int read;
  38.       while ((read = reader.read(buffer, 0, buffer.length)) > 0) {
  39.         builder.append(buffer, 0, read);
  40.       }
  41.       output = builder.toString();
  42.     } 
  43.     finally {
  44.         if (reader != null) try {
  45.           reader.close(); 
  46.         } catch (IOException logOrIgnore) {
  47.           logOrIgnore.printStackTrace();
  48.         }
  49.     }
  50.  
  51.     System.out.println(output);
  52.   }
  53. }
  54.  
  1.  
  2. curl 'https://parasite.wormbase.org/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene' -H 'Content-type:application/json'
  3.  
  1. wget -q --header='Content-type:application/json' 'https://parasite.wormbase.org/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?external_db=EntrezGene'  -O -
  2.  

/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?content-type=text/xml


  1. use strict;
  2. use warnings;
  3.  
  4. use HTTP::Tiny;
  5.  
  6. my $http = HTTP::Tiny->new();
  7.  
  8. my $server = 'https://parasite.wormbase.org';
  9. my $ext = '/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?';
  10. my $response = $http->get($server.$ext, {
  11.   headers => { 'Content-type' => 'text/xml' }
  12. });
  13.  
  14. die "Failed!\n" unless $response->{success};
  15.  
  16.  
  17. print "$response->{status} $response->{reason}\n";
  18.  
  1. import requests, sys
  2.  
  3. server = "https://parasite.wormbase.org"
  4. ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?"
  5.  
  6. r = requests.get(server+ext, headers={ "Content-Type" : "text/xml", "Accept" : ""})
  7.  
  8. if not r.ok:
  9.   r.raise_for_status()
  10.   sys.exit()
  11.  
  12.  
  13. print r.text
  14.  
  1. import requests, sys
  2.  
  3. server = "https://parasite.wormbase.org"
  4. ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?"
  5.  
  6. r = requests.get(server+ext, headers={ "Content-Type" : "text/xml", "Accept" : ""})
  7.  
  8. if not r.ok:
  9.   r.raise_for_status()
  10.   sys.exit()
  11.  
  12.  
  13. print(r.text)
  14.  
  1. require 'net/http'
  2. require 'uri'
  3.  
  4. server='https://parasite.wormbase.org'
  5. path = '/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?'
  6.  
  7. url = URI.parse(server)
  8. http = Net::HTTP.new(url.host, url.port)
  9.  
  10. request = Net::HTTP::Get.new(path, {'Content-Type' => 'text/xml'})
  11.  
  12. response = http.request(request)
  13.  
  14. if response.code != "200"
  15.   puts "Invalid response: #{response.code}"
  16.   puts response.body
  17.   exit
  18. end
  19.  
  20.  
  21. puts response.body
  22.  
  1. import java.net.URL;
  2. import java.net.URLConnection;
  3. import java.net.HttpURLConnection;
  4. import java.io.BufferedReader;
  5. import java.io.InputStream;
  6. import java.io.InputStreamReader;
  7. import java.io.IOException;
  8. import java.io.Reader;
  9.  
  10.  
  11. public class EnsemblRest {
  12.  
  13.   public static void main(String[] args) throws Exception {
  14.     String server = "https://parasite.wormbase.org";
  15.     String ext = "/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?";
  16.     URL url = new URL(server + ext);
  17.  
  18.     URLConnection connection = url.openConnection();
  19.     HttpURLConnection httpConnection = (HttpURLConnection)connection;
  20.     
  21.     httpConnection.setRequestProperty("Content-Type", "text/xml");
  22.     
  23.  
  24.     InputStream response = connection.getInputStream();
  25.     int responseCode = httpConnection.getResponseCode();
  26.  
  27.     if(responseCode != 200) {
  28.       throw new RuntimeException("Response code was not 200. Detected response was "+responseCode);
  29.     }
  30.  
  31.     String output;
  32.     Reader reader = null;
  33.     try {
  34.       reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
  35.       StringBuilder builder = new StringBuilder();
  36.       char[] buffer = new char[8192];
  37.       int read;
  38.       while ((read = reader.read(buffer, 0, buffer.length)) > 0) {
  39.         builder.append(buffer, 0, read);
  40.       }
  41.       output = builder.toString();
  42.     } 
  43.     finally {
  44.         if (reader != null) try {
  45.           reader.close(); 
  46.         } catch (IOException logOrIgnore) {
  47.           logOrIgnore.printStackTrace();
  48.         }
  49.     }
  50.  
  51.     System.out.println(output);
  52.   }
  53. }
  54.  
  1.  
  2. curl 'https://parasite.wormbase.org/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?' -H 'Content-type:text/xml'
  3.  
  1. wget -q --header='Content-type:text/xml' 'https://parasite.wormbase.org/rest-19/xrefs/symbol/brugia_malayi_prjna10729/Bm994?'  -O -
  2.  

Resource Information

MethodsGET
Response formatsjson
xml
jsonp