> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptorank.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Persons List
> Persons with category and summary counters for browsing.
Available from: Pro
Cost: 1 credit per request
For full details use [/persons/:id](/api-reference/persons/person-profile) and its sub-endpoints.
## OpenAPI
````yaml https://api.cryptorank.io/v3/documentation-json get /v3/persons/list
openapi: 3.0.0
info:
title: Cryptorank API V3
description: >
# Overview
Cryptorank Public API v3 — comprehensive cryptocurrency data for B2B clients
and partners.
Useful Links:
- [API Plans](https://cryptorank.io/public-api)
- [Dashboard](https://cryptorank.io/public-api/dashboard)
# Getting Started
Primary Server URL:
[https://api.cryptorank.io/v3/](https://api.cryptorank.io/v3/)
**Authentication**
Generate an API key in the
[dashboard](https://cryptorank.io/public-api/dashboard) and pass it in the
`X-Api-Key` header.
Keep your keys secret — never commit them to public repositories or expose
them in client-side code.
version: 3.0.0
contact:
name: Cryptorank Team
url: https://cryptorank.io
email: info@cryptorank.io
servers:
- url: https://api.cryptorank.io
security: []
tags: []
paths:
/v3/persons/list:
get:
tags:
- Persons
summary: Persons List
description: >-
**Description**
Persons with category and summary counters for browsing.
> **Note:** For full details use
[/persons/:id](/api-reference/persons/person-profile) and its
sub-endpoints.
**Access**
- Available from: **Pro**
- Cost: 1 credit per request
operationId: PersonsController_getList
parameters:
- name: page
required: false
in: query
description: Page number (1-based). Returns up to 100 items per page.
schema:
minimum: 1
maximum: 1000
default: 1
type: number
- name: categoryIds
required: false
in: query
description: >-
Comma-separated person category identifiers. Matches persons in any
of the given categories.
schema:
example: 3,6
type: string
- name: sortBy
required: false
in: query
description: Sort field.
schema:
default: id
type: string
enum:
- projectsCount
- name
- id
- name: sortOrder
required: false
in: query
description: Sort direction.
schema:
default: desc
type: string
enum:
- asc
- desc
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
required:
- data
- meta
- status
properties:
data:
type: array
items:
$ref: '#/components/schemas/PersonListItemDto'
meta:
$ref: '#/components/schemas/ListMetaDto'
status:
$ref: '#/components/schemas/ResponseStatusDto'
'400':
description: Request validation failed
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- VALIDATION_ERROR
example: VALIDATION_ERROR
message:
type: string
example: Validation failed
status:
type: number
example: 400
'401':
description: API key is missing or invalid
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- API_KEY_MISSING
- API_KEY_INVALID
example: API_KEY_MISSING
message:
type: string
example: API key is missing
status:
type: number
example: 401
'403':
description: >-
No active subscription, the endpoint is not available in your plan,
or the request goes beyond what your plan allows
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- NO_ACTIVE_SUBSCRIPTION
- ENDPOINT_NOT_AVAILABLE
- PLAN_LIMIT_EXCEEDED
example: NO_ACTIVE_SUBSCRIPTION
message:
type: string
example: No active subscription found
status:
type: number
example: 403
'429':
description: Rate limit or credit limit exceeded
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- RATE_LIMIT_EXCEEDED
- DAILY_CREDITS_EXCEEDED
- MONTHLY_CREDITS_EXCEEDED
example: RATE_LIMIT_EXCEEDED
message:
type: string
example: Rate limit exceeded
status:
type: number
example: 429
'500':
description: Internal server error
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- INTERNAL_ERROR
example: INTERNAL_ERROR
message:
type: string
example: Internal server error
status:
type: number
example: 500
security:
- X-Api-Key: []
components:
schemas:
PersonListItemDto:
type: object
properties:
id:
type: number
example: 1
description: Unique person identifier
slug:
type: string
example: vitalik-buterin
description: URL-friendly identifier
name:
type: string
example: Vitalik Buterin
description: Display name
categories:
description: Person categories
type: array
items:
$ref: '#/components/schemas/PersonCategoryDto'
projectsCount:
type: number
example: 12
description: Total number of projects this person is associated with
required:
- id
- slug
- name
- categories
- projectsCount
ListMetaDto:
type: object
properties:
page:
type: number
example: 1
description: Current page number (1-based)
pageSize:
type: number
example: 25
description: >-
Fixed number of items per page for this endpoint (varies per
endpoint)
hasNextPage:
type: boolean
example: true
description: Whether a further page of results exists
required:
- page
- pageSize
- hasNextPage
ResponseStatusDto:
type: object
properties:
usedCredits:
type: number
example: 1
description: Credits charged for this request
timestamp:
type: number
example: 1780000000000
description: Server time of the response. Unix timestamp in milliseconds
required:
- usedCredits
- timestamp
PersonCategoryDto:
type: object
properties:
id:
type: number
example: 3
description: Category identifier
slug:
type: string
example: Founder
description: URL-friendly category identifier
name:
type: string
example: Founder
description: Category name
description:
type: string
example: Founder
description: Category description
required:
- id
- slug
- name
- description
securitySchemes:
X-Api-Key:
name: X-Api-Key
type: apiKey
in: header
````