Ipd Imgt Hla Tools#

Configuration File: ipd_imgt_hla_tools.json Tool Type: Local Tools Count: 3

This page contains all tools defined in the ipd_imgt_hla_tools.json configuration file.

Available Tools#

IPD_get_hla_allele (Type: IPDIMGTHLATool)#

Fetch the full IPD-IMGT/HLA record for a single HLA allele by its IPD accession (e.g. ‘HLA00001’)…

IPD_get_hla_allele tool specification

Tool Information:

  • Name: IPD_get_hla_allele

  • Type: IPDIMGTHLATool

  • Description: Fetch the full IPD-IMGT/HLA record for a single HLA allele by its IPD accession (e.g. ‘HLA00001’). Returns the complete record including allele name, locus, class, sequence, confirmation status, citations, CWD (common/well-documented) status, release history, and cross-references. Use IPD_search_hla_alleles first to obtain an accession. Keyless EMBL-EBI API.

Parameters:

  • accession (string) (required) IPD-IMGT/HLA allele accession (e.g. ‘HLA00001’). Obtain via IPD_search_hla_alleles.

Example Usage:

query = {
    "name": "IPD_get_hla_allele",
    "arguments": {
        "accession": "example_value"
    }
}
result = tu.run(query)

IPD_search_cells (Type: IPDIMGTHLATool)#

Search IPD cell lines (HLA reference cells with their HLA typing) by a field value with complete …

IPD_search_cells tool specification

Tool Information:

  • Name: IPD_search_cells

  • Type: IPDIMGTHLATool

  • Description: Search IPD cell lines (HLA reference cells with their HLA typing) by a field value with complete access through the official opaque cursor. Returns exact total, has_more, and next_cursor; continue with the same query/field/match/limit and cursor=next_cursor. Keyless EMBL-EBI API.

Parameters:

  • query (string) (required) Text to search for (e.g. a cell primary name, or a lab name when field=’lab_of_origin’). The filter expression is built for you.

  • field (string) (optional) Cell field to search (default ‘primary_name’). Other useful fields include ‘lab_of_origin’.

  • match (string) (optional) How to match: ‘contains’ (default, substring), ‘startsWith’ (prefix), or ‘eq’ (exact).

  • limit (integer) (optional) Maximum number of cells to return (default 10, max 100).

  • cursor ([‘string’, ‘null’]) (optional) Opaque continuation token from data.next_cursor. Repeat the same search controls when continuing.

Example Usage:

query = {
    "name": "IPD_search_cells",
    "arguments": {
        "query": "example_value"
    }
}
result = tu.run(query)

IPD_search_hla_alleles (Type: IPDIMGTHLATool)#

Search the IPD-IMGT/HLA database for human HLA alleles by allele name prefix or substring with co…

IPD_search_hla_alleles tool specification

Tool Information:

  • Name: IPD_search_hla_alleles

  • Type: IPDIMGTHLATool

  • Description: Search the IPD-IMGT/HLA database for human HLA alleles by allele name prefix or substring with complete access through the official opaque cursor. Returns matching accessions and names plus exact total, has_more, and next_cursor; continue with the same name/match/limit and cursor=next_cursor. offset/page/skip are ignored by IPD and are therefore not exposed. Keyless EMBL-EBI API.

Parameters:

  • name (string) (required) HLA allele name or partial name to search (e.g. ‘A*01:01’, ‘DRB1*15:01’, ‘B*07’). The filter expression is built for you.

  • match (string) (optional) How to match the name: ‘startsWith’ (default, prefix match), ‘contains’ (substring), or ‘eq’ (exact full name).

  • limit (integer) (optional) Maximum number of alleles to return (default 10, max 100).

  • cursor ([‘string’, ‘null’]) (optional) Opaque continuation token from data.next_cursor. Repeat the same name, match, and limit when continuing.

Example Usage:

query = {
    "name": "IPD_search_hla_alleles",
    "arguments": {
        "name": "example_value"
    }
}
result = tu.run(query)