Affiliate Docs

Limited API for affiliate developers

API versionv0.0.1Last refreshed2025-08-20T21:42:11.302Z UTC

Base URL

https://api.silkbyte.io

Authorization

Some endpoints require authorization. Include the following header:

Header	Value
Authorization	Bearer YOUR_API_KEY

GET/currencies

Get Currencies

This API endpoint returns the paginated list of available currencies.

Parameters

Name	In	Type	Required	Description
page	query	integer	optional	Page number
size	query	integer	optional	Number of items per page
search	query	string \| null	optional	Search query for currency code or name
with_networks	query	boolean	optional	Include network details if True

Sample request

curl -X GET \
https://api.silkbyte.io/currencies?page=%7Bpage%7D&size=%7Bsize%7D&search=%7Bsearch%7D&with_networks=%7Bwith_networks%7D

Responses

Status 200: Successful Response

application/json

Model: ListCurrenciesResponse

Schema

{
  "properties": {
    "data": {
      "items": {
        "$ref": "#/components/schemas/CurrencyResponse"
      },
      "type": "array",
      "title": "Data"
    },
    "count": {
      "type": "integer",
      "title": "Count"
    }
  },
  "type": "object",
  "required": [
    "data",
    "count"
  ],
  "title": "ListCurrenciesResponse"
}

Example

{
  "data": [
    {
      "code": "string",
      "name": "string",
      "icon": "string",
      "notes": "string",
      "networks": [
        null
      ]
    }
  ],
  "count": 0
}

Status 422: Validation Error

application/json

Model: HTTPValidationError

Schema

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Example

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

GET/currencies/{code}/networks

Get Currency Networks

This API endpoint returns networks by currency code.

Parameters

Name	In	Type	Required	Description
code	path	string	required	—

Sample request

curl -X GET \
https://api.silkbyte.io/currencies/%7Bcode%7D/networks

Responses

Status 200: Successful Response

application/json

Schema

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/CurrencyNetworkResponse"
  },
  "title": "Response Get Currency Networks Currencies  Code  Networks Get"
}

Example

[
  {
    "network": "string",
    "name": "string",
    "shortName": "string",
    "addresRegex": "string",
    "notes": "string",
    "isDefault": false,
    "decimal": 0,
    "icon": "string",
    "blockExplorer": "string",
    "depositMinAmount": 0,
    "memoNeeded": false,
    "memoName": "string",
    "memoRegex": "string",
    "precision": 0,
    "contract": "string"
  }
]

Status 422: Validation Error

application/json

Model: HTTPValidationError

Schema

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Example

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

GET/rate

Get Rate

This API endpoint returns amount that user will get, current rate, minimal payment amount required to make an exchange.

Parameters

Name	In	Type	Required	Description
coin_from	query	string	required	Currency to exchange from, e.g. 'ETH'
coin_to	query	string	required	Currency to exchange to, e.g. 'USDT'
amount	query	number	required	Amount of currency to send
network_from	query	string \| null	optional	Network for coin_from (optional)
network_to	query	string \| null	optional	Network for coin_to (optional)
withdrawal_amount	query	number \| null	optional	Optional expected withdrawal amount
rate_type	query	string	optional	Type of coin rate: 'fixed' or 'float'
ref_id	query	string \| null	optional	Referral ID
Authorization	header	string \| null	optional	Bearer auth token

Sample request

curl -X GET \
-H "Authorization: Bearer YOUR_API_KEY" \n+https://api.silkbyte.io/rate?coin_from=%7Bcoin_from%7D&coin_to=%7Bcoin_to%7D&amount=%7Bamount%7D&network_from=%7Bnetwork_from%7D&network_to=%7Bnetwork_to%7D&withdrawal_amount=%7Bwithdrawal_amount%7D&rate_type=%7Brate_type%7D&ref_id=%7Bref_id%7D

Responses

Status 200: Successful Response

application/json

Model: RateResponse

Schema

{
  "properties": {
    "fromAmount": {
      "type": "number",
      "title": "Fromamount"
    },
    "toAmount": {
      "type": "number",
      "title": "Toamount"
    },
    "rate": {
      "type": "number",
      "title": "Rate"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Message"
    },
    "minAmount": {
      "type": "number",
      "title": "Minamount"
    },
    "withdrawMin": {
      "type": "number",
      "title": "Withdrawmin"
    },
    "maxAmount": {
      "type": "number",
      "title": "Maxamount"
    }
  },
  "type": "object",
  "required": [
    "fromAmount",
    "toAmount",
    "rate",
    "minAmount",
    "withdrawMin",
    "maxAmount"
  ],
  "title": "RateResponse"
}

Example

{
  "fromAmount": 0,
  "toAmount": 0,
  "rate": 0,
  "message": "string",
  "minAmount": 0,
  "withdrawMin": 0,
  "maxAmount": 0
}

Status 422: Validation Error

application/json

Model: HTTPValidationError

Schema

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Example

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

GET/transaction/{txid}

Get Transaction

This API endpoint return a transaction by specific txid.

Parameters

Name	In	Type	Required	Description
txid	path	string	required	—

Sample request

curl -X GET \
https://api.silkbyte.io/transaction/%7Btxid%7D

Responses

Status 200: Successful Response

application/json

Model: TransactionResponse

Schema

{
  "properties": {
    "uid": {
      "type": "string",
      "title": "Uid"
    },
    "amount": {
      "type": "number",
      "title": "Amount"
    },
    "amountTo": {
      "type": "number",
      "title": "Amountto"
    },
    "coinFrom": {
      "$ref": "#/components/schemas/TransactionCoin"
    },
    "coinTo": {
      "$ref": "#/components/schemas/TransactionCoin"
    },
    "comment": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Comment"
    },
    "createdAt": {
      "type": "string",
      "title": "Createdat"
    },
    "depositAddress": {
      "type": "string",
      "title": "Depositaddress"
    },
    "depositExtraId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Depositextraid"
    },
    "withdrawalAddress": {
      "type": "string",
      "title": "Withdrawaladdress"
    },
    "withdrawalExtraId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Withdrawalextraid"
    },
    "hashIn": {
      "$ref": "#/components/schemas/TransactionHash"
    },
    "hashOut": {
      "$ref": "#/components/schemas/TransactionHash"
    },
    "rate": {
      "type": "number",
      "title": "Rate"
    },
    "rateType": {
      "type": "string",
      "title": "Ratetype"
    },
    "refundAddress": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Refundaddress"
    },
    "refundExtraId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Refundextraid"
    },
    "status": {
      "type": "string",
      "title": "Status"
    },
    "imported": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Imported"
    }
  },
  "type": "object",
  "required": [
    "uid",
    "amount",
    "amountTo",
    "coinFrom",
    "coinTo",
    "createdAt",
    "depositAddress",
    "withdrawalAddress",
    "hashIn",
    "hashOut",
    "rate",
    "rateType",
    "status"
  ],
  "title": "TransactionResponse"
}

Example

{
  "uid": "string",
  "amount": 0,
  "amountTo": 0,
  "coinFrom": {
    "coinCode": "string",
    "coinName": "string",
    "network": "string",
    "networkName": "string",
    "networkShortName": "string",
    "icon": "string",
    "memoName": "string"
  },
  "coinTo": {
    "coinCode": "string",
    "coinName": "string",
    "network": "string",
    "networkName": "string",
    "networkShortName": "string",
    "icon": "string",
    "memoName": "string"
  },
  "comment": "string",
  "createdAt": "string",
  "depositAddress": "string",
  "depositExtraId": "string",
  "withdrawalAddress": "string",
  "withdrawalExtraId": "string",
  "hashIn": {
    "hash": "string",
    "link": "string"
  },
  "hashOut": {
    "hash": "string",
    "link": "string"
  },
  "rate": 0,
  "rateType": "string",
  "refundAddress": "string",
  "refundExtraId": "string",
  "status": "string",
  "imported": false
}

Status 422: Validation Error

application/json

Model: HTTPValidationError

Schema

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Example

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

POST/transaction

Create Transaction

This API endpoint creates a transaction, generates an address for sending funds and returns transaction attributes.

Parameters

Name	In	Type	Required	Description
coin_from	query	string	required	Source coin code
network_from	query	string	required	Source network
coin_to	query	string	required	Destination coin code
network_to	query	string	required	Destination network
amount	query	integer \| number	required	Amount to exchange
withdrawal_amount	query	number \| integer \| null	optional	Withdrawal amount
withdrawal_address	query	string	required	Withdrawal address
withdrawal_extra_id	query	string \| null	optional	Extra ID for withdrawal
rate_type	query	string	optional	Rate type (fixed/float)
refund_address	query	string \| null	optional	Refund address
refund_extra_id	query	string \| null	optional	Extra ID for refund
ref_id	query	string \| null	optional	Referral ID
Authorization	header	string \| null	optional	Bearer auth token

Sample request

curl -X POST \
-H "Authorization: Bearer YOUR_API_KEY" \n+https://api.silkbyte.io/transaction?coin_from=%7Bcoin_from%7D&network_from=%7Bnetwork_from%7D&coin_to=%7Bcoin_to%7D&network_to=%7Bnetwork_to%7D&amount=%7Bamount%7D&withdrawal_amount=%7Bwithdrawal_amount%7D&withdrawal_address=%7Bwithdrawal_address%7D&withdrawal_extra_id=%7Bwithdrawal_extra_id%7D&rate_type=%7Brate_type%7D&refund_address=%7Brefund_address%7D&refund_extra_id=%7Brefund_extra_id%7D&ref_id=%7Bref_id%7D

Responses

Status 200: Successful Response

application/json

Model: TransactionResponse

Schema

{
  "properties": {
    "uid": {
      "type": "string",
      "title": "Uid"
    },
    "amount": {
      "type": "number",
      "title": "Amount"
    },
    "amountTo": {
      "type": "number",
      "title": "Amountto"
    },
    "coinFrom": {
      "$ref": "#/components/schemas/TransactionCoin"
    },
    "coinTo": {
      "$ref": "#/components/schemas/TransactionCoin"
    },
    "comment": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Comment"
    },
    "createdAt": {
      "type": "string",
      "title": "Createdat"
    },
    "depositAddress": {
      "type": "string",
      "title": "Depositaddress"
    },
    "depositExtraId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Depositextraid"
    },
    "withdrawalAddress": {
      "type": "string",
      "title": "Withdrawaladdress"
    },
    "withdrawalExtraId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Withdrawalextraid"
    },
    "hashIn": {
      "$ref": "#/components/schemas/TransactionHash"
    },
    "hashOut": {
      "$ref": "#/components/schemas/TransactionHash"
    },
    "rate": {
      "type": "number",
      "title": "Rate"
    },
    "rateType": {
      "type": "string",
      "title": "Ratetype"
    },
    "refundAddress": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Refundaddress"
    },
    "refundExtraId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Refundextraid"
    },
    "status": {
      "type": "string",
      "title": "Status"
    },
    "imported": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Imported"
    }
  },
  "type": "object",
  "required": [
    "uid",
    "amount",
    "amountTo",
    "coinFrom",
    "coinTo",
    "createdAt",
    "depositAddress",
    "withdrawalAddress",
    "hashIn",
    "hashOut",
    "rate",
    "rateType",
    "status"
  ],
  "title": "TransactionResponse"
}

Example

{
  "uid": "string",
  "amount": 0,
  "amountTo": 0,
  "coinFrom": {
    "coinCode": "string",
    "coinName": "string",
    "network": "string",
    "networkName": "string",
    "networkShortName": "string",
    "icon": "string",
    "memoName": "string"
  },
  "coinTo": {
    "coinCode": "string",
    "coinName": "string",
    "network": "string",
    "networkName": "string",
    "networkShortName": "string",
    "icon": "string",
    "memoName": "string"
  },
  "comment": "string",
  "createdAt": "string",
  "depositAddress": "string",
  "depositExtraId": "string",
  "withdrawalAddress": "string",
  "withdrawalExtraId": "string",
  "hashIn": {
    "hash": "string",
    "link": "string"
  },
  "hashOut": {
    "hash": "string",
    "link": "string"
  },
  "rate": 0,
  "rateType": "string",
  "refundAddress": "string",
  "refundExtraId": "string",
  "status": "string",
  "imported": false
}

Status 422: Validation Error

application/json

Model: HTTPValidationError

Schema

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Example

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}