Paradex Trade API

https://docs.paradex.trade/api
Admin
Paradex Trade API is a REST and WebSocket API for the $DIME Nation Launch Exchange, providing access...
Tokens:2,240,267
Snippets:10,382
Trust Score:8.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### Onboard to Paradex API using Go

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This Go code illustrates onboarding to the Paradex API by making a POST request. It utilizes the standard `net/http` package to construct and send the request with appropriate headers. The example shows basic request setup, but error handling and response processing would need to be added for a complete implementation.

```go
package main
import (
      "bytes"
      "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "PARADEX-ETHEREUM-ACCOUNT": []string{"string"},
        "PARADEX-STARKNET-ACCOUNT": []string{"string"},
        "PARADEX-STARKNET-SIGNATURE": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.prod.paradex.trade/v1/onboarding", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}


```

--------------------------------

### Get Vault Summary - PHP SDK

Source: https://docs.paradex.trade/api/testnet/vaults/get-summary

This PHP code example retrieves vault summary data using the Guzzle HTTP client. It sends a GET request to the API endpoint and echoes the response body. Make sure Guzzle is installed via Composer.

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.testnet.paradex.trade/v1/vaults/summary');

echo $response->getBody();

```

--------------------------------

### Get System Config using PHP Guzzle

Source: https://docs.paradex.trade/api/prod/system/get-config

Fetches the system configuration from the Paradex API using the Guzzle HTTP client in PHP. This example demonstrates making a GET request and echoing the response body. The GuzzleHttp client needs to be installed via Composer.

```php
<?php

require 'vendor/autoload.php'; // Make sure to include Composer's autoloader

use GuzzleHttpClient;

$client = new Client();

try {
    $response = $client->request('GET', 'https://api.prod.paradex.trade/v1/system/config', [
        'headers' => [
            'Accept' => 'application/json'
        ]
    ]);

    echo $response->getBody();
} catch (
GuzzleHttpExceptionGuzzleException $e {
    // Handle exceptions, e.g., network errors, 4xx/5xx responses
    echo 'Error: ' . $e->getMessage();
}


```

--------------------------------

### POST /Onboarding

Source: https://docs.paradex.trade/api/prod/system/get-config_explorer=true

Initiates the onboarding process.

```APIDOC
## POST /Onboarding

### Description
Initiates the onboarding process.

### Method
POST

### Endpoint
/Onboarding

### Parameters
No parameters.

### Request Body
No request body

### Request Example
No Request Example

### Response
No response documentation

### Response Example
No Response Example
```

--------------------------------

### Get XP Balance (V2) using PHP

Source: https://docs.paradex.trade/api/prod/xp-transfers-v-2/get-xp-balance-v-2

This PHP example utilizes the Guzzle HTTP client to fetch the XP balance. It sends a GET request to the API endpoint, including the 'Authorization' header. The response body is then echoed. Ensure Guzzle is installed in your PHP project.

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prod.paradex.trade/v1/xp/account-balance', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();

```

--------------------------------

### Onboard to Paradex API using Ruby

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This Ruby code shows how to onboard to the Paradex API using the `net/http` library. It constructs a POST request to the '/v1/onboarding' endpoint, setting necessary headers. The code includes establishing an HTTPS connection and sending the request, then printing the response body. Dependencies include Ruby's standard libraries.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prod.paradex.trade/v1/onboarding")

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

request = Net::HTTP::Post.new(url)
request["PARADEX-ETHEREUM-ACCOUNT"] = 'PARADEX-ETHEREUM-ACCOUNT'
request["PARADEX-STARKNET-ACCOUNT"] = 'PARADEX-STARKNET-ACCOUNT'
request["PARADEX-STARKNET-SIGNATURE"] = 'PARADEX-STARKNET-SIGNATURE'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### Onboard to Paradex API using Python

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This Python code demonstrates how to onboard to the Paradex API using the requests library. It sends a POST request to the '/v1/onboarding' endpoint with necessary headers. Dependencies include the 'requests' library. The input is configured via headers, and the output is the JSON response from the API.

```python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'PARADEX-ETHEREUM-ACCOUNT': 'string',
  'PARADEX-STARKNET-ACCOUNT': 'string',
  'PARADEX-STARKNET-SIGNATURE': 'string'
}

r = requests.post('https://api.prod.paradex.trade/v1/onboarding', headers = headers)

print(r.json())

```

--------------------------------

### Get Market BBO using Go

Source: https://docs.paradex.trade/api/testnet/markets/get-bbo

Demonstrates fetching market BBO in Go using the standard `net/http` package. This example shows basic request setup and error handling, requiring manual completion for response processing.

```go
package main
import (
      "bytes"
      "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/bbo/{market}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

--------------------------------

### Onboard to Paradex Trade API using Ruby

Source: https://docs.paradex.trade/api/testnet/authentication/onboarding

This Ruby example shows how to perform onboarding to the Paradex Trade API using Net::HTTP. It sets up a POST request with required headers and sends it to the specified URL. This code utilizes Ruby's built-in Net::HTTP library.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.testnet.paradex.trade/v1/onboarding")

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

request = Net::HTTP::Post.new(url)
request["PARADEX-ETHEREUM-ACCOUNT"] = 'PARADEX-ETHEREUM-ACCOUNT'
request["PARADEX-STARKNET-ACCOUNT"] = 'PARADEX-STARKNET-ACCOUNT'
request["PARADEX-STARKNET-SIGNATURE"] = 'PARADEX-STARKNET-SIGNATURE'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### Get System State using TypeScript

Source: https://docs.paradex.trade/api/prod/system/get-state_explorer=true

Fetches the current system state from the Paradex API using TypeScript. This example demonstrates making a GET request to the /v1/system/state endpoint, useful for monitoring API health. Ensure you have an HTTP client library installed.

```typescript
fetch('https://api.prod.paradex.trade/v1/system/state').then(response => response.json()).then(data => console.log(data)).catch(error => console.error('Error:', error));
```

--------------------------------

### Onboard to Paradex Trade API using Go

Source: https://docs.paradex.trade/api/testnet/authentication/onboarding

This Go code snippet illustrates how to onboard to the Paradex Trade API. It constructs an HTTP POST request with specific headers and sends it to the API endpoint. This example requires basic knowledge of Go's net/http package.

```go
package main
import (
      "bytes",
      "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "PARADEX-ETHEREUM-ACCOUNT": []string{"string"},
        "PARADEX-STARKNET-ACCOUNT": []string{"string"},
        "PARADEX-STARKNET-SIGNATURE": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/onboarding", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}


```

--------------------------------

### Get XP Transfer Fee Configuration with PHP and Guzzle

Source: https://docs.paradex.trade/api/testnet/xp-transfers-v-2/get-transfer-fee-config-v-2

This PHP example utilizes the Guzzle HTTP client to fetch the XP transfer fee configuration from the Paradex API. It sends a GET request to the specified endpoint and echoes the response body. Make sure you have Guzzle installed via Composer.

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.testnet.paradex.trade/v1/xp/fee-config');

echo $response->getBody();

```

--------------------------------

### Onboard to Paradex API using PHP

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This PHP code example shows how to onboard to the Paradex API using the Guzzle HTTP client. It sends a POST request to the '/v1/onboarding' endpoint, configuring headers and an empty JSON body. The response body is then echoed. Dependencies include the GuzzleHttp client library.

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.prod.paradex.trade/v1/onboarding', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PARADEX-ETHEREUM-ACCOUNT' => 'PARADEX-ETHEREUM-ACCOUNT',
    'PARADEX-STARKNET-ACCOUNT' => 'PARADEX-STARKNET-ACCOUNT',
    'PARADEX-STARKNET-SIGNATURE' => 'PARADEX-STARKNET-SIGNATURE',
  ],
]);

echo $response->getBody();

```

--------------------------------

### Get Available Vaults - C# SDK Example

Source: https://docs.paradex.trade/api/prod/vaults/get

Demonstrates retrieving vaults using `RestClient` in C#. This example executes a GET request and captures the response.

```csharp
var client = new RestClient("https://api.prod.paradex.trade/v1/vaults");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

--------------------------------

### Onboard to Paradex API using Java

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This Java code snippet demonstrates onboarding to the Paradex API using the Unirest library. It constructs a POST request to the '/v1/onboarding' endpoint, setting various headers and an empty JSON body. The response is captured as a String. Dependencies include the Unirest library.

```java
HttpResponse<String> response = Unirest.post("https://api.prod.paradex.trade/v1/onboarding")
  .header("PARADEX-ETHEREUM-ACCOUNT", "PARADEX-ETHEREUM-ACCOUNT")
  .header("PARADEX-STARKNET-ACCOUNT", "PARADEX-STARKNET-ACCOUNT")
  .header("PARADEX-STARKNET-SIGNATURE", "PARADEX-STARKNET-SIGNATURE")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

```

--------------------------------

### Get Available Vaults - Java SDK Example

Source: https://docs.paradex.trade/api/prod/vaults/get

A Java example using `Unirest` to make a GET request to the vaults endpoint. It retrieves the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.prod.paradex.trade/v1/vaults")
  .asString();
```

--------------------------------

### Onboard to Paradex API using Swift

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This Swift code demonstrates onboarding to the Paradex API using `URLSession`. It constructs a POST request to the '/v1/onboarding' endpoint, setting necessary headers and an empty JSON body. The code includes initiating a data task to send the request and handle potential errors. Dependencies are standard iOS/macOS frameworks.

```swift
import Foundation

let headers = [
  "PARADEX-ETHEREUM-ACCOUNT": "PARADEX-ETHEREUM-ACCOUNT",
  "PARADEX-STARKNET-ACCOUNT": "PARADEX-STARKNET-ACCOUNT",
  "PARADEX-STARKNET-SIGNATURE": "PARADEX-STARKNET-SIGNATURE",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prod.paradex.trade/v1/onboarding")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

```

--------------------------------

### Get Available Vaults - Swift SDK Example

Source: https://docs.paradex.trade/api/prod/vaults/get

A Swift example using `URLSession` to fetch vaults. It constructs an `NSMutableURLRequest` for a GET request and resumes the data task.

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prod.paradex.trade/v1/vaults")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### POST Create Onboarding - cURL

Source: https://docs.paradex.trade/api/prod/authentication/onboarding_explorer=true

Initiates the onboarding process for a new user. Requires Ethereum and Starknet account details, along with a Starknet signature. The request body can optionally include marketing code, public key, referral code, and UTM parameters.

```bash
curl -X POST https://api.prod.paradex.trade/v1/onboarding \
     -H "PARADEX-ETHEREUM-ACCOUNT: PARADEX-ETHEREUM-ACCOUNT" \
     -H "PARADEX-STARKNET-ACCOUNT: PARADEX-STARKNET-ACCOUNT" \
     -H "PARADEX-STARKNET-SIGNATURE: PARADEX-STARKNET-SIGNATURE" \
     -H "Content-Type: application/json" \
     -d '{}'
```

--------------------------------

### Get Vault Summary Example (TypeScript)

Source: https://docs.paradex.trade/api/prod/vaults/get-summary_explorer=true

Example of how to fetch the vault summary using TypeScript. This demonstrates making an HTTP GET request.

```typescript
// Example for TypeScript
async function getVaultSummary() {
  const response = await fetch('https://api.prod.paradex.trade/v1/vaults/summary');
  const data = await response.json();
  console.log(data);
}
```

--------------------------------

### POST Onboarding

Source: https://docs.paradex.trade/api/testnet/markets/get-markets_explorer=true

Handles the onboarding process.  This likely involves user registration and account setup.

```APIDOC
## POST Onboarding

### Description
Handles the onboarding process.

### Method
POST

### Endpoint
/onboarding

### Parameters
No parameters provided in original documentation

### Request Example
Not provided in original documentation

### Response
Not provided in original documentation
```

--------------------------------

### Get Vault Summary Example (cURL)

Source: https://docs.paradex.trade/api/prod/vaults/get-summary_explorer=true

Example of how to fetch the vault summary using cURL. This demonstrates a basic GET request to the API.

```shell
curl https://api.prod.paradex.trade/v1/vaults/summary
```

--------------------------------

### Get Available Vaults - JavaScript SDK Example

Source: https://docs.paradex.trade/api/prod/vaults/get

Shows how to fetch available vaults using the JavaScript `fetch` API. This example makes a GET request and handles the JSON response, including basic error handling.

```javascript
const url = 'https://api.prod.paradex.trade/v1/vaults';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

--------------------------------

### POST Create Onboarding - TypeScript

Source: https://docs.paradex.trade/api/prod/authentication/onboarding_explorer=true

Initiates the onboarding process for a new user using TypeScript. This example demonstrates how to set up the request with necessary headers and an empty JSON body.

```typescript
const url = 'https://api.prod.paradex.trade/v1/onboarding';
const headers = {
  'PARADEX-ETHEREUM-ACCOUNT': 'PARADEX-ETHEREUM-ACCOUNT',
  'PARADEX-STARKNET-ACCOUNT': 'PARADEX-STARKNET-ACCOUNT',
  'PARADEX-STARKNET-SIGNATURE': 'PARADEX-STARKNET-SIGNATURE',
  'Content-Type': 'application/json'
};

fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify({})
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### POST /v1/onboarding

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

Onboards a user by verifying ownership of a StarkNet address and adding them to the database. This operation is idempotent.

```APIDOC
## POST /v1/onboarding

### Description
Onboarding verifies that the caller owns the StarkNet address and enters them into the database. This call is idempotent.

### Method
POST

### Endpoint
https://api.prod.paradex.trade/v1/onboarding

### Parameters
#### Header Parameters
- **PARADEX-ETHEREUM-ACCOUNT** (string) - Required - Ethereum account used to onboard
- **PARADEX-STARKNET-ACCOUNT** (string) - Required - Starknet address
- **PARADEX-STARKNET-SIGNATURE** (string) - Required - Starknet signature

#### Request Body
- **public_key** (string) - Required - The public key of the user.
- **referral_code** (string) - Optional - A referral code for the user.
- **marketing_code** (string) - Optional - A marketing code for the user.
- **utm** (object) - Optional - UTM parameters for tracking.
  - **campaign** (string) - Optional - The UTM campaign.
  - **source** (string) - Optional - The UTM source.

### Request Example
```json
{
  "public_key": "0x1234567890abcdef1234567890abcdef1234567890",
  "referral_code": "REF123",
  "marketing_code": "MARK456",
  "utm": {
    "campaign": "summer_sale",
    "source": "email"
  }
}
```

### Response
#### Success Response (200)
An empty response body indicates success.

#### Response Example
```json
{
  "message": "Onboarding successful"
}
```

#### Error Responses
- **400 Bad Request**: Indicates an issue with the request payload or parameters.
- **401 Unauthorized**: Indicates that the request is not authenticated or authorized.
```

--------------------------------

### Get Vault Account Summary - SDK Examples

Source: https://docs.paradex.trade/api/prod/vaults/get-account-summary

Code examples for fetching vault account summary using various SDKs. These snippets demonstrate how to make a GET request to the API endpoint and include the necessary Authorization header.

```python
import requests

url = "https://api.prod.paradex.trade/v1/vaults/account-summary"

headers = {"Authorization": "<apiKey>"}

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

print(response.json())
```

```javascript
const url = 'https://api.prod.paradex.trade/v1/vaults/account-summary';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.prod.paradex.trade/v1/vaults/account-summary"

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

	req.Header.Add("Authorization", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prod.paradex.trade/v1/vaults/account-summary")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

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

```java
HttpResponse<String> response = Unirest.get("https://api.prod.paradex.trade/v1/vaults/account-summary")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prod.paradex.trade/v1/vaults/account-summary', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();

```

```csharp
var client = new RestClient("https://api.prod.paradex.trade/v1/vaults/account-summary");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prod.paradex.trade/v1/vaults/account-summary")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### Get Vault Summary Example (Python)

Source: https://docs.paradex.trade/api/prod/vaults/get-summary_explorer=true

Example of how to fetch the vault summary using Python. This demonstrates using the 'requests' library for HTTP GET requests.

```python
import requests

def get_vault_summary():
    response = requests.get('https://api.prod.paradex.trade/v1/vaults/summary')
    data = response.json()
    print(data)

get_vault_summary()
```

--------------------------------

### Onboarding - POST Request

Source: https://docs.paradex.trade/api/testnet/account/get-balance_explorer=true

Initiates the onboarding process for a new user or entity. This is typically the first step for new participants.

```shell
POST /v1/authentication/onboarding
Host: api.testnet.paradex.trade
Content-Type: application/json

{
  "email": "<email>",
  "publicKey": "<publicKey>"
}
```

--------------------------------

### Onboard to Paradex API using JavaScript

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This JavaScript code shows how to onboard to the Paradex API using the fetch API. It sends a POST request to the '/v1/onboarding' endpoint with specified headers and body. The code includes handling the JSON response. Dependencies include a modern JavaScript environment with fetch API support.

```javascript
const inputBody = {
  "public_key": "0x3d9f2b2e5f50c1aade60ca540368cd7490160f41270c192c05729fe35b656a9",
  "referral_code": "cryptofox8"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'PARADEX-ETHEREUM-ACCOUNT':'string',
  'PARADEX-STARKNET-ACCOUNT':'string',
  'PARADEX-STARKNET-SIGNATURE':'string'
};

fetch('https://api.prod.paradex.trade/v1/onboarding',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

```

--------------------------------

### Get XP Transfer Fee Configuration via SDK

Source: https://docs.paradex.trade/api/prod/xp-transfers-v-2/get-transfer-fee-config-v-2

Examples of how to retrieve the XP transfer fee configuration using the Paradex API in multiple programming languages. Each example demonstrates making a GET request and processing the JSON response.

```python
import requests

url = "https://api.prod.paradex.trade/v1/xp/fee-config"

response = requests.get(url)

print(response.json())

```

```javascript
const url = 'https://api.prod.paradex.trade/v1/xp/fee-config';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

```

```go
package main

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

func main() {

	url := "https://api.prod.paradex.trade/v1/xp/fee-config"

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prod.paradex.trade/v1/xp/fee-config")

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

request = Net::HTTP::Get.new(url)

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

```

```java
HttpResponse<String> response = Unirest.get("https://api.prod.paradex.trade/v1/xp/fee-config")
  .asString();

```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prod.paradex.trade/v1/xp/fee-config');

echo $response->getBody();

```

```csharp
var client = new RestClient("https://api.prod.paradex.trade/v1/xp/fee-config");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prod.paradex.trade/v1/xp/fee-config")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

```

--------------------------------

### Onboard to Paradex Trade API using Python

Source: https://docs.paradex.trade/api/testnet/authentication/onboarding

This snippet shows how to onboard to the Paradex Trade API using Python's requests library. It sends a POST request with necessary headers to the onboarding endpoint. Ensure you have the 'requests' library installed.

```python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'PARADEX-ETHEREUM-ACCOUNT': 'string',
  'PARADEX-STARKNET-ACCOUNT': 'string',
  'PARADEX-STARKNET-SIGNATURE': 'string'
}

r = requests.post('https://api.testnet.paradex.trade/v1/onboarding', headers = headers)

print(r.json())

```

--------------------------------

### Get Paradex System State (Python)

Source: https://docs.paradex.trade/api/prod/system/get-state

Fetches the current state of the Paradex system using the `requests` library. It sends a GET request to the system state endpoint and prints the JSON response. Ensure the `requests` library is installed (`pip install requests`).

```python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.prod.paradex.trade/v1/system/state', headers = headers)

print(r.json())

```

--------------------------------

### POST Onboarding

Source: https://docs.paradex.trade/api/testnet/subkey/list-subkeys_explorer=true

Initiates the onboarding process for a new user.

```APIDOC
## POST /onboarding

### Description
Initiates the onboarding process.

### Method
POST

### Endpoint
/onboarding

### Parameters
Not specified in the provided documentation.

### Request Example
Not specified in the provided documentation.

### Response
Not specified in the provided documentation.
```

--------------------------------

### Get Trade Tape - Python Example

Source: https://docs.paradex.trade/api/prod/trades/trades_explorer=true

Python code snippet to retrieve the trade tape for a given market. This example uses the 'requests' library to send a GET request to the API.

```python
import requests

def get_trade_tape(market):
    url = "https://api.prod.paradex.trade/v1/trades"
    params = {
        "market": market
    }
    try:
        response = requests.get(url, params=params)
        response.raise_for_status()  # Raise an exception for bad status codes
        data = response.json()
        print(data)
        return data
    except requests.exceptions.RequestException as e:
        print(f"Error fetching trade tape: {e}")
        return None

get_trade_tape('BTC-USD-PERP')
```

--------------------------------

### POST /v1/onboarding

Source: https://docs.paradex.trade/api/prod/authentication/onboarding_explorer=true

Onboards a user by verifying their StarkNet address ownership and entering them into the database. This operation is idempotent.

```APIDOC
## POST /v1/onboarding

### Description
Onboarding verifies that the caller owns the StarkNet address and enters them into the database. This call is idempotent.

### Method
POST

### Endpoint
https://api.prod.paradex.trade/v1/onboarding

### Headers
- **PARADEX-ETHEREUM-ACCOUNT** (string) - Required - Ethereum account used to onboard
- **PARADEX-STARKNET-ACCOUNT** (string) - Required - Starknet address
- **PARADEX-STARKNET-SIGNATURE** (string) - Required - Starknet signature

### Request Body
- **public_key** (string) - Optional - Public key of the user being onboarded.
- **referral_code** (string) - Optional - Referral code of the user who referred the user being onboarded.
- **marketing_code** (string) - Optional - Marketing code of the campaign the user is being onboarded via.
- **utm** (object) - Optional - UTM tracking parameters.
  - **source** (string) - Optional - UTM source.
  - **medium** (string) - Optional - UTM medium.

### Request Example
```json
{
  "public_key": "0x123abc",
  "referral_code": "REF123",
  "marketing_code": "MARKETING456",
  "utm": {
    "source": "google",
    "medium": "cpc"
  }
}
```

### Response
#### Success Response (200)
An empty response body indicates successful onboarding.

#### Response Example
```json
{
}
```

### Errors
- **400** - Bad Request Error
- **401** - Unauthorized Error
```

--------------------------------

### Get Market BBO Interactive - PHP Guzzle Example

Source: https://docs.paradex.trade/api/testnet/markets/get-bbo-interactive

This PHP example utilizes the Guzzle HTTP client to fetch interactive market BBO data. It initializes a Guzzle client, makes a GET request to the specified URL, and echoes the response body.

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.testnet.paradex.trade/v1/bbo/market/interactive');

echo $response->getBody();

```

--------------------------------

### Fetch Trades from Paradex API (PHP)

Source: https://docs.paradex.trade/api/prod/trades/trades

Demonstrates fetching trade data from the Paradex API using the Guzzle HTTP client in PHP. This example makes a GET request to the trades endpoint and outputs the response body. Make sure the GuzzleHttp library is installed via Composer.

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prod.paradex.trade/v1/trades?market=BTC-USD-PERP');

echo $response->getBody();

```

--------------------------------

### Onboarding using POST

Source: https://docs.paradex.trade/api/prod/referrals/get-config_explorer=true

Initiates the onboarding process for a new user account. This may involve creating API keys or setting up initial configurations.

```http
POST /v1/auth/onboarding
Host: api.prod.paradex.trade
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "secure_password"
}
```

--------------------------------

### Onboarding Authentication (POST)

Source: https://docs.paradex.trade/api/testnet/xp-transfers-v-2/get-xp-transfers-v-2_explorer=true

Initiates the onboarding process for new users, likely involving account creation or initial setup steps. This is part of the authentication flow.

```cURL
curl -X POST https://api.testnet.paradex.trade/v1/auth/onboarding
```

```TypeScript
fetch('https://api.testnet.paradex.trade/v1/auth/onboarding', {
  method: 'POST'
});
```

```Python
import requests

response = requests.post('https://api.testnet.paradex.trade/v1/auth/onboarding')
print(response.json())
```

--------------------------------

### Get Market BBO Interactive - JavaScript Fetch API Example

Source: https://docs.paradex.trade/api/testnet/markets/get-bbo-interactive

This JavaScript example shows how to fetch interactive market BBO data using the `fetch` API. It makes a GET request to the specified URL and handles the JSON response, including basic error logging.

```javascript
const url = 'https://api.testnet.paradex.trade/v1/bbo/market/interactive';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

--------------------------------

### POST Onboarding

Source: https://docs.paradex.trade/api/prod/subkey/list-subkeys_explorer=true

Handles the onboarding process.

```APIDOC
## POST Onboarding

### Description
Handles the onboarding process.

### Method
POST

### Endpoint
/onboarding

### Parameters
No parameters provided in the source.

### Request Example
No request body example provided in the source.

### Response
No response example provided in the source.
```

--------------------------------

### Get Vault Summary - Python SDK

Source: https://docs.paradex.trade/api/testnet/vaults/get-summary

This Python code snippet demonstrates how to fetch vault summary metrics using the `requests` library. It sends a GET request to the specified API endpoint and prints the JSON response. Ensure the `requests` library is installed (`pip install requests`).

```python
import requests

url = "https://api.testnet.paradex.trade/v1/vaults/summary"

response = requests.get(url)

print(response.json())
```

--------------------------------

### Onboard to Paradex Trade API using PHP (Guzzle)

Source: https://docs.paradex.trade/api/testnet/authentication/onboarding

This PHP example shows how to onboard to the Paradex Trade API using the Guzzle HTTP client. It sends a POST request with specified headers and an empty JSON body to the API. You need to have Guzzle installed via Composer.

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.testnet.paradex.trade/v1/onboarding', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PARADEX-ETHEREUM-ACCOUNT' => 'PARADEX-ETHEREUM-ACCOUNT',
    'PARADEX-STARKNET-ACCOUNT' => 'PARADEX-STARKNET-ACCOUNT',
    'PARADEX-STARKNET-SIGNATURE' => 'PARADEX-STARKNET-SIGNATURE',
  ],
]);

echo $response->getBody();

```

--------------------------------

### Get Market Data - C#

Source: https://docs.paradex.trade/api/prod/markets/get-markets

Demonstrates fetching market data from the Paradex Trade API using RestClient in C#. This example sets up a GET request and executes it to get the response.

```csharp
var client = new RestClient("https://api.prod.paradex.trade/v1/markets");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Get Vault Account Summary (Example Request - cURL)

Source: https://docs.paradex.trade/api/prod/vaults/get-account-summary_explorer=true

Example of how to fetch the vault account summary using cURL. Requires an Authorization header.

```bash
curl https://api.prod.paradex.trade/v1/vaults/account-summary \
     -H "Authorization: "  
```

--------------------------------

### Onboard to Paradex API using C#

Source: https://docs.paradex.trade/api/prod/authentication/onboarding

This C# code utilizes the RestSharp library to onboard to the Paradex API. It sets up a POST request to the '/v1/onboarding' endpoint, adding required headers and an empty JSON body. The response is executed and stored. Dependencies include the RestSharp NuGet package.

```csharp
var client = new RestClient("https://api.prod.paradex.trade/v1/onboarding");
var request = new RestRequest(Method.POST);
request.AddHeader("PARADEX-ETHEREUM-ACCOUNT", "PARADEX-ETHEREUM-ACCOUNT");
request.AddHeader("PARADEX-STARKNET-ACCOUNT", "PARADEX-STARKNET-ACCOUNT");
request.AddHeader("PARADEX-STARKNET-SIGNATURE", "PARADEX-STARKNET-SIGNATURE");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Onboard to Paradex Trade API using C# (RestSharp)

Source: https://docs.paradex.trade/api/testnet/authentication/onboarding

This C# snippet demonstrates onboarding to the Paradex Trade API using the RestSharp library. It sets up a POST request, adds necessary headers, and sends the request to the API endpoint. Ensure RestSharp is added as a NuGet package.

```csharp
var client = new RestClient("https://api.testnet.paradex.trade/v1/onboarding");
var request = new RestRequest(Method.POST);
request.AddHeader("PARADEX-ETHEREUM-ACCOUNT", "PARADEX-ETHEREUM-ACCOUNT");
request.AddHeader("PARADEX-STARKNET-ACCOUNT", "PARADEX-STARKNET-ACCOUNT");
request.AddHeader("PARADEX-STARKNET-SIGNATURE", "PARADEX-STARKNET-SIGNATURE");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Get Public XP Transfers - Python Example

Source: https://docs.paradex.trade/api/testnet/xp-transfers-v-2/get-public-xp-transfers-v-2_explorer=true

Example of how to fetch public XP transfer history using Python's requests library. This demonstrates making a GET request to the API.

--------------------------------

### POST Create Onboarding - Python

Source: https://docs.paradex.trade/api/prod/authentication/onboarding_explorer=true

Initiates the onboarding process for a new user using Python's requests library. This example shows how to construct the POST request with required headers and an empty JSON body.

```python
import requests

url = 'https://api.prod.paradex.trade/v1/onboarding'
headers = {
    'PARADEX-ETHEREUM-ACCOUNT': 'PARADEX-ETHEREUM-ACCOUNT',
    'PARADEX-STARKNET-ACCOUNT': 'PARADEX-STARKNET-ACCOUNT',
    'PARADEX-STARKNET-SIGNATURE': 'PARADEX-STARKNET-SIGNATURE',
    'Content-Type': 'application/json'
}
data = {}

response = requests.post(url, headers=headers, json=data)
print(response.json())
```

--------------------------------

### Get XP Balance (V2) - cURL Example

Source: https://docs.paradex.trade/api/testnet/xp-transfers-v-2/get-xp-balance-v-2_explorer=true

Retrieves the XP balance for a given account using the V2 endpoint. This requires an Authorization header. The example shows how to make the request using cURL.

```bash
$ curl https://api.testnet.paradex.trade/v1/xp/account-balance \
  -H "Authorization: "
```

--------------------------------

### cURL Onboarding Request

Source: https://docs.paradex.trade/api/prod/authentication/onboarding_explorer=true

This cURL command demonstrates how to initiate the onboarding process for the Paradex Trade API. It includes essential headers such as content type, accept, and account/signature details required for authentication and user registration. The request is designed to be idempotent.

```bash
$| curl -X POST https://api.prod.paradex.trade/v1/onboarding \
---|--- \
>|  -H 'Content-Type: application/json' \
>|  -H 'Accept: application/json' \
>|  -H 'PARADEX-ETHEREUM-ACCOUNT: string' \
>|  -H 'PARADEX-STARKNET-ACCOUNT: string' \
>|  -H 'PARADEX-STARKNET-SIGNATURE: string'
```

--------------------------------

### Get Available Vaults - Ruby SDK Example

Source: https://docs.paradex.trade/api/prod/vaults/get

Illustrates how to get a list of vaults using Ruby's `net/http` library. The code constructs a GET request, sends it, and outputs the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prod.paradex.trade/v1/vaults")

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

request = Net::HTTP::Get.new(url)

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

--------------------------------

### Get Referral Summary - Python

Source: https://docs.paradex.trade/api/prod/referrals/get-summary_explorer=true

Python example for retrieving referral summary data. It shows how to send a GET request with the necessary authorization header.

```python
import requests

def get_referral_summary(api_key):
    headers = {'Authorization': api_key}
    response = requests.get('https://api.prod.paradex.trade/v1/referrals/summary', headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    return response.json()
```

--------------------------------

### Authentication (Onboarding) API (Production)

Source: https://docs.paradex.trade/api/testnet/account/get-accounts_explorer=true

Handles the onboarding process for new users.

```APIDOC
## Authentication (Onboarding) API (Production)

### Description
Endpoint for initiating the user onboarding process.

### POST /authentication/onboarding
#### Description
Onboarding.
```

--------------------------------

### Get Referral Summary - TypeScript

Source: https://docs.paradex.trade/api/prod/referrals/get-summary_explorer=true

Example of fetching the referral summary using TypeScript. This snippet demonstrates how to make a GET request with an Authorization header.

```typescript
async function getReferralSummary(apiKey: string) {
  const response = await fetch('https://api.prod.paradex.trade/v1/referrals/summary', {
    method: 'GET',
    headers: {
      'Authorization': apiKey
    }
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return await response.json();
}
```

--------------------------------

### POST /v1/onboarding

Source: https://docs.paradex.trade/api/testnet/authentication/onboarding

Onboarding verifies that the caller owns the StarkNet address and enters them into the database. This call is idempotent.

```APIDOC
## POST /v1/onboarding

### Description
Onboarding verifies that the caller owns the StarkNet address and enters them into the database. This call is idempotent.

### Method
POST

### Endpoint
https://api.testnet.paradex.trade/v1/onboarding

### Parameters
#### Header Parameters
- **PARADEX-ETHEREUM-ACCOUNT** (string) - Required - Ethereum account used to onboard
- **PARADEX-STARKNET-ACCOUNT** (string) - Required - Starknet address
- **PARADEX-STARKNET-SIGNATURE** (string) - Required - Starknet signature

#### Request Body
- **public_key** (string) - Required - User public key
- **referral_code** (string) - Optional - Referral code
- **marketing_code** (string) - Optional - Marketing code
- **utm** (object) - Optional - UTM parameters
  - **campaign** (string) - Optional
  - **source** (string) - Optional

### Request Example
```json
{
  "public_key": "0x123...abc",
  "referral_code": "REF123",
  "marketing_code": "MKT456",
  "utm": {
    "campaign": "SUMMER_SALE",
    "source": "EMAIL"
  }
}
```

### Response
#### Success Response (200)
- An empty response

#### Response Example
```json
{}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
```

--------------------------------

### Get Balance Example

Source: https://docs.paradex.trade/api/testnet/account/get-balance_explorer=true

Example of how to retrieve account balance using the API.

```APIDOC
## GET /v1/balance

### Description
Retrieves the account balance.

### Method
GET

### Endpoint
https://api.testnet.paradex.trade/v1/balance

### Request Example (cURL)
```bash
curl https://api.testnet.paradex.trade/v1/balance \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response Example
```json
{
  "balance": [
    {
      "asset": "USDC",
      "free": "1000.00",
      "locked": "50.00"
    },
    {
      "asset": "BTC",
      "free": "0.50000",
      "locked": "0.10000"
    }
  ]
}
```
```

--------------------------------

### Onboarding using POST

Source: https://docs.paradex.trade/api/prod/system/get-state_explorer=true

Handles the user onboarding process. This endpoint is typically the first step for new users interacting with the API, potentially involving account setup or key generation.

```json
{
  "email": "user@example.com",
  "name": "User Name"
}
```

--------------------------------

### POST Onboarding

Source: https://docs.paradex.trade/api/testnet/account/update-account-trading-value-display_explorer=true

Initiates the onboarding process.

```APIDOC
## POST Onboarding

### Description
Initiates the onboarding process.

### Method
POST

### Endpoint
/onboarding

### Parameters
#### Path Parameters
- **(path parameters are not provided)**

#### Query Parameters
- **(query parameters are not provided)**

#### Request Body
- **(body parameters are not provided)**

### Request Example
{
  "example": "request body"
}

### Response
#### Success Response (200)
- **(response parameters are not provided)**

#### Response Example
{
  "example": "response body"
}

```

--------------------------------

### Get XP Balance (V2) - Python Example

Source: https://docs.paradex.trade/api/testnet/xp-transfers-v-2/get-xp-balance-v-2_explorer=true

Retrieves the XP balance for a given account using the V2 endpoint. This requires an Authorization header. The example illustrates how to make the request using Python with the requests library.

```python
import requests

def get_xp_account_balance():
    url = "https://api.testnet.paradex.trade/v1/xp/account-balance"
    headers = {
        "Authorization": ""
    }
    response = requests.get(url, headers=headers)
    return response.json()
```
Tokens:
Raw