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

# Get referral code info

> **Limit: 10 requests per second**

`GET /v1/referral/admin_info`

Scope: Only each builder’s admin wallet can call this endpoint.




## OpenAPI

````yaml orderly.openapi get /v1/referral/admin_info
openapi: 3.0.1
info:
  title: EVM
  description: ''
  version: 1.0.0
servers:
  - url: https://api.orderly.org
    description: Mainnet
  - url: https://testnet-api.orderly.org
    description: Testnet
security: []
tags:
  - name: public
  - name: private
paths:
  /v1/referral/admin_info:
    get:
      tags:
        - private
      summary: Get referral code info
      description: |
        **Limit: 10 requests per second**

        `GET /v1/referral/admin_info`

        Scope: Only each builder’s admin wallet can call this endpoint.
      parameters:
        - name: page
          in: query
          description: start from 1
          required: false
          example: ''
          schema:
            type: string
        - name: size
          in: query
          description: Only one of `user_address` and `account_id` can be provided
          required: false
          example: ''
          schema:
            type: string
        - name: user_address
          in: query
          description: ''
          required: false
          example: ''
          schema:
            type: string
        - name: account_id
          in: query
          description: Only one of `user_address` and `account_id` can be provided
          required: false
          example: ''
          schema:
            type: string
        - name: sort_by
          in: query
          required: false
          description: '`total_invites`/`total_traded`/`referee_volume` descending'
          schema:
            type: string
        - $ref: '#/components/parameters/orderly_timestamp'
        - $ref: '#/components/parameters/orderly_account_id'
        - $ref: '#/components/parameters/orderly_key'
        - $ref: '#/components/parameters/orderly_signature'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReferralCodeResponse'
      deprecated: false
components:
  parameters:
    orderly_timestamp:
      name: orderly-timestamp
      in: header
      description: Timestamp of the signed request in milliseconds.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: '1649920583000'
    orderly_account_id:
      name: orderly-account-id
      in: header
      description: Account ID of the authenticated account.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: 6.858456565150415e+75
    orderly_key:
      name: orderly-key
      in: header
      description: Public orderly key used to sign the request.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX
    orderly_signature:
      name: orderly-signature
      in: header
      description: Signature of the request payload generated with the orderly key.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: >-
        dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==
  schemas:
    GetReferralCodeResponse:
      allOf:
        - $ref: '#/components/schemas/BasicResponse'
        - type: object
          required:
            - data
          properties:
            data:
              type: object
              required:
                - rows
              properties:
                rows:
                  type: array
                  items:
                    type: object
                    properties:
                      account_id:
                        type: string
                        example: >-
                          0x114f583aea808c5812e16109b6c087660285a26f0a31dcc0f9b54f1a6a0fefbd
                      user_address:
                        type: string
                        example: '0xa8ec6970fec8842dd229eef170f624c3d77dab45'
                      number_of_codes:
                        type: integer
                        example: '1'
                      total_invites:
                        type: integer
                        example: 0.03
                      total_traded:
                        type: number
                        example: 0.01
                      referee_volume:
                        type: number
                        example: 0.01
                      referee_fee:
                        type: number
                        example: 0.01
                      orderly_fee:
                        type: number
                        example: 1111
                      referral_codes:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: C4
                            max_rebate_rate:
                              type: number
                              example: 0.4
                            referrer_rebate_rate:
                              type: number
                              example: 0.3
                            referee_rebate_rate:
                              type: number
                              example: 0.1
                            total_referrer_rebate:
                              type: number
                              example: 123.456
                            total_referee_rebate:
                              type: number
                              example: 123.456
                meta:
                  type: object
                  properties:
                    records_per_page:
                      type: integer
                      example: 25
                    current_page:
                      type: integer
                      example: 1
                      description: start from 1
                    total:
                      type: integer
                      example: 50
    BasicResponse:
      required:
        - success
      type: object
      properties:
        success:
          description: Indicates whether the request was successful.
          type: boolean
          example: true
        timestamp:
          description: Server timestamp in milliseconds.
          type: integer
          example: 1702989203989

````