MyGene.info API

Annotation

gene

For a list of gene ids, return the matching gene objects


/gene

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/mygene/v3/gene?fields=&species=&dotfield=&email="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnotationApi;

import java.io.File;
import java.util.*;

public class AnnotationApiExample {

    public static void main(String[] args) {
        
        AnnotationApi apiInstance = new AnnotationApi();
        String apiecoKey = apiecoKey_example; // String | 
        Body body = ; // Body | 
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        try {
            inline_response_200 result = apiInstance.gene(apiecoKey, body, fields, species, dotfield, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationApi#gene");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnnotationApi;

public class AnnotationApiExample {

    public static void main(String[] args) {
        AnnotationApi apiInstance = new AnnotationApi();
        String apiecoKey = apiecoKey_example; // String | 
        Body body = ; // Body | 
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        try {
            inline_response_200 result = apiInstance.gene(apiecoKey, body, fields, species, dotfield, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationApi#gene");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
Body *body = ; // 
String *fields = fields_example; // a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
String *species = species_example; // can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional)
Boolean *dotfield = true; // control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
String *email = email_example; // If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)

AnnotationApi *apiInstance = [[AnnotationApi alloc] init];

[apiInstance geneWith:apiecoKey
    body:body
    fields:fields
    species:species
    dotfield:dotfield
    email:email
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MyGeneinfoApi = require('my_geneinfo_api');

var api = new MyGeneinfoApi.AnnotationApi()

var apiecoKey = apiecoKey_example; // {String} 

var body = ; // {Body} 

var opts = { 
  'fields': fields_example, // {String} a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

  'species': species_example, // {String} can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

  'dotfield': true, // {Boolean} control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

  'email': email_example // {String} If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gene(apiecoKey, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class geneExample
    {
        public void main()
        {
            
            var apiInstance = new AnnotationApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var body = new Body(); // Body | 
            var fields = fields_example;  // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional) 
            var species = species_example;  // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional) 
            var dotfield = true;  // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional) 
            var email = email_example;  // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional) 

            try
            {
                inline_response_200 result = apiInstance.gene(apiecoKey, body, fields, species, dotfield, email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnotationApi.gene: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AnnotationApi();
$apiecoKey = apiecoKey_example; // String | 
$body = ; // Body | 
$fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

$species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

$dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

$email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.


try {
    $result = $api_instance->gene($apiecoKey, $body, $fields, $species, $dotfield, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnotationApi->gene: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnotationApi;

my $api_instance = WWW::SwaggerClient::AnnotationApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | 
my $fields = fields_example; # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

my $species = species_example; # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

my $dotfield = true; # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

my $email = email_example; # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.


eval { 
    my $result = $api_instance->gene(apiecoKey => $apiecoKey, body => $body, fields => $fields, species => $species, dotfield => $dotfield, email => $email);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnotationApi->gene: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnnotationApi()
apiecoKey = apiecoKey_example # String | 
body =  # Body | 
fields = fields_example # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
species = species_example # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional)
dotfield = true # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
email = email_example # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)

try: 
    api_response = api_instance.gene(apiecoKey, body, fields=fields, species=species, dotfield=dotfield, email=email)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnotationApi->gene: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
species
String
can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
dotfield
Boolean
control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
email
String
If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

Responses

Status: 200 - a list of matching gene objects


geneByID

For a list of gene ids, return the matching gene objects


/gene/{geneid}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/mygene/v3/gene/{geneid}?fields=&callback=&dotfield=&email="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnnotationApi;

import java.io.File;
import java.util.*;

public class AnnotationApiExample {

    public static void main(String[] args) {
        
        AnnotationApi apiInstance = new AnnotationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String geneid = geneid_example; // String | Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.
        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        try {
            inline_response_200 result = apiInstance.geneByID(apiecoKey, geneid, fields, callback, dotfield, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationApi#geneByID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnnotationApi;

public class AnnotationApiExample {

    public static void main(String[] args) {
        AnnotationApi apiInstance = new AnnotationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String geneid = geneid_example; // String | Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.
        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        try {
            inline_response_200 result = apiInstance.geneByID(apiecoKey, geneid, fields, callback, dotfield, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationApi#geneByID");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *geneid = geneid_example; // Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
String *fields = fields_example; // a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
String *callback = callback_example; // you can pass a "callback" parameter to make a JSONP call. (optional)
Boolean *dotfield = true; // control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
String *email = email_example; // If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)

AnnotationApi *apiInstance = [[AnnotationApi alloc] init];

[apiInstance geneByIDWith:apiecoKey
    geneid:geneid
    fields:fields
    callback:callback
    dotfield:dotfield
    email:email
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MyGeneinfoApi = require('my_geneinfo_api');

var api = new MyGeneinfoApi.AnnotationApi()

var apiecoKey = apiecoKey_example; // {String} 

var geneid = geneid_example; // {String} Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794

var opts = { 
  'fields': fields_example, // {String} a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

  'callback': callback_example, // {String} you can pass a "callback" parameter to make a JSONP call.
  'dotfield': true, // {Boolean} control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

  'email': email_example // {String} If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.geneByID(apiecoKey, geneid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class geneByIDExample
    {
        public void main()
        {
            
            var apiInstance = new AnnotationApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var geneid = geneid_example;  // String | Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
            var fields = fields_example;  // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional) 
            var callback = callback_example;  // String | you can pass a "callback" parameter to make a JSONP call. (optional) 
            var dotfield = true;  // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional) 
            var email = email_example;  // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional) 

            try
            {
                inline_response_200 result = apiInstance.geneByID(apiecoKey, geneid, fields, callback, dotfield, email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnotationApi.geneByID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AnnotationApi();
$apiecoKey = apiecoKey_example; // String | 
$geneid = geneid_example; // String | Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
$fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

$callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.
$dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

$email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.


try {
    $result = $api_instance->geneByID($apiecoKey, $geneid, $fields, $callback, $dotfield, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnotationApi->geneByID: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnnotationApi;

my $api_instance = WWW::SwaggerClient::AnnotationApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $geneid = geneid_example; # String | Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
my $fields = fields_example; # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

my $callback = callback_example; # String | you can pass a "callback" parameter to make a JSONP call.
my $dotfield = true; # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

my $email = email_example; # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.


eval { 
    my $result = $api_instance->geneByID(apiecoKey => $apiecoKey, geneid => $geneid, fields => $fields, callback => $callback, dotfield => $dotfield, email => $email);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnotationApi->geneByID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnnotationApi()
apiecoKey = apiecoKey_example # String | 
geneid = geneid_example # String | Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
fields = fields_example # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
callback = callback_example # String | you can pass a "callback" parameter to make a JSONP call. (optional)
dotfield = true # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
email = email_example # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)

try: 
    api_response = api_instance.gene_by_id(apiecoKey, geneid, fields=fields, callback=callback, dotfield=dotfield, email=email)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnotationApi->geneByID: %s\n" % e)

Parameters

Path parameters
Name Description
geneid*
String
Entrez or Ensembl gene id, e.g., 1017, ENSG00000170248. A retired Entrez Gene id works too if it is replaced by a new one, e.g., 245794
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
fields
String
a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
callback
String
you can pass a "callback" parameter to make a JSONP call.
dotfield
Boolean
control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
email
String
If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

Responses

Status: 200 - a list of matching gene objects


Metadata

metadata

Get metadata about the data available from MyGene.info.


/metadata

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/mygene/v3/metadata?callback="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetadataApi;

import java.io.File;
import java.util.*;

public class MetadataApiExample {

    public static void main(String[] args) {
        
        MetadataApi apiInstance = new MetadataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.
        try {
            inline_response_200_3 result = apiInstance.metadata(apiecoKey, callback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetadataApi;

public class MetadataApiExample {

    public static void main(String[] args) {
        MetadataApi apiInstance = new MetadataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.
        try {
            inline_response_200_3 result = apiInstance.metadata(apiecoKey, callback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadata");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *callback = callback_example; // you can pass a "callback" parameter to make a JSONP call. (optional)

MetadataApi *apiInstance = [[MetadataApi alloc] init];

[apiInstance metadataWith:apiecoKey
    callback:callback
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MyGeneinfoApi = require('my_geneinfo_api');

var api = new MyGeneinfoApi.MetadataApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'callback': callback_example // {String} you can pass a "callback" parameter to make a JSONP call.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.metadata(apiecoKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class metadataExample
    {
        public void main()
        {
            
            var apiInstance = new MetadataApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var callback = callback_example;  // String | you can pass a "callback" parameter to make a JSONP call. (optional) 

            try
            {
                inline_response_200_3 result = apiInstance.metadata(apiecoKey, callback);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetadataApi.metadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MetadataApi();
$apiecoKey = apiecoKey_example; // String | 
$callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.

try {
    $result = $api_instance->metadata($apiecoKey, $callback);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetadataApi->metadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetadataApi;

my $api_instance = WWW::SwaggerClient::MetadataApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $callback = callback_example; # String | you can pass a "callback" parameter to make a JSONP call.

eval { 
    my $result = $api_instance->metadata(apiecoKey => $apiecoKey, callback => $callback);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetadataApi->metadata: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MetadataApi()
apiecoKey = apiecoKey_example # String | 
callback = callback_example # String | you can pass a "callback" parameter to make a JSONP call. (optional)

try: 
    api_response = api_instance.metadata(apiecoKey, callback=callback)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetadataApi->metadata: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
callback
String
you can pass a "callback" parameter to make a JSONP call.

Responses

Status: 200 - MyGene.info metadata object


metadataFields

Get metadata about the data fields available from MyGene.info.


/metadata/fields

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/mygene/v3/metadata/fields?search=&prefix=&callback="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetadataApi;

import java.io.File;
import java.util.*;

public class MetadataApiExample {

    public static void main(String[] args) {
        
        MetadataApi apiInstance = new MetadataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String search = search_example; // String | Pass a search term to filter the available fields, e.g. "search=clinvar".
        String prefix = prefix_example; // String | Pass a prefix string to filter the available fields, e.g. "prefix=refseq".
        String callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.
        try {
            inline_response_200_4 result = apiInstance.metadataFields(apiecoKey, search, prefix, callback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadataFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetadataApi;

public class MetadataApiExample {

    public static void main(String[] args) {
        MetadataApi apiInstance = new MetadataApi();
        String apiecoKey = apiecoKey_example; // String | 
        String search = search_example; // String | Pass a search term to filter the available fields, e.g. "search=clinvar".
        String prefix = prefix_example; // String | Pass a prefix string to filter the available fields, e.g. "prefix=refseq".
        String callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.
        try {
            inline_response_200_4 result = apiInstance.metadataFields(apiecoKey, search, prefix, callback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadataFields");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *search = search_example; // Pass a search term to filter the available fields, e.g. "search=clinvar". (optional)
String *prefix = prefix_example; // Pass a prefix string to filter the available fields, e.g. "prefix=refseq". (optional)
String *callback = callback_example; // you can pass a "callback" parameter to make a JSONP call. (optional)

MetadataApi *apiInstance = [[MetadataApi alloc] init];

[apiInstance metadataFieldsWith:apiecoKey
    search:search
    prefix:prefix
    callback:callback
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MyGeneinfoApi = require('my_geneinfo_api');

var api = new MyGeneinfoApi.MetadataApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'search': search_example, // {String} Pass a search term to filter the available fields, e.g. "search=clinvar".
  'prefix': prefix_example, // {String} Pass a prefix string to filter the available fields, e.g. "prefix=refseq".
  'callback': callback_example // {String} you can pass a "callback" parameter to make a JSONP call.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.metadataFields(apiecoKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class metadataFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new MetadataApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var search = search_example;  // String | Pass a search term to filter the available fields, e.g. "search=clinvar". (optional) 
            var prefix = prefix_example;  // String | Pass a prefix string to filter the available fields, e.g. "prefix=refseq". (optional) 
            var callback = callback_example;  // String | you can pass a "callback" parameter to make a JSONP call. (optional) 

            try
            {
                inline_response_200_4 result = apiInstance.metadataFields(apiecoKey, search, prefix, callback);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetadataApi.metadataFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MetadataApi();
$apiecoKey = apiecoKey_example; // String | 
$search = search_example; // String | Pass a search term to filter the available fields, e.g. "search=clinvar".
$prefix = prefix_example; // String | Pass a prefix string to filter the available fields, e.g. "prefix=refseq".
$callback = callback_example; // String | you can pass a "callback" parameter to make a JSONP call.

try {
    $result = $api_instance->metadataFields($apiecoKey, $search, $prefix, $callback);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetadataApi->metadataFields: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetadataApi;

my $api_instance = WWW::SwaggerClient::MetadataApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $search = search_example; # String | Pass a search term to filter the available fields, e.g. "search=clinvar".
my $prefix = prefix_example; # String | Pass a prefix string to filter the available fields, e.g. "prefix=refseq".
my $callback = callback_example; # String | you can pass a "callback" parameter to make a JSONP call.

eval { 
    my $result = $api_instance->metadataFields(apiecoKey => $apiecoKey, search => $search, prefix => $prefix, callback => $callback);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetadataApi->metadataFields: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MetadataApi()
apiecoKey = apiecoKey_example # String | 
search = search_example # String | Pass a search term to filter the available fields, e.g. "search=clinvar". (optional)
prefix = prefix_example # String | Pass a prefix string to filter the available fields, e.g. "prefix=refseq". (optional)
callback = callback_example # String | you can pass a "callback" parameter to make a JSONP call. (optional)

try: 
    api_response = api_instance.metadata_fields(apiecoKey, search=search, prefix=prefix, callback=callback)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetadataApi->metadataFields: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
search
prefix
String
Pass a prefix string to filter the available fields, e.g. "prefix=refseq".
callback
String
you can pass a "callback" parameter to make a JSONP call.

Responses

Status: 200 - MyGene.info metadata fields object


Query

getquery

Make gene query and return matching gene list. Support JSONP and CORS as well.


/query

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/mygene/v3/query?q=&fields=&species=&dotfield=&email=&size=&from=&sort=&facets="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryApi;

import java.io.File;
import java.util.*;

public class QueryApiExample {

    public static void main(String[] args) {
        
        QueryApi apiInstance = new QueryApi();
        String apiecoKey = apiecoKey_example; // String | 
        String q = q_example; // String | Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        String size = size_example; // String | the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10.
        String from = from_example; // String | the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0.
        String sort = sort_example; // String | the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order.
        String facets = facets_example; // String | a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
        try {
            inline_response_200_1 result = apiInstance.getquery(apiecoKey, q, fields, species, dotfield, email, size, from, sort, facets);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#getquery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryApi;

public class QueryApiExample {

    public static void main(String[] args) {
        QueryApi apiInstance = new QueryApi();
        String apiecoKey = apiecoKey_example; // String | 
        String q = q_example; // String | Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        String size = size_example; // String | the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10.
        String from = from_example; // String | the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0.
        String sort = sort_example; // String | the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order.
        String facets = facets_example; // String | a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
        try {
            inline_response_200_1 result = apiInstance.getquery(apiecoKey, q, fields, species, dotfield, email, size, from, sort, facets);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#getquery");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *q = q_example; // Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
String *fields = fields_example; // a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
String *species = species_example; // can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional)
Boolean *dotfield = true; // control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
String *email = email_example; // If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)
String *size = size_example; // the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10. (optional)
String *from = from_example; // the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0. (optional)
String *sort = sort_example; // the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order. (optional)
String *facets = facets_example; // a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene". (optional)

QueryApi *apiInstance = [[QueryApi alloc] init];

[apiInstance getqueryWith:apiecoKey
    q:q
    fields:fields
    species:species
    dotfield:dotfield
    email:email
    size:size
    from:from
    sort:sort
    facets:facets
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MyGeneinfoApi = require('my_geneinfo_api');

var api = new MyGeneinfoApi.QueryApi()

var apiecoKey = apiecoKey_example; // {String} 

var q = q_example; // {String} Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.

var opts = { 
  'fields': fields_example, // {String} a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

  'species': species_example, // {String} can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

  'dotfield': true, // {Boolean} control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

  'email': email_example, // {String} If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

  'size': size_example, // {String} the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10.
  'from': from_example, // {String} the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0.
  'sort': sort_example, // {String} the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order.
  'facets': facets_example // {String} a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getquery(apiecoKey, q, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getqueryExample
    {
        public void main()
        {
            
            var apiInstance = new QueryApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var q = q_example;  // String | Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
            var fields = fields_example;  // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional) 
            var species = species_example;  // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional) 
            var dotfield = true;  // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional) 
            var email = email_example;  // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional) 
            var size = size_example;  // String | the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10. (optional) 
            var from = from_example;  // String | the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0. (optional) 
            var sort = sort_example;  // String | the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order. (optional) 
            var facets = facets_example;  // String | a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene". (optional) 

            try
            {
                inline_response_200_1 result = apiInstance.getquery(apiecoKey, q, fields, species, dotfield, email, size, from, sort, facets);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryApi.getquery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryApi();
$apiecoKey = apiecoKey_example; // String | 
$q = q_example; // String | Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
$fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

$species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

$dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

$email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

$size = size_example; // String | the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10.
$from = from_example; // String | the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0.
$sort = sort_example; // String | the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order.
$facets = facets_example; // String | a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".

try {
    $result = $api_instance->getquery($apiecoKey, $q, $fields, $species, $dotfield, $email, $size, $from, $sort, $facets);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryApi->getquery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryApi;

my $api_instance = WWW::SwaggerClient::QueryApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $q = q_example; # String | Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
my $fields = fields_example; # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

my $species = species_example; # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

my $dotfield = true; # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

my $email = email_example; # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

my $size = size_example; # String | the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10.
my $from = from_example; # String | the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0.
my $sort = sort_example; # String | the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order.
my $facets = facets_example; # String | a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".

eval { 
    my $result = $api_instance->getquery(apiecoKey => $apiecoKey, q => $q, fields => $fields, species => $species, dotfield => $dotfield, email => $email, size => $size, from => $from, sort => $sort, facets => $facets);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryApi->getquery: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryApi()
apiecoKey = apiecoKey_example # String | 
q = q_example # String | Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
fields = fields_example # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
species = species_example # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional)
dotfield = true # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
email = email_example # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)
size = size_example # String | the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10. (optional)
from = from_example # String | the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0. (optional)
sort = sort_example # String | the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order. (optional)
facets = facets_example # String | a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene". (optional)

try: 
    api_response = api_instance.getquery(apiecoKey, q, fields=fields, species=species, dotfield=dotfield, email=email, size=size, from=from, sort=sort, facets=facets)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryApi->getquery: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
q*
String
Query string. Examples "CDK2", "NM_052827", "204639_at", "chr1:151,073,054-151,383,976", "hg19.chr1:151073054-151383976". The detailed query syntax can be found from our docs.
Required
fields
String
a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
species
String
can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
dotfield
Boolean
control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
email
String
If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
size
String
the maximum number of matching gene hits to return (with a cap of 1000 at the moment). Default: 10.
from
String
the number of matching gene hits to skip, starting from 0. Combining with "size" parameter, this can be useful for paging. Default: 0.
sort
String
the comma-separated fields to sort on. Prefix with "-" for descending order, otherwise in ascending order. Default: sort by matching scores in decending order.
facets
String
a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene". a single field or comma-separated fields to return facets, for example, "facets=taxid", "facets=taxid,type_of_gene".

Responses

Status: 200 - A query response object with "hits" property


postquery

Make gene batch query and return matching gene hits


/query

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/mygene/v3/query?fields=&species=&dotfield=&email="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryApi;

import java.io.File;
import java.util.*;

public class QueryApiExample {

    public static void main(String[] args) {
        
        QueryApi apiInstance = new QueryApi();
        String apiecoKey = apiecoKey_example; // String | 
        Body_1 body = ; // Body_1 | 
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        try {
            inline_response_200_2 result = apiInstance.postquery(apiecoKey, body, fields, species, dotfield, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#postquery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryApi;

public class QueryApiExample {

    public static void main(String[] args) {
        QueryApi apiInstance = new QueryApi();
        String apiecoKey = apiecoKey_example; // String | 
        Body_1 body = ; // Body_1 | 
        String fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

        String species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

        Boolean dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

        String email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

        try {
            inline_response_200_2 result = apiInstance.postquery(apiecoKey, body, fields, species, dotfield, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#postquery");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
Body_1 *body = ; // 
String *fields = fields_example; // a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
String *species = species_example; // can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional)
Boolean *dotfield = true; // control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
String *email = email_example; // If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)

QueryApi *apiInstance = [[QueryApi alloc] init];

[apiInstance postqueryWith:apiecoKey
    body:body
    fields:fields
    species:species
    dotfield:dotfield
    email:email
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MyGeneinfoApi = require('my_geneinfo_api');

var api = new MyGeneinfoApi.QueryApi()

var apiecoKey = apiecoKey_example; // {String} 

var body = ; // {Body_1} 

var opts = { 
  'fields': fields_example, // {String} a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

  'species': species_example, // {String} can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

  'dotfield': true, // {Boolean} control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

  'email': email_example // {String} If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postquery(apiecoKey, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postqueryExample
    {
        public void main()
        {
            
            var apiInstance = new QueryApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var body = new Body_1(); // Body_1 | 
            var fields = fields_example;  // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional) 
            var species = species_example;  // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional) 
            var dotfield = true;  // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional) 
            var email = email_example;  // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional) 

            try
            {
                inline_response_200_2 result = apiInstance.postquery(apiecoKey, body, fields, species, dotfield, email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryApi.postquery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryApi();
$apiecoKey = apiecoKey_example; // String | 
$body = ; // Body_1 | 
$fields = fields_example; // String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

$species = species_example; // String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

$dotfield = true; // Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

$email = email_example; // String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.


try {
    $result = $api_instance->postquery($apiecoKey, $body, $fields, $species, $dotfield, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryApi->postquery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryApi;

my $api_instance = WWW::SwaggerClient::QueryApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $body = WWW::SwaggerClient::Object::Body_1->new(); # Body_1 | 
my $fields = fields_example; # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".

my $species = species_example; # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.

my $dotfield = true; # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.

my $email = email_example; # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.


eval { 
    my $result = $api_instance->postquery(apiecoKey => $apiecoKey, body => $body, fields => $fields, species => $species, dotfield => $dotfield, email => $email);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryApi->postquery: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryApi()
apiecoKey = apiecoKey_example # String | 
body =  # Body_1 | 
fields = fields_example # String | a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
 (optional)
species = species_example # String | can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
 (optional)
dotfield = true # Boolean | control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
 (optional)
email = email_example # String | If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.
 (optional)

try: 
    api_response = api_instance.postquery(apiecoKey, body, fields=fields, species=species, dotfield=dotfield, email=email)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryApi->postquery: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
a comma-separated fields to limit the fields returned from the matching gene hits. The supported field names can be found from any gene object (e.g. http://mygene.info/v3/gene/1017). Note that it supports dot notation as well, e.g., you can pass "refseq.rna". If "fields=all", all available fields will be returned. Default: "symbol,name,taxid,entrezgene,ensemblgene".
species
String
can be used to limit the gene hits from given species. You can use "common names" for nine common species (human, mouse, rat, fruitfly, nematode, zebrafish, thale-cress, frog and pig). All other species, you can provide their taxonomy ids. Multiple species can be passed using comma as a separator. Default: human,mouse,rat.
dotfield
Boolean
control the format of the returned fields when passed "fields" parameter contains dot notation, e.g. "fields=refseq.rna". If "true" or "1", the returned data object contains a single "refseq.rna" field, otherwise ("false" or "0"), a single "refseq" field with a sub-field of "rna". Default: true.
email
String
If you are regular users of our services, we encourage you to provide us an email, so that we can better track the usage or follow up with you.

Responses

Status: 200 - Query response objects with "hits" property