Get details for a single marker

❗️

Heads Up!

This page documents the Advance Access version (think "beta" but with fewer bugs) of the Marker functionality.

Request

This call lists the genetic markers available on a single BAM file. Note that these markers can also be examined via the Seven Bridges Genome Browser.

https://api.sbgenomics.com/v2/genome/markers/{marker_id}
https://eu-api.sbgenomics.com/genome/markers/{marker_id}

Example request

GET /v2/genome/markers/59254a7b92bd172e013a1a91 HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75
X-SBG-Advance-Access: advance
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74',
          advance_access=True)

# send GET request to SB API
marker = api.markers.get(id='59254a7b92bd172e013a1a91')

print(marker.name, marker.file, marker.chromosome, marker.created_by)
print(marker.position.start, marker.position.end)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-Type
required

application/json

X-SBG-Advance-Access
required

advance

Query parameters

Name

Description

marker_id

This is the marker ID for the specific genetic marker you wish to return. Obtain the marker_id for a genetic marker on a BAM file by making the API call to List markers available on a file.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Example response body

The response body contains information about the specified marker.

{
  "href": "http://api.sbgenomics.com/v2/genome/markers/59254a7b92bd172e013a1a91",
  "id": "59254a7b92bd172e013a1a91",
  "name": "Some cancer marker",
  "file": "592444771c94679800e99c23",
  "chromosome": "chr1",
  "position": {
    "start": 1233,
    "end": 1244
  },
  "created_time": "2017-05-24T08:55:00Z",
  "created_by": "rfranklin"
}