> ## Documentation Index
> Fetch the complete documentation index at: https://docs.junction.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Available Biomarkers
> Retrieve lab tests markers via the Junction API. Requires authentication with your team API key.
```bash cURL theme={null}
curl --request GET \
--url '{{BASE_URL}}/v3/lab_tests/markers' \
--header 'accept: application/json' \
--header 'x-vital-api-key: YOUR_API_KEY'
```
```python Python theme={null}
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.lab_tests.get_markers()
```
```typescript TypeScript theme={null}
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.labTests.getMarkers();
```
```java Java theme={null}
import com.junction.api.Junction;
import com.junction.api.core.Environment;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.labTests().getMarkers();
```
```go Go theme={null}
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
response, err := c.LabTests.GetMarkers(context.TODO(), &junction.GetMarkersLabTestsRequest{})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
```
```json Response theme={null}
{
"markers": [
{
"id": 202,
"name": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies",
"slug": "acetylcholine-receptor-achr-antibodies-complete-profile-with-reflex-to-musk-antibodies",
"description": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies",
"lab_id": 6,
"provider_id": "165605",
"type": "biomarker",
"unit": null,
"price": "N/A",
"expected_results": [
{
"id": 2938,
"name": "AChR Blocking Abs, Serum",
"slug": "achr-blocking-abs-serum",
"lab_id": 6,
"provider_id": "085927",
"loinc": {
"id": 3514,
"name": "Acetylcholine receptor blocking Ab Qn (S)",
"slug": "acetylcholine-receptor-blocking-ab-qn-s",
"code": "11561-8",
"unit": "%{inhibition}"
}
},
{
"id": 2939,
"name": "AChR Binding Abs, Serum",
"slug": "achr-binding-abs-serum",
"lab_id": 6,
"provider_id": "085904",
"loinc": {
"id": 3174,
"name": "Acetylcholine receptor binding Ab (S) [Moles/Vol]",
"slug": "acetylcholine-receptor-binding-ab-s-moles-vol",
"code": "11034-6",
"unit": "nmol/L"
}
},
{
"id": 2940,
"name": "AChR-modulating Ab",
"slug": "achr-modulating-ab",
"lab_id": 6,
"provider_id": "505199",
"loinc": {
"id": 61121,
"name": "Acetylcholine receptor modulation Ab FC Ql (S)",
"slug": "acetylcholine-receptor-modulation-ab-fc-ql-s",
"code": "99062-2",
"unit": null
}
}
]
}
],
"total": 2,
"page": 1,
"size": 2
}
```
## OpenAPI
````yaml GET /v3/lab_tests/markers
openapi: 3.1.0
info:
title: Junction API
description: https://docs.junction.com/
version: 0.4.483
servers:
- url: https://api.us.junction.com
x-fern-server-name: Production
- url: https://api.eu.junction.com
x-fern-server-name: ProductionEU
- url: https://api.sandbox.us.junction.com
x-fern-server-name: Sandbox
- url: https://api.sandbox.eu.junction.com
x-fern-server-name: SandboxEU
security:
- apiKeyAuth: []
paths:
/v3/lab_tests/markers:
get:
tags:
- lab_tests
summary: Get Markers
description: >-
List active and orderable markers for a given Lab. Note that reflex
markers are not included.
operationId: get_markers_v3_lab_tests_markers_get
parameters:
- name: lab_id
in: query
required: false
schema:
anyOf:
- items:
type: integer
type: array
- type: 'null'
description: The identifier Vital assigned to a lab partner.
title: Lab Id
description: The identifier Vital assigned to a lab partner.
- name: lab_slug
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: >-
The slug of the lab for these markers. If both lab_id and lab_slug
are provided, lab_slug will be used.
title: Lab Slug
description: >-
The slug of the lab for these markers. If both lab_id and lab_slug
are provided, lab_slug will be used.
- name: name
in: query
required: false
schema:
type: string
description: The name or test code of an individual biomarker or a panel.
default: ''
title: Name
description: The name or test code of an individual biomarker or a panel.
- name: a_la_carte_enabled
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: A La Carte Enabled
- name: lab_account_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: >-
The lab account ID. This lab account is used to determine the
availability of markers and lab tests.
title: Lab Account Id
description: >-
The lab account ID. This lab account is used to determine the
availability of markers and lab tests.
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
title: Page
- name: size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 50
title: Size
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetMarkersResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
GetMarkersResponse:
properties:
markers:
items:
$ref: '#/components/schemas/ClientFacingMarkerComplete'
type: array
title: Markers
total:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Total
page:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Page
size:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Size
pages:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Pages
type: object
required:
- markers
- total
- page
- size
- pages
title: GetMarkersResponse
HTTPValidationError:
properties:
detail:
title: Detail
type: object
title: HTTPValidationError
ClientFacingMarkerComplete:
properties:
id:
type: integer
title: Id
name:
type: string
title: Name
slug:
type: string
title: Slug
description:
anyOf:
- type: string
- type: 'null'
title: Description
lab_id:
anyOf:
- type: integer
- type: 'null'
title: Lab Id
provider_id:
anyOf:
- type: string
- type: 'null'
title: Provider Id
type:
anyOf:
- $ref: '#/components/schemas/MarkerType'
- type: 'null'
description: ℹ️ This enum is non-exhaustive.
unit:
anyOf:
- type: string
- type: 'null'
title: Unit
price:
anyOf:
- type: string
- type: 'null'
title: Price
aoe:
anyOf:
- $ref: '#/components/schemas/AoE'
- type: 'null'
a_la_carte_enabled:
type: boolean
title: A La Carte Enabled
default: false
common_tat_days:
anyOf:
- type: integer
- type: 'null'
title: Common Tat Days
worst_case_tat_days:
anyOf:
- type: integer
- type: 'null'
title: Worst Case Tat Days
is_orderable:
anyOf:
- type: boolean
- type: 'null'
title: Is Orderable
default: true
expected_results:
items:
$ref: '#/components/schemas/ClientFacingResult'
type: array
title: Expected Results
type: object
required:
- id
- name
- slug
- expected_results
title: ClientFacingMarkerComplete
example:
description: >-
Hemoglobin A1c is a form of hemoglobin that is measured identify your
average blood sugar levels over the past 3 months.
expected_results:
- id: 1
lab_id: 1
loinc:
code: 4548-4
id: 1
name: HbA1c (Bld) [Mass fraction]
slug: hba1c-bld-mass-fraction
unit: '%'
name: Hemoglobin A1c
provider_id: '1234'
slug: hemoglobin-a1c
id: 1
lab_id: 1
name: Hemoglobin A1c
price: '10.00'
provider_id: '1234'
slug: hemoglobin-a1c
type: biomarker
unit: '%'
MarkerType:
type: string
enum:
- biomarker
- panel
title: MarkerType
description: ℹ️ This enum is non-exhaustive.
AoE:
properties:
questions:
items:
$ref: '#/components/schemas/Question'
type: array
title: Questions
type: object
required:
- questions
title: AoE
ClientFacingResult:
properties:
id:
type: integer
title: Id
name:
type: string
title: Name
slug:
type: string
title: Slug
lab_id:
anyOf:
- type: integer
- type: 'null'
title: Lab Id
provider_id:
anyOf:
- type: string
- type: 'null'
title: Provider Id
required:
type: boolean
title: Required
loinc:
anyOf:
- $ref: '#/components/schemas/ClientFacingLoinc'
- type: 'null'
type: object
required:
- id
- name
- slug
- required
title: ClientFacingResult
example:
id: 1
lab_id: 1
loinc:
code: 1234-1
id: 1
name: Hemoglobin A1c
slug: hemoglobin-a1c
unit: '%'
name: Hemoglobin A1c
provider_id: '1234'
slug: hemoglobin-a1c
Question:
properties:
id:
type: integer
format: int64
title: Id
required:
type: boolean
title: Required
code:
type: string
title: Code
value:
type: string
title: Value
type:
$ref: '#/components/schemas/QuestionType'
description: ℹ️ This enum is non-exhaustive.
sequence:
type: integer
title: Sequence
answers:
items:
$ref: '#/components/schemas/Answer'
type: array
title: Answers
constraint:
anyOf:
- type: string
- type: 'null'
title: Constraint
default:
anyOf:
- type: string
- type: 'null'
title: Default
type: object
required:
- id
- required
- code
- value
- type
- sequence
- answers
title: Question
ClientFacingLoinc:
properties:
id:
type: integer
title: Id
name:
type: string
title: Name
slug:
type: string
title: Slug
code:
type: string
title: Code
unit:
anyOf:
- type: string
- type: 'null'
title: Unit
type: object
required:
- id
- name
- slug
- code
title: ClientFacingLoinc
example:
code: 1234-1
id: 1
name: Hemoglobin A1c
slug: hemoglobin-a1c
unit: '%'
QuestionType:
type: string
enum:
- choice
- text
- numeric
- multi_choice
title: QuestionType
description: ℹ️ This enum is non-exhaustive.
Answer:
properties:
id:
type: integer
title: Id
code:
type: string
title: Code
value:
type: string
title: Value
type: object
required:
- id
- code
- value
title: Answer
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-vital-api-key
description: Vital Team API Key
````