Lumminary

Lumminary API

Introduction The Lumminary API was built to allow third parties to interact with Lumminary customers and gain access to their genetic data. The Lumminary API…

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Introduction

The Lumminary API was built to allow third parties to interact with Lumminary customers and gain access to their genetic data. The Lumminary API is fast, scalable and highly secure. All requests to the Lumminary API take place over SSL, which means all communication of Customer data is encrypted.

Before we dive in, some definitions. This is what we mean by:

TermDefinition
Third partyA third party (also referred to as "partner" or as "you") is a company which offers services and products using genetic data.
Lumminary clientsThe Lumminary client (also referred to as "customer") is an individual who has created an account on the Lumminary platform.
LumminaryThis is us - our services including the Lumminary platform, the API, the DNA App Store, the DNA Vault, the "Connect with Lumminary" button, and the website in its totality.
CWLThis is the acronym for the "Connect with Lumminary" button.
datasetThis is the term we use when we refer to a customer's genetic data.
Lumminary APIThis is a library/module that you can use to integrate your apps with the Lumminary platform.
Lumminary toolkitThis is a stand alone application which helps you integrate with Lumminary without writing any code or interacting with the Lumminary API.

Let's dive in, now.

  • Overview
  • Install Lumminary API Client and Toolkit
  • Obtaining credentials
  • Query customers authorizations
  • Query customer genetic data
  • Submit reports
  • "Connect with Lumminary" button
  • API specs

Overview

In order to use Lumminary services, you'll need to install the Lumminary API Client or Toolkit. The Lumminary API Client and Toolkit are available in multiple programming languages, and we also provide a sandbox environment which you can use for integration and tests.

There are a couple of differences between the API Client and the Toolkit. Mainly, it's about the ease of use for integration. The Toolkit is basically a stand-alone application that facilitates the integration with the Lumminary API without the need to modify your already existing code.

You use the Lumminary API Client when you want to integrate it inside your own application. This means it gives you full flexibility regarding the integration into your own workflow.

You use the Lumminary Toolkit for an integration where the Toolkit is placed alongside your own application. You can use the Toolkit from the CLI - for example, to run a cronjob that processes incoming orders. The Toolkit uses the Lumminary API Client.

Install Lumminary API Client and/or Toolkit

We provide the Lumminary API Client and Toolkit in multiple programming languages - default are PHP (minimum version 7.0), Python2.7 and Python3. However, if you need them in another language (Java, Obj-C, JavaScript, C#, Perl, CURL), please contact us.

How to install the Lumminary API Client

PHP example:

The PHP Lumminary API Client is available at: https://github.com/Lumminary/lumminary-api-client-php

If you are already using Composer, you can import the project by adding the following to your composer.json

"repositories": [
    {
        "type": "git",
        "url": "https://github.com/Lumminary/lumminary-api-client-php.git",
        "reference": "master"
    }
],
"require": {
    "lumminary/api-client-php": "v1.0.6"
}

Then run composer update lumminary/api-client-php

Python example:

The Python Lumminary API Client is available at: https://github.com/Lumminary/lumminary-api-client-python

To install directly, run

pip install git+https://git@github.com/Lumminary/lumminary-api-client-python.git@v1.0.7#egg=lumminary-api-client

Or add the following line in your requirements.txt

git+https://git@github.com/Lumminary/lumminary-api-client-python.git@v1.0.7#egg=lumminary-api-client

How to install the Lumminary Toolkit

PHP example:

The PHP Lumminary Toolkit is available at: https://github.com/Lumminary/lumminary-toolkit-php

To install the Lumminary Toolkit, run the following command where 'lumminary-toolkit-directory' is the directory where you want to install the Lumminary Toolkit:

git clone git@github.com:Lumminary/lumminary-toolkit-php.git lumminary-toolkit-directory

PYTHON example:

The Python Lumminary Toolkit is available at: https://github.com/Lumminary/lumminary-toolkit-python

To install the Lumminary Toolkit, run the following command where 'lumminary-toolkit-directory' is the directory where you want to install the Lumminary Toolkit:

git clone git@github.com:Lumminary/lumminary-toolkit-python.git lumminary-toolkit-directory
cd…

Endpoints 17

Lumminary API Spec

  • POSTGeneral-purpose authentication/auth/jwtNote: * The JWT tokens returned should be passed to any resource that requires authentication, in the Authentication header, in the format Bearer:…
  • GETGet gene by symbol/clients/:clientId/datasets/:datasetId/genes/:geneSymbolGets A gene by its symbol, which can be found by querying the reference/ resource. Will return a 404 if a gene exists as a reference, but its genomic…
  • GETget_client_snp_group/clients/:clientId/datasets/:datasetId/snps/
  • POSTGet a large group of SNPs/clients/:clientId/datasets/:datasetId/snps/SNPs that are not present in the dataset are ignored, 404 is returned only if the dataset/client does not exist
  • GETGet SNP information/clients/:clientId/datasets/:datasetId/snps/:snpIdGets SNP information, as provided by the dataset. If fetching this as an product, the client must have already granted access to the snip (see the 'products'…
  • GETGet product details/products/:productId
  • GETget_authorizations_queue/products/:productId/authorizations?seq_num_start=string
  • GETget_product_authorization/products/:productId/authorizations/:authorizationId
  • POSTSignal that processing is complete, without uploading any result/products/:productId/authorizations/:authorizationId
  • POSTProvide a result for the authorization/products/:productId/authorizations/:authorizationId/credentialsThese can be log-in credentials for a website where the result is available
  • POSTProvide a file result to the authorization, e/products/:productId/authorizations/:authorizationId/file?original_filename=stringg. a pdf report
  • POSTCatch-all Authorization state, for authorizations that passed all verifications and should reach the partner Product, but cannot be fulfilled for various reasons/products/:productId/authorizations/:authorizationId/unfulfillable
  • GETGeneric gene information/reference/genes/databases/:databaseName/accessions/:accession?dbsnp_build=149&reference_genome=GRCH37P13
  • GETReference genome builds/reference/genomes/Lists reference genome builds that are available
  • GETReference genome metadata/reference/genomes/:genomeBuildAccession/chromosomes
  • GETSequence for a region of the reference genome/reference/genomes/:genomeBuildAccession/chromosomes/:chromosomeAccession?range_start=0&range_stop=0Fetch a closed interval of nucleotides on a given chromosome. Includes start and stop positions
  • GETReference SNP data/reference/snps/:snpAccession?dbsnp_version=149&grch_version=GRCH37P13Get reference SNP information, from dbSNP

API details

Base URL
https://api.lumminary.com/v1
Authentication
An API key in the Authorization header
Operations
17 operations on 15 pathsGET 11POST 6
Main resources
Lumminary API Spec 17
Response formats
application/json
Description format
Swagger 2.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Lumminary API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Lumminary API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “General-purpose authentication” (POST /auth/jwt), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Lumminary API?

Introduction The Lumminary API was built to allow third parties to interact with Lumminary customers and gain access to their genetic data. The Lumminary API… It is listed under Data & analytics and has 17 endpoints.

Who publishes the Lumminary API?

It is listed from Lumminary's public API description (an OpenAPI document), not published by Lumminary on Swastik Codes. Anyone who controls lumminary.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Lumminary API?

Requests go to https://api.lumminary.com/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Lumminary API?

With an API key in the Authorization header.

How many endpoints does the Lumminary API have?

17 operations on 15 paths (11 GET, 6 POST). The largest groups are Lumminary API Spec.

Is forking the Lumminary API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.