Heron

Heron Clear API

The Clear API from Heron — 2 operation(s) for clear.

GitHub OpenAPI

Operations 2

POST /api/admin/clear/report Pull a CLEAR report without an end user
POST /api/admin/clear/search Search CLEAR without an end user

Documentation

📖
Documentation
https://docs.herondata.io/
📖
APIReference
https://docs.herondata.io/api-reference/authentication
📖
GettingStarted
https://docs.herondata.io/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/authentication/heron-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/openapi/heron-clear-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/llms/heron-llms.txt
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/heron-clear-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

heron-clear-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data Clear API
  version: '2021-07-19'
servers:
- description: Production
  url: https://app.herondata.io
security:
- ApiKeyAuth:
  - key_XXX
tags:
- name: Clear
paths:
  /api/admin/clear/report:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClearReportRequestSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                properties:
                  cache_hit:
                    type: boolean
                  cost:
                    type: number
                required:
                - cost
                - cache_hit
                type: object
          description: Full CLEAR report
        '422':
          description: CLEAR cannot sell a report for the record
      summary: Pull a CLEAR report without an end user
      tags:
      - Clear
      x-hidden: true
  /api/admin/clear/search:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClearSearchRequestSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  group_count:
                    type: integer
                  results:
                    additionalProperties: true
                    type: object
                required:
                - group_count
                - results
                type: object
          description: Full CLEAR search results
      summary: Search CLEAR without an end user
      tags:
      - Clear
      x-hidden: true
components:
  schemas:
    ClearSearchRequestSchema:
      additionalProperties: false
      properties:
        criteria:
          $ref: '#/components/schemas/ClearSearchCriteria'
        subject_type:
          enum:
          - business
          - person
          type: string
      required:
      - criteria
      - subject_type
      type: object
    ClearReportRequestSchema:
      additionalProperties: false
      properties:
        entity_id:
          minLength: 1
          type: string
        group_id:
          minLength: 1
          type: string
        name:
          type: string
        subject_type:
          enum:
          - business
          - person
          type: string
      required:
      - entity_id
      - group_id
      - name
      - subject_type
      type: object
    ClearSearchCriteria:
      additionalProperties: false
      properties:
        business_name:
          type: string
        city:
          minLength: 1
          type: string
        corporation_id:
          minLength: 1
          type: string
        dob:
          type: string
        first_name:
          type: string
        fuzzy:
          type: boolean
        last_name:
          type: string
        middle_initial:
          type: string
        phone:
          minLength: 1
          type: string
        secondary_last_name:
          type: string
        state:
          minLength: 1
          type: string
        street:
          minLength: 1
          type: string
        zip_code:
          minLength: 1
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey
externalDocs:
  description: Read Tutorial
  url: https://docs.herondata.io/