Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
description: 'Low-latency indexed account, token, and public-key lookup APIs for wallets and explorers. Send your FastNEAR API key as an `Authorization: Bearer` header (preferred) or an `apiKey` query parameter. An unrecognized key is rejected with 403.'
title: FastNEAR System API
version: 3.0.3
servers:
- description: Mainnet
url: https://api.fastnear.com
- description: Testnet
url: https://test.api.fastnear.com
security:
- {}
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: System
paths:
/health:
get:
description: 'Ping the FastNEAR API for liveness — returns `{status: ok}` when healthy.'
operationId: get_health
responses:
'200':
content:
application/json:
example:
status: ok
schema:
$ref: '#/components/schemas/HealthResponse'
description: Health status string
'403':
content:
text/plain:
example: Invalid API key
schema:
type: string
description: The supplied API key was not recognized.
'500':
content:
application/json:
schema:
type: string
description: Internal Server Error
summary: Get service health
tags:
- System
x-fastnear-slug: health
x-fastnear-title: FastNEAR API - Health
/status:
get:
description: Check the current indexed block height, latency, and deployed service version.
operationId: get_status
responses:
'200':
content:
application/json:
example:
sync_balance_block_height: 129734103
sync_block_height: 129734103
sync_block_timestamp_nanosec: '1728256282197171397'
sync_latency_sec: 4.671730603
version: 0.10.0
schema:
$ref: '#/components/schemas/StatusResponse'
description: Current FastNEAR API sync status
'403':
content:
text/plain:
example: Invalid API key
schema:
type: string
description: The supplied API key was not recognized.
'500':
content:
application/json:
schema:
type: string
description: Internal Server Error
summary: Get service sync status
tags:
- System
x-fastnear-slug: status
x-fastnear-title: FastNEAR API - Status
components:
schemas:
HealthResponse:
additionalProperties: false
properties:
status:
type: string
required:
- status
type: object
StatusResponse:
additionalProperties: false
properties:
sync_balance_block_height:
format: uint64
minimum: 0
type:
- integer
- 'null'
sync_block_height:
format: uint64
minimum: 0
type:
- integer
- 'null'
sync_block_timestamp_nanosec:
type:
- string
- 'null'
sync_latency_sec:
format: double
type:
- number
- 'null'
version:
type: string
required:
- version
- sync_block_height
- sync_latency_sec
- sync_block_timestamp_nanosec
- sync_balance_block_height
type: object
securitySchemes:
ApiKeyAuth:
description: FastNEAR API key as the `apiKey` query parameter. Handy for curl or clients that cannot set headers, but the key can end up in URLs, logs, and shell history.
in: query
name: apiKey
type: apiKey
BearerAuth:
description: 'FastNEAR API key as an `Authorization: Bearer` header. Preferred for backends, workers, and proxies because it keeps the key out of URLs and logs.'
scheme: bearer
type: http