> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ngnmarket.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Director-Dealings Clusters
> Groups of multiple distinct insiders trading the same symbol in the same direction within a given period.
Returns groups of distinct insiders who traded the same symbol in the same direction within a configurable lookback window. By default, a cluster requires at least three distinct insiders, and you can adjust both the lookback period and minimum number of insiders.
The endpoint identifies patterns in the available filings. It does not determine whether the trades were coordinated or what motivated them.
This endpoint requires a Business plan.
Check `insider_type_breakdown` before interpreting a cluster. It shows the types of insiders represented in the group, which can help distinguish activity spread across employees from activity concentrated among directors or senior officers. For example, a cluster dominated by `employee`/`staff` records may reflect broader employee participation. Both patterns can produce the same basic "N insiders traded" count, so the breakdown provides important context. A cluster should be treated as a pattern in the filings, not as evidence of coordinated intent or investment conviction.
```bash Last 60 days, default threshold theme={null}
curl "https://api.ngnmarket.com/v1/insiders/clusters" \
-H "Authorization: Bearer ngm_live_YOUR_KEY"
```
```bash Wider window, higher threshold theme={null}
curl "https://api.ngnmarket.com/v1/insiders/clusters?days=90&min_insiders=5" \
-H "Authorization: Bearer ngm_live_YOUR_KEY"
```
```javascript JavaScript theme={null}
const res = await fetch(
'https://api.ngnmarket.com/v1/insiders/clusters?days=90&min_insiders=5',
{ headers: { Authorization: 'Bearer ngm_live_YOUR_KEY' } }
);
const { data } = await res.json();
```
```python Python theme={null}
import requests
res = requests.get(
'https://api.ngnmarket.com/v1/insiders/clusters',
params={'days': 90, 'min_insiders': 5},
headers={'Authorization': 'Bearer ngm_live_YOUR_KEY'},
)
data = res.json()['data']
```
## OpenAPI
````yaml GET /insiders/clusters
openapi: 3.1.0
info:
title: NGN Market API
version: '1.0'
description: >
The NGN Market API provides programmatic access to Nigerian Exchange Group
(NGX) market data, including equities, forex rates, company profiles,
indices, bonds, and financial news.
## Base URL
All endpoints are served from:
```
https://api.ngnmarket.com/v1
```
## Authentication
Every request requires a Bearer token in the `Authorization` header:
```
Authorization: Bearer ngm_live_YOUR_KEY
```
Generate and manage your API keys from the [developer
dashboard](https://ngnmarket.com/developer).
## Plans & Quotas
| Plan | Monthly Calls | Requests/min | Price |
| :--- | ---: | ---: | :--- |
| Free | 3,000 | 30 | Free |
| Hobby | 10,000 | 60 | ₦15,000/mo |
| Starter | 100,000 | 120 | ₦50,000/mo |
| Pro | 250,000 | 120 | ₦100,000/mo |
| Business | 2,000,000 | 300 | ₦300,000/mo |
| Enterprise | Unlimited | Unlimited | Custom |
Every response includes a `meta` object showing your current usage and
remaining quota. Exceeding the per-minute rate limit returns `429
RATE_LIMITED`. Exceeding the monthly quota returns `429 QUOTA_EXCEEDED`.
## Response Envelope
All responses use a consistent JSON envelope:
```json
{
"success": true,
"data": { ... },
"meta": {
"plan": "starter",
"calls_used": 4821,
"calls_remaining": 95179,
"reset_at": "2026-05-15T23:57:00.000Z"
}
}
```
contact:
name: NGN Market Support
email: support@ngnmarket.com
url: https://ngnmarket.com
license:
name: Proprietary
servers:
- url: https://api.ngnmarket.com/v1
description: Production
security:
- BearerAuth: []
tags:
- name: Market
description: >-
Daily market snapshots, top trades, movers, market breadth, sectors, and
YTD performers.
- name: Companies
description: >-
Browse, search, and retrieve profiles, price charts, and financial
statements for NGX-listed companies.
- name: Forex
description: Current and historical NGN exchange rates against major currencies.
- name: Indices
description: >-
All NGX market indices, including list, detail with constituents, and
historical chart data.
- name: ETFs
description: >-
NGX-listed Exchange Traded Funds and ETPs — list, full fund detail, and
historical daily price data.
- name: Bonds
description: >-
NGX-listed bond instruments with issuer details, coupon rates, and
maturity dates.
- name: Disclosures
description: >-
Official corporate filings from NGX-listed companies (financial
statements, AGM notices, board meetings, director dealings, earnings
forecasts). Sourced from NGX Group and updated twice daily.
- name: Insiders
description: >-
Structured director-dealings data extracted from NGX PDMR filings.
Per-company and market-wide feeds, aggregated data, and cluster detection
for insiders trading the same symbol and direction within a window.
Distinct from the raw `/disclosures` feed, which only returns filing
metadata.
- name: Blog
description: >-
Published NGN Market blog posts. List, search, and filter by category or
company.
- name: Dividends
description: >-
Market-wide NGX dividend calendar. Browse upcoming and recently paid
dividends across all listed companies with optional search and pagination.
- name: Account
description: >-
Quota status, 30-day request analytics, and paginated request logs for the
authenticated user.
paths:
/insiders/clusters:
get:
tags:
- Insiders
summary: Director-dealings clusters
description: >
Returns groups of distinct insiders who traded the same symbol in the
same direction within a configurable lookback window. By default, a
cluster requires at least three distinct insiders, and you can adjust
both the lookback period and minimum number of insiders.
The endpoint identifies patterns in the available filings. It does not
determine whether the trades were coordinated or what motivated them.
Each cluster includes an `insider_type_breakdown`, a count per
`insider_type`. It shows the types of insiders represented in the group,
which can help distinguish activity spread across employees from
activity concentrated among directors or senior officers. A cluster
dominated by `employee`/`staff` types may reflect broader employee
participation. Both patterns can produce the same basic "N insiders
traded" count, so the breakdown provides important context. A cluster
should be treated as a pattern in the filings, not as evidence of
coordinated intent or investment conviction.
**Plan required:** Business
operationId: getInsiderClusters
parameters:
- name: days
in: query
description: Lookback window in days.
schema:
type: integer
minimum: 7
maximum: 365
default: 60
- name: min_insiders
in: query
description: Minimum distinct insiders required to qualify as a cluster.
schema:
type: integer
minimum: 2
maximum: 20
default: 3
responses:
'200':
description: Clusters retrieved successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SuccessEnvelope'
- type: object
properties:
data:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/InsiderCluster'
days:
type: integer
example: 60
min_insiders:
type: integer
example: 3
examples:
clusters:
summary: Clusters over the last 60 days
value:
success: true
data:
data:
- company_symbol: TRANSCORP
company_name: TRANSNATIONAL CORPORATION PLC
side: buy
insiders: 5
trades: 5
value: 93580528.5
insider_type_breakdown:
senior_officer: 4
executive_director: 1
first_date: '2026-07-25'
last_date: '2026-07-25'
days: 60
min_insiders: 3
meta:
plan: business
calls_used: 4023
calls_remaining: 1995977
reset_at: '2026-10-01T00:00:00.000Z'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PlanRequired'
'429':
$ref: '#/components/responses/QuotaExceeded'
'500':
$ref: '#/components/responses/ServerError'
components:
schemas:
SuccessEnvelope:
type: object
required:
- success
properties:
success:
type: boolean
const: true
meta:
$ref: '#/components/schemas/Meta'
InsiderCluster:
type: object
description: >-
A group of distinct insiders trading the same symbol in the same
direction within a lookback window. Identifies a pattern in the filings,
not coordination or intent.
properties:
company_symbol:
type: string
company_name:
type: string
side:
type: string
enum:
- buy
- sell
insiders:
type: integer
description: Count of distinct insiders in this cluster.
trades:
type: integer
value:
type: number
insider_type_breakdown:
type: object
description: >-
Count of filings per insider_type within this cluster. Shows the
types of insiders represented in the group, which can help
distinguish activity spread across employees from activity
concentrated among directors or senior officers. Does not indicate
whether the trades were coordinated.
additionalProperties:
type: integer
example:
senior_officer: 4
executive_director: 1
first_date:
type: string
format: date
last_date:
type: string
format: date
Meta:
type: object
description: Quota and plan metadata included on every authenticated response.
properties:
plan:
type: string
description: Current plan name.
enum:
- free
- hobby
- starter
- pro
- business
- enterprise
example: starter
calls_used:
type: integer
description: Total calls made this calendar month across all your keys.
example: 4821
calls_remaining:
type: integer
description: Calls remaining before your quota is exhausted.
example: 95179
reset_at:
type: string
format: date-time
description: >-
ISO 8601 UTC timestamp of your next quota reset (your account's
billing renewal date, not the calendar month start).
example: '2026-06-15T23:57:00.000Z'
ErrorEnvelope:
type: object
required:
- success
- error
properties:
success:
type: boolean
const: false
error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Machine-readable error identifier.
example: NOT_FOUND
message:
type: string
description: Human-readable error description.
example: Resource not found.
required_plan:
type: string
description: _(PLAN_REQUIRED only)_ Minimum plan needed.
current_plan:
type: string
description: _(PLAN_REQUIRED only)_ Your current plan.
responses:
Unauthorized:
description: Missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
examples:
missingKey:
summary: Missing Authorization header
value:
success: false
error:
code: MISSING_API_KEY
message: 'Provide your API key via: Authorization: Bearer '
invalidKey:
summary: Invalid or revoked key
value:
success: false
error:
code: INVALID_API_KEY
message: API key not found or revoked.
PlanRequired:
description: Endpoint requires a higher plan.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
success: false
error:
code: PLAN_REQUIRED
message: This endpoint requires a starter plan or higher.
required_plan: starter
current_plan: free
QuotaExceeded:
description: Monthly call limit reached.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorEnvelope'
- type: object
properties:
meta:
$ref: '#/components/schemas/Meta'
example:
success: false
error:
code: QUOTA_EXCEEDED
message: >-
Monthly call limit of 100,000 reached. Resets on
2026-05-01T00:00:00.000Z.
meta:
plan: starter
calls_used: 100000
calls_remaining: 0
reset_at: '2026-05-15T23:57:00.000Z'
ServerError:
description: Unexpected server-side failure. Safe to retry with backoff.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
success: false
error:
code: SERVER_ERROR
message: Something went wrong on our end. Please try again.
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: ngm_live_*
description: >
Pass your API key as a Bearer token: `Authorization: Bearer
ngm_live_YOUR_KEY`.
Generate keys at
[ngnmarket.com/dashboard/developer](https://ngnmarket.com/developer).
````