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:
version: 1.0.0
title: OpenStock Health API
description: 'API provided by Checkmate to partners to provide access to merchant codes and shopper purchase history. All endpoints are POST with batched request/response shapes. Authenticate with `Authorization: Bearer <api_key>`. Ask partner representative for the API key.'
servers:
- url: https://api.openstock.sh
description: Current environment
tags:
- name: Health
paths:
/health:
get:
tags:
- Health
summary: Health check
description: Returns the current health status of the Openstock API.
responses:
'200':
description: Service is healthy
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
components:
schemas:
HealthResponse:
type: object
properties:
ok:
type: boolean
example: true
description: Whether the service is healthy
environment:
type: string
example: local
description: Deployment environment name
required:
- ok
- environment