Get Partner Profile

Get partner account info

curl --request GET \
  --url https://api.hypermid.io/v1/partner/me \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hypermid.io/v1/partner/me"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hypermid.io/v1/partner/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hypermid.io/v1/partner/me",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hypermid.io/v1/partner/me"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hypermid.io/v1/partner/me")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hypermid.io/v1/partner/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  }
}

GET

partner

Get partner account info

curl --request GET \
  --url https://api.hypermid.io/v1/partner/me \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hypermid.io/v1/partner/me"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hypermid.io/v1/partner/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hypermid.io/v1/partner/me",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hypermid.io/v1/partner/me"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hypermid.io/v1/partner/me")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hypermid.io/v1/partner/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  }
}

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

{
  "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
    }
  }
}

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");

curl https://api.hypermid.io/v1/partner/me \
  -H "X-API-Key: your-api-key"

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)

This endpoint requires authentication. Anonymous requests will receive a 401 UNAUTHORIZED error.

Authorizations

X-API-Key

string

header

required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Response

Partner info

data

object

required

Response payload (null on error)

Show child attributes

error

object | null

required

Show child attributes

Overview

Discovery

Swap

On-Ramp

Partner

System

Get Partner Profile

Authorizations

Response