Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Luminance Public API v2 System API
version: '1.5'
description: Luminance offers a RESTful HTTP-based API utilizing JSON as the primary serialization format and OAuth2 for authentication.
servers:
- url: https://{moniker}.app.luminance.com
description: Your Luminance instance
variables:
moniker:
default: your-instance
description: Instance moniker (e.g. acme)
security:
- bearerAuth: []
tags:
- name: System
paths:
/api2/:
get:
tags:
- System
summary: Get system data
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SystemInfo'
example:
product: corporate
version: 4.1.7
api2_version: 1.4.0
operationId: getApi2
x-operation-id-source: derived
components:
schemas:
SystemInfo:
type: object
description: System data returned by GET /api2/
properties:
product:
type: string
description: Product name (e.g. diligence, review)
version:
type: string
description: Luminance version
api2_version:
type: string
description: API v2 version
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Access token from the OAuth2 client credentials flow. See the Authentication section above for how to obtain a token (curl to your instance token endpoint); then paste the access_token here.
'