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

# Get Partner Profile

> Retrieve your partner account details

Returns the authenticated partner's profile, including account settings, fee tier, and rate limits. Requires a valid API key.

<ResponseExample>
  ```json 200 theme={"system"}
  {
    "data": {
      "id": "partner_abc123",
      "name": "My DeFi App",
      "email": "dev@mydefiapp.com",
      "feeTier": {
        "swapFeeBps": 15,
        "onrampFeeBps": 50
      },
      "rateLimit": {
        "requestsPerMinute": 2000
      },
      "webhooksEnabled": true,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-06-20T14:45:00Z"
    },
    "error": null,
    "meta": {
      "requestId": "w3f4a5b6-c7d8-9012-6789-123456789012",
      "timestamp": 1711234581,
      "rateLimit": {
        "limit": 2000,
        "remaining": 1977,
        "reset": 1711234627
      }
    }
  }
  ```
</ResponseExample>

<CodeGroup>
  ```typescript TypeScript theme={"system"}
  const me = await client.getPartnerProfile();

  console.log("Partner:", me.data.name);
  console.log("Swap fee:", me.data.feeTier.swapFeeBps, "bps");
  console.log("Rate limit:", me.data.rateLimit.requestsPerMinute, "req/min");
  ```

  ```bash cURL theme={"system"}
  curl https://api.hypermid.io/v1/partner/me \
    -H "X-API-Key: your-api-key"
  ```

  ```go Go theme={"system"}
  req, _ := http.NewRequest("GET",
      "https://api.hypermid.io/v1/partner/me", nil)
  req.Header.Set("X-API-Key", "your-api-key")
  resp, _ := http.DefaultClient.Do(req)
  ```
</CodeGroup>

<Note>
  This endpoint requires authentication. Anonymous requests will receive a `401 UNAUTHORIZED` error.
</Note>


## OpenAPI

````yaml GET /v1/partner/me
openapi: 3.0.3
info:
  title: Hypermid Partner API
  version: 1.0.0
  description: >-
    Cross-chain swap aggregator API. Supports 30+ EVM chains, Solana, Bitcoin,
    Sui, and Near Intents chains (NEAR, TON, Tron, XRP, etc.).


    ## Authentication

    Pass your API key via the `X-API-Key` header. Public endpoints work without
    a key (anonymous tier). Partner endpoints (`/v1/partner/*`) require a valid
    key.


    ## Rate Limits

    - **Anonymous**: 30 requests/minute (per IP)

    - **Partner (authenticated)**: 100 requests/minute (per API key)


    These limits are designed for human-driven widget usage and mirror our
    upstream aggregator (LiFi) limits to prevent any single user from exhausting
    shared quota.


    Rate limit info is returned in `meta.rateLimit` on every response.


    ## Response Envelope

    All responses follow the shape:

    ```json

    { "data": <T | null>, "error": <{ code, message, details? } | null>, "meta":
    { "requestId", "timestamp", "rateLimit?" } }

    ```
  contact:
    name: Hypermid
    url: https://hypermid.io
servers:
  - url: https://api.hypermid.io
    description: Production
security:
  - ApiKeyAuth: []
  - {}
tags:
  - name: Swap
    description: Cross-chain swap quoting, routing, status, and reference data
  - name: Execute
    description: Transaction execution and deposit management for Near Intents swaps
  - name: On-Ramp
    description: Fiat-to-crypto on-ramp via RampNow
  - name: Partner
    description: Partner account, analytics, and webhook management (requires X-API-Key)
  - name: Tracking
    description: Swap event tracking for partner attribution
  - name: System
    description: Health check and API metadata
paths:
  /v1/partner/me:
    get:
      tags:
        - Partner
      summary: Get partner account info
      description: >-
        Returns the authenticated partner's profile, tier, fee configuration,
        and aggregate stats.
      operationId: getPartnerInfo
      responses:
        '200':
          description: Partner info
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PartnerInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        data:
          description: Response payload (null on error)
        error:
          nullable: true
          type: object
          properties:
            code:
              type: string
              example: INVALID_PARAMS
            message:
              type: string
              example: 'Missing required parameters: fromChain'
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - data
        - error
        - meta
    PartnerInfo:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
        status:
          type: string
        tier:
          type: string
        fee_bps:
          type: integer
        volume_total:
          type: number
        tx_count:
          type: integer
        created_at:
          type: string
          format: date-time
    Meta:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
        timestamp:
          type: integer
          description: Unix epoch seconds
        rateLimit:
          type: object
          properties:
            limit:
              type: integer
            remaining:
              type: integer
            reset:
              type: integer
              description: Unix epoch seconds when the window resets
      required:
        - requestId
        - timestamp
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Partner API key. Optional for public endpoints, required for
        /v1/partner/*.

````