> ## 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.
# Account Logs
> Paginated request log history for your API key.
Returns a paginated list of your authenticated API requests from the last 30 days. Each log entry shows the HTTP method, endpoint path, status code, latency, requesting IP address, and timestamp.
Logs are returned in reverse chronological order (most recent first). You can filter by status class or endpoint path using query parameters.
**Plan required:** Starter or higher. Free plan callers receive a `403 PLAN_REQUIRED` response.
Log entries are retained for **30 days** for Starter and above. Entries older than 30 days are automatically pruned.
## OpenAPI
````yaml GET /account/logs
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 |
| Growth | 500,000 | 200 | ₦200,000/mo |
| Business | 2,000,000 | 300 | ₦700,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-01T00:00: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: 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:
/account/logs:
get:
tags:
- Account
summary: Paginated request log history
description: >
Returns a paginated, reverse-chronological list of authenticated API
requests made by the user over the last 30 days. Filter by status class
or endpoint path using query parameters.
**Plan required:** Starter or higher
operationId: getAccountLogs
parameters:
- name: page
in: query
description: Page number (1-based).
required: false
schema:
type: integer
minimum: 1
default: 1
- name: limit
in: query
description: Number of log entries per page (1–1000).
required: false
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
- name: status
in: query
description: Filter by HTTP status class.
required: false
schema:
type: string
enum:
- 2xx
- 4xx
- 5xx
- name: endpoint
in: query
description: Filter by endpoint path (partial match).
required: false
schema:
type: string
example: /market
responses:
'200':
description: Request logs retrieved successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SuccessEnvelope'
- type: object
properties:
data:
$ref: '#/components/schemas/AccountLogs'
example:
success: true
data:
logs:
- id: 18471
method: GET
endpoint: /market/snapshot
status_code: 200
latency_ms: 42
ip_address: 102.89.23.14
timestamp: '2026-04-17T14:32:10.000Z'
- id: 18470
method: GET
endpoint: /companies/DANGCEM
status_code: 200
latency_ms: 67
ip_address: 102.89.23.14
timestamp: '2026-04-17T14:31:58.000Z'
pagination:
page: 1
limit: 100
total: 4821
pages: 49
meta:
plan: starter
calls_used: 4822
calls_remaining: 95178
reset_at: '2026-05-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'
AccountLogs:
type: object
properties:
logs:
type: array
items:
type: object
properties:
id:
type: integer
method:
type: string
example: GET
endpoint:
type: string
example: /market/snapshot
status_code:
type: integer
example: 200
latency_ms:
type: integer
description: Request latency in milliseconds.
ip_address:
type: string
description: IP address of the request, or null if undetermined.
nullable: true
timestamp:
type: string
format: date-time
pagination:
type: object
properties:
page:
type: integer
limit:
type: integer
total:
type: integer
pages:
type: integer
description: Full post body in markdown format (frontmatter stripped).
Meta:
type: object
description: Quota and plan metadata included on every authenticated response.
properties:
plan:
type: string
description: Current plan name.
enum:
- free
- starter
- growth
- 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 (1st of next month).
example: '2026-05-01T00:00: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-01T00:00: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).
````