Create Account Invite

Create or return the authenticated account’s primary invite code. The call is idempotent for accounts that already have a primary invite code.

POST /v1/account/invite

Create Account Invite

cURL

curl --request POST \
  --url https://api.perpetuals.polymarket.com/v1/account/invite \
  --header 'Content-Type: application/json' \
  --header 'POLYMARKET-PROXY: <api-key>' \
  --header 'POLYMARKET-SECRET: <api-key>' \
  --data '{}'

import requests

url = "https://api.perpetuals.polymarket.com/v1/account/invite"

payload = {}
headers = {
    "POLYMARKET-PROXY": "<api-key>",
    "POLYMARKET-SECRET": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'POLYMARKET-PROXY': '<api-key>',
    'POLYMARKET-SECRET': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.perpetuals.polymarket.com/v1/account/invite', 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.perpetuals.polymarket.com/v1/account/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "POLYMARKET-PROXY: <api-key>",
    "POLYMARKET-SECRET: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.perpetuals.polymarket.com/v1/account/invite"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("POLYMARKET-PROXY", "<api-key>")
	req.Header.Add("POLYMARKET-SECRET", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.perpetuals.polymarket.com/v1/account/invite")
  .header("POLYMARKET-PROXY", "<api-key>")
  .header("POLYMARKET-SECRET", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perpetuals.polymarket.com/v1/account/invite")

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

request = Net::HTTP::Post.new(url)
request["POLYMARKET-PROXY"] = '<api-key>'
request["POLYMARKET-SECRET"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

200

{
  "status": "ok",
  "code": "ABC123",
  "referrals_available": 1,
  "cooldown_ms": 1
}

{
  "status": "err",
  "error": "insufficient_margin"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

Request Weight: 1

Authorizations

POLYMARKET-PROXY · string · header · required

Proxy address

POLYMARKET-SECRET · string · header · required

Correponding proxy secret

Body

application/json

Empty invite creation request.

The body is of type object.

Response

200

application/json

Account invite response.

status · enum<string> · required

Available options: ok

code · string · required

Referral or invite code

Example:

"ABC123"

referrals_available · integer · required

Remaining lifetime referrals for this invite code.

Required range: x >= 0

cooldown_ms · integer | null · required

Milliseconds until referrals become available again. Null for lifetime caps because no windowed cooldown applies.

Required range: x >= 0