# Genomics API . references

## Instance Methods

Returns the bases Resource.

Gets a reference. Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).

Searches for references which match the given criteria. Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).

### Method Details

`get(referenceId, x__xgafv=None)`

    Gets a reference. Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).

    Args:
      referenceId: string, The ID of the reference. (required)
      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets.
        "name": "A String", # The name of this reference, for example `22`.
        "sourceUri": "A String", # The URI from which the sequence was obtained. Specifies a FASTA format file/string with one name, sequence pair.
        "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `GCF_000001405.26`.
          "A String",
        ],
        "length": "A String", # The length of this reference's sequence.
        "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not specified by the containing reference set.
        "id": "A String", # The server-generated reference ID, unique across all references.
        "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
      }

`search(body, x__xgafv=None)`

    Searches for references which match the given criteria. Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).

    Args:
      body: object, The request body. (required)
        The object takes the form of:

    {
        "md5checksums": [ # If present, return references for which the `md5checksum` matches. See `Reference.md5checksum` for construction details.
          "A String",
        ],
        "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
        "referenceSetId": "A String", # If present, return only references which belong to this reference set.
        "accessions": [ # If present, return references for which the accession matches this string. Best to give a version number, for example `GCF_000001405.26`. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences.
          "A String",
        ],
        "pageSize": 42, # Specifies the maximum number of results to return in a single page.
      }

      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
        "references": [ # The matching references.
          { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets.
            "name": "A String", # The name of this reference, for example `22`.
            "sourceUri": "A String", # The URI from which the sequence was obtained. Specifies a FASTA format file/string with one name, sequence pair.
            "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `GCF_000001405.26`.
              "A String",
            ],
            "length": "A String", # The length of this reference's sequence.
            "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not specified by the containing reference set.
            "id": "A String", # The server-generated reference ID, unique across all references.
            "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
          },
        ],
      }