> ## Documentation Index
> Fetch the complete documentation index at: https://docs.donate.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# List charity coins

> Paginated leaderboard of charity-coin donation subjects.



## OpenAPI

````yaml https://www.donate.gg/api/v1/openapi get /charity-coins
openapi: 3.0.0
info:
  title: Donate Developer API
  version: 1.0.0
  description: >-
    Public JSON API for charities, configs, campaigns, tokens, and related
    catalog reads. GET/HEAD catalog routes may omit `donate-api-key` and are IP
    rate-limited for anonymous callers (~20 req/min). Authenticated keys share
    one organization billing-tier bucket. Create/list/delete configs and project
    analytics require an API key. Spec routes (`/openapi`, `/postman`) are
    unauthenticated and unmetered.
servers:
  - url: /api/v1
    description: API v1 base path (relative to your dashboard origin)
security: []
paths:
  /charity-coins:
    get:
      summary: List charity coins
      description: Paginated leaderboard of charity-coin donation subjects.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: Cursor for next page (from previous pageKey)
          required: false
          description: Cursor for next page (from previous pageKey)
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - top-donated
              - recent-donation
          required: false
          name: sortBy
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          required: false
          name: hideInappropriate
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Optional. Omit for the anonymous IP budget (~20 req/min). Keys
              share their organization billing-tier limit.
          required: false
          description: >-
            Optional. Omit for the anonymous IP budget (~20 req/min). Keys share
            their organization billing-tier limit.
          name: donate-api-key
          in: header
      responses:
        '200':
          description: Paginated charity-coin leaderboard with token image map.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Maximum requests allowed in the current window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests remaining in the current window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix epoch seconds when the current window resets.
          content:
            application/json:
              schema:
                type: object
                properties:
                  pageKey:
                    type: string
                    nullable: true
                  response:
                    type: array
                    items:
                      type: object
                      properties:
                        donationSubject:
                          type: object
                          properties:
                            chainId:
                              type: number
                            address:
                              type: string
                            donationSource:
                              type: object
                              properties:
                                label:
                                  type: string
                                address:
                                  type: string
                                chain:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                    type:
                                      type: string
                                      enum:
                                        - bitcoin
                                        - evm
                                        - solana
                                  required:
                                    - id
                                    - name
                                    - type
                                  additionalProperties: false
                                developerProjectId:
                                  type: string
                              required:
                                - label
                                - address
                                - chain
                                - developerProjectId
                              additionalProperties: false
                            creditedAccount:
                              type: object
                              properties:
                                chain:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                    type:
                                      type: string
                                      enum:
                                        - bitcoin
                                        - evm
                                        - solana
                                  required:
                                    - id
                                    - name
                                    - type
                                  additionalProperties: false
                                address:
                                  type: string
                              required:
                                - chain
                                - address
                              additionalProperties: false
                            type:
                              type: string
                              enum:
                                - token
                            token:
                              type: object
                              properties:
                                id:
                                  type: string
                                chainId:
                                  type: number
                                address:
                                  type: string
                                name:
                                  type: string
                                symbol:
                                  type: string
                                decimals:
                                  type: number
                                standard:
                                  type: string
                                  enum:
                                    - NATIVE
                                    - ERC20
                                    - ERC20PERMIT
                                    - SPL_TOKEN
                                    - SPL_TOKEN2022
                                isNameAppropriate:
                                  type: boolean
                              required:
                                - id
                                - chainId
                                - address
                                - name
                                - symbol
                                - decimals
                                - standard
                                - isNameAppropriate
                              additionalProperties: false
                          required:
                            - chainId
                            - address
                            - donationSource
                            - creditedAccount
                            - type
                            - token
                          additionalProperties: false
                        pendingUsdE6:
                          type: string
                        finalizedUsdE6:
                          type: string
                        displayedUsdE6:
                          type: string
                        pendingCount:
                          type: integer
                        finalizedCount:
                          type: integer
                        donationCount:
                          type: integer
                        firstDonationAt:
                          type: string
                          nullable: true
                        lastDonationAt:
                          type: string
                          nullable: true
                        rank:
                          type: integer
                      required:
                        - donationSubject
                        - pendingUsdE6
                        - finalizedUsdE6
                        - displayedUsdE6
                        - pendingCount
                        - finalizedCount
                        - donationCount
                        - firstDonationAt
                        - lastDonationAt
                        - rank
                      additionalProperties: false
                  tokenImageMap:
                    type: object
                    additionalProperties:
                      type: string
                required:
                  - pageKey
                  - response
                  - tokenImageMap
                additionalProperties: false
        '400':
          description: Validation error.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Maximum requests allowed in the current window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests remaining in the current window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix epoch seconds when the current window resets.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                  - code
                additionalProperties: false
        '429':
          description: >-
            Rate limit exceeded. Retry after the period indicated by the
            Retry-After header.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Maximum requests allowed in the current window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests remaining in the current window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix epoch seconds when the current window resets.
            Retry-After:
              schema:
                type: integer
              description: Seconds until the client should retry.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                required:
                  - error
                  - code
                additionalProperties: false
      security:
        - {}
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: donate-api-key
      description: >-
        Developer API key. Required for config create/list/delete and project
        analytics. Optional on public GET reads (anonymous callers are IP
        rate-limited). Obtain from the Developer dashboard.

````