Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
price-trigger-swaps
/
{price_trigger_swap_id}
curl
curl -X GET "https://api.services.payward.com/v1/accounts/W4BE9868GY65TB6523/price-trigger-swaps/swap_01J0M7C0Z9F8YX3GQH8E" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"
{
  "data": {
    "id": "swap_01J0M7C0Z9F8YX3GQH8E",
    "external_reference": "buy-dip-btc-001",
    "trade": {
      "from": {
        "symbol": "USD",
        "name": "US Dollar",
        "type": "fiat",
        "amount": "100.00"
      },
      "to": {
        "symbol": "BTC",
        "name": "Bitcoin",
        "type": "crypto"
      }
    },
    "when": {
      "base": {
        "symbol": "BTC",
        "name": "Bitcoin",
        "type": "crypto"
      },
      "quote": {
        "symbol": "USD",
        "name": "US Dollar",
        "type": "fiat"
      },
      "drops_to": "50000.00"
    },
    "status": "active"
  }
}

Authorizations

​
API-Key
string
header
required

Your public API key. Identifies the partner making the request.

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Path Parameters

​
account_id
string
required

ID of the account the request applies to. This refers to one of the accounts held by the user the request is acting on behalf of (typically the user's main account, but any of the user's accounts is accepted). Routes the request to that specific account container. Canonical identifier for an account in the Payward public API.

Required string length: 14 - 42
​
price_trigger_swap_id
string
required

ID of the price trigger swap to retrieve (prefixed with swap_).

Response

Successful response

​
data
object

A price trigger swap that submits a trade when its when condition is met.