Introduction

Welcome to the Shadowpay API! Use it to send trades, get information about items, buy and sell them!

If you have any questions or suggestions feel free to contact us at: [email protected]

Authentication

All endpoints require an API access token. Visit Shadowpay website to obtain it. The access token should be included in all API requests as a POST or GET parameter, as follows:

token: sometesttoken

If you use Pay by Steam Skin - use SECRET_HASH and PUBLIC_HASH (see information below)

Response Structure

Responses for all endpoints are in JSON format.

Successful API calls contain {"status":"success"} at the root in the response body.

Responses for failed requests will have the error status and contain more details on the error: {"status":"error", "error_message":"some_error"}

Naming Conventions

The project parameter in API requests and responses indicates from which game the item(s) is from.

Value	Game
csgo	Counter-Strike: Global Offensive
dota2	Dota 2
games	SteamCommunity Items

Pay by Steam Skins

Shadowpay offers functionality to refill balance on your website using Steam Skins.

Transaction flow

User clicks the link (button) "Pay By Steam Skin";
Website generates a request to Shadowpay and returns payment link;
Website redirects user to Shadowpay payment link;
User installs the extension or application for automatic, fast, secure trading;
User chooses the skins from his inventory, puts them on sale and waits for buyers. The extension or application sends items to the buyer, the user confirms the trade. For every successfully sold skin your website will receive an IPN with the amount of money for which the item was sold, it's the merchant's responsibility to transfer the amount to the user's account. The amount will also be added to the merchant account on Shadowpay and can be withdrawn.

Getting started:

You should generate Public hash and Secret hash on Shadowpay merchant panel.
Set the callback url to where the IPN (Instant Payment Notifications) will be sent.

Create payment link

{
    "token": "a1d579731b5fd7b7cb8f64c641f73111",
    "url": "https:\/\/shadowpay.com\/en\/pay?token=a1d579731b5fd7b7cb8f64c641f73111",
    "status": "success"
}

$params['signature'] = hash('sha256', $params['order_id'] . $params['amount'] . $params['currency'] . SECRET_HASH);

To initiate the payment the client serer should make the following request to get the payment link.

The user then should be redirected to that payment link to complete the payment.

HTTP Request

POST https://shadowpay.com/en/pay/PUBLIC_HASH

POST Parameters

Parameter	Required	Description
account	true	Users account "id" in your database. Can be steamid. Use INT(unsigned) values only.
order_id	true	Unique order id to identify the payment
security_steam_id	true	User's steamid
currency	true	'USD' - for now only USD is supported
signature	true	Generated Signature
steam_trade_token	false	User's trade token
amount	false	Amount in USD

Receive IPN (Instant Payment Notification)

https://example.com/result?
   amount=6.66
   &token=6764d01a08bdfc50
   &account=demo
   &order_id=12345
   &currency=USD
   &trade_id=786f1d3cccb2828c
   &create_date=2017-06-08+21%3A48%3A02
   &status=complete
   &transaction_id=45f7fa62-622f-48bc-b606-dccd2c662bad
   &ip=0.0.0.0
   &hash=8e27a52faba8b7253e94b1c2b0898ff11713c8dd80d60a112922bf66336fd331

IPN will be sent for each skin the user has sold.

Use this code to validate IPN request.

$string = $_REQUEST['order_id'] . $_REQUEST['amount'] . $_REQUEST['currency'] . $_REQUEST['trade_id'] . SECRET_HASH;
$hash = hash('sha256', $string);

if ($hash !== $_REQUEST['hash']){
    die('wrong params');
}

GET Parameters structure

Parameter	Description
type	Payment type, in this case it will be constant - "payment"
amount	Amount in USD
token	Payment token that was returned on "Create payment link" method
account	Users account "id" in your database. Can be steamid. Use INT(unsigned) values only.
order_id	Unique order id for identify payment
trade_id	Unique id for the trade of one of the items sold in the payment
transaction_id	Unique id of payment
currency	'USD' - for now only USD is supported
status	Payment status, constant - "complete"
hash	Generated Signature
create_date	Date of payment

Composite key transaction_id+trade_id is unique key to identify the transaction

Your server should send a string response to the IPN request to complete the transaction.

String "ok" for a successfully processed transaction. String "error" in case of an error.

In case of repeated IPN requests the partner system should respond with the result of the previous transaction without replenishing/crediting the user's account.

If the partner system does not respond with "ok", Shadowpay will continue to send the notifications at following intervals: +1 min +4 min +12 min +40 min +2 hour +7 hour +24 hour

Shadowpay CORE API

Buy and Sell P2P system

Account

Get account balance

{
    "currency": "USD",
    "balance": "100",
    "deposit_balance": "200",
    "status": "success"
}

This endpoint returns your merchant account balance in USD.

HTTP Request

POST https://shadowpay.com/api/v1/get_balance

POST Parameters

Parameter	Required	Description
token	true	Authorization token

My User's Inventory

{
    "status": "success",
    "total": "2",
    "inv": [
      {
          "price": 0.56,
          "lowest_price": 0.56,
          "max_price": 16.8,
          "fee": 5,
          "steam_market_hash_name": "StatTrak™ MP9 | Deadly Poison (Well-Worn)",
          "assetid": "18720843311",
          "project": "csgo",
          "steam_itemtype": "SMG",
          "rarity": "Mil-Spec",
          "exterior": "Well-Worn",
          "is_stattrak": true,
          "tradable": true,
          "link": "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561198866551033A18720843311D17007496558533575350",
          "skip_reason": false
      },
      {
          "price": 0.52,
          "lowest_price": 0.52,
          "max_price": 15.6,
          "fee": 5,
          "steam_market_hash_name": "Galil AR | Rocket Pop (Field-Tested)",
          "assetid": "15913132055",
          "project": "csgo",
          "steam_itemtype": "Rifle",
          "rarity": "Mil-Spec",
          "exterior": "Field-Tested",
          "is_stattrak": false,
          "tradable": true,
          "link": "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561198866551033A15913132055D16907757831590787875",
          "skip_reason": false
      }
    ]
}

This endpoint returns the inventory of the sub seller, without the items that are already put on sale.

HTTP Request

POST https://shadowpay.com/api/v1/inventory

POST Parameters

Parameter	Required	Description
token	true	Authorization token
steamid	true	your sub seller's steamid
game	true	csgo or dota2

Find Items

Search for items on sale

{
    "data": [
        {
            "id": "289543",
            "steam_market_hash_name": "Glock-18 | Bunsen Burner (Field-Tested)",
            "price": "0.13"
        }
    ],
    "status": "success"
}

This endpoint retrieves all items available for purchase by the given market hash name

HTTP Request

POST https://shadowpay.com/api/v1/search_item

POST Parameters

Parameter	Required	Description
token	true	Authorization token
project	false	(csgo/dota2) Default: csgo
steam_market_hash_name	true	Steam Market Hash Name string

Search items on sale by item name

{
    "data": {
        "Glock-18 | Bunsen Burner (Field-Tested)": [
            {
                "id": "289543",
                "price": "0.13"
            }
        ]
    },
    "status": "success"
}

This endpoint retrieves items available to buy grouped by steam_market_hash_name.

To find a specific item add steam_market_hash_name[increment] = as a POST parameter.

The response array will be sorted by the time of posting in descending order

HTTP Request

POST https://shadowpay.com/api/v1/search_items_by_list_names

POST Parameters

Parameter	Required	Description
token	true	Authorization token
steam_market_hash_name[1]	false	Steam Market Hash Name string
steam_market_hash_name[2]	false	One more Steam Market Hash Name string
project	false	(csgo/dota2) Default: csgo
from	false	Filter for items put on sale after this timestamp
to	false	Filter for items put on sale before this timestamp

Search for similar items

{
  "data": [
    {
      "id": "7408371",
      "steam_market_hash_name": "Rezan The Ready | Sabre",
      "price": "1.66",
      "steam_asset_id": "18213300218",
      "time_created": "2020-04-10 18:26:16"
    },
    {
      "id": "7408370",
      "steam_market_hash_name": "PP-Bizon | Facility Sketch (Factory New)",
      "price": "0.07",
      "steam_asset_id": "17223303564",
      "time_created": "2020-04-10 18:26:12"
    },
    {
      "id": "7408283",
      "steam_market_hash_name": "Desert Eagle | Light Rail (Field-Tested)",
      "price": "1.29",
      "steam_asset_id": "17751160765",
      "time_created": "2020-04-10 18:24:18"
    },
  ],
  "status": "success"
}

This endpoint retrieves items by price range

Ordered by time_created DESC

HTTP Request

POST https://shadowpay.com/api/v1/search_similar_items

POST Parameters

Parameter	Required	Description
token	true	Authorization token
price_from	false	Price from
price_to	false	Price to
project	false	(csgo/dota2) Default: csgo
limit	false	items limit per request (default = 2000)

Get items on sale

{
    "data": [
        {
            "id": "297310",
            "steam_market_hash_name": "MP9 | Ruby Poison Dart (Field-Tested)",
            "price": "18.30",
            "project": "csgo",
            "floatvalue": null,
            "paintindex": null,
            "paintseed": null,
            "time_created": "2020-09-10 12:08:16"
        },
        {
            "id": "297311",
            "steam_market_hash_name": "Nova | Ranger (Battle-Scarred)",
            "price": "4.80",
            "project": "csgo",
            "floatvalue": null,
            "paintindex": null,
            "paintseed": null,
            "time_created": "2020-09-10 12:11:02"
        }
    ]
}

HTTP Request

GET https://shadowpay.com/api/v1/get_items_on_sale

GET Parameters

Parameter	Required	Description
token	true	Authorization token
project	false	csgo/dota2 (default = csgo)
limit	false	items limit per request (default = 15000)
offset	false	items list offset (default = 0)

Get items on sale (Filtered)

{
    "data": [
        {
            "id": "297310",
            "steam_market_hash_name": "MP9 | Ruby Poison Dart (Field-Tested)",
            "price": "18.30",
            "project": "csgo",
            "floatvalue": null,
            "paintindex": null,
            "paintseed": null,
            "time_created": "2020-09-10 12:08:16"
        },
        {
            "id": "297311",
            "steam_market_hash_name": "Nova | Ranger (Battle-Scarred)",
            "price": "4.80",
            "project": "csgo",
            "floatvalue": null,
            "paintindex": null,
            "paintseed": null,
            "time_created": "2020-09-10 12:11:02"
        }
    ]
}

HTTP Request

GET https://shadowpay.com/api/v1/get_items_on_sale_filtered

GET Parameters

Parameter	Required	Description
token	true	Authorization token
project	false	csgo/dota2 (default = csgo)
search	false	search by steam market hash name substring
price_from	false	price lower range (default = 0)
price_to	false	price upper range (default = 10000)
float	false	floatvalue
sort	false	[asc,desc] (default = desc)
sort_column	false	[price,time_created,floatvalue]
limit	false	items limit per request (default = 15000)
offset	false	items list offset (default = 0)

Get steam prices

{
    "data": [
        {
            "steam_market_hash_name": "★ Bayonet | Marble Fade (Minimal Wear)",
            "price": 479.17
        },
        {
            "steam_market_hash_name": "Souvenir PP-Bizon | Night Ops (Battle-Scarred)",
            "price": 11.57
        }
    ]
}

This endpoint return steam prices

HTTP Request

GET https://shadowpay.com/api/v1/get_steam_prices

GET Parameters

Parameter	Required	Description
token	true	Authorization token
project	true	csgo/dota2
limit	false	items limit per request
offset	false	items list offset

Get an item by id

{
    "item": {
        "id": "000000",
        "steam_market_hash_name": "StatTrak™ PP-Bizon | High Roller (Battle-Scarred)",
        "price": 11.57,
        "project": "csgo",
        "floatvalue": "0",
        "paintindex": null,
        "paintseed": null,
        "time_created": "2020-01-10 19:07:38"
    },
    "is_seller_online": true,
    "status": "success"
}

HTTP Request

GET https://shadowpay.com/api/v1/get_item_by_id

GET Parameters

Parameter	Required	Description
token	true	Authorization token
id	true	id in Shadowpay system

Buy

Buy item

{
  "id": "336",
  "trade_data": {
    "id": "336",
    "state": "active",
    "price": "0.25",
    "steam_trade_token": "9Kukc22f",
    "steam_trade_offer_state": null,
    "steam_tradeofferid": null,
    "steam_to_steamid": "76561111111111111",
    "causer": null,
    "time_created": "2019-08-28 20:03:22",
    "custom_id": null,
    "items": [
      {
        "state": "pending",
        "project": "csgo",
        "steam_market_hash_name": "Glock-18 | Candy Apple (Minimal Wear)",
        "steam_asset_id": "15901375629",
        "price": "0.25"
      }
    ]
  },
  "success": true,
  "status": "success"
}

HTTP Request

POST https://shadowpay.com/api/v1/buy_item

POST Parameters

Parameter	Required	Description
token	true	Authorization token
id	true	id in system of item that you want to buy
price	false	Under development
custom_id	false	Your unique identifier for the trade. Can be used to find and track your trade later
steamid	true	Steam ID64 of account to delivery trade
trade_token	true	Steam trade token to delivery trade

Errors

Error Code	Meaning
buy_items_disabled	The market is unavailable now, please try again later
wrong_params	Wrong input parameters or invalid ids
no_item	The item could not be found or is not available anymore
need_sum	Insufficient funds - refill account balance
internal_error	Shadowpay internal error - contact technical support
no_item_in_inventory	The item is not in the seller's inventory
trade_yourself	Can't trade with yourself
seller_offline_error	Seller is offline at the moment
need_apikey	Invalid API Key of seller
invalid_trade_seller_link	Invalid trade link of seller
invalid_tradelink	Invalid trade link
empty_user_data	We can't identify your user
custom_id_exist	The custom_id already exists
error_steam_or_bot	Potential problems with Steam or the bot, try again later
buyer_has_buy_items_ban	The buyer has an active ban on buying items on Shadowpay due to inactivity or fraudulent actions. Find `ban_until` and `ban_reason` in the response for more details.

Sell

Sell items

{
    "created_bid_ids": [
        "296962",
        "296963"
    ],
    "status": "success"
}

Put one to 100 items on sale. The seller user must have the enabled extension, or the application.

HTTP Request

POST https://shadowpay.com/api/v1/sell_items

POST Parameters

Parameter	Required	Description
token	true	Authorization token
steamid	true	user steamid
offers[0][id]	true	item assetid
offers[0][project]	true	csgo or dota2
offers[0][price]	true	item price
offers[1][id]	true	item assetid
offers[1][project]	true	csgo or dota2
offers[1][price]	true	item price
offers[100][id]	true	max items count assetid
offers[100][project]	true	max items count csgo or dota2
offers[100][price]	true	max items coun price

Get my items on sale

{
    "data": [
        {
            "steamid": "76561198856579755",
            "id": "297310",
            "steam_market_hash_name": "MP9 | Ruby Poison Dart (Field-Tested)",
            "price": "18.30",
            "project": "csgo",
            "floatvalue": null,
            "paintindex": null,
            "paintseed": null,
            "time_created": "2020-09-10 12:08:16"
        },
        {
            "steamid": "76561198856579755",
            "id": "297311",
            "steam_market_hash_name": "Nova | Ranger (Battle-Scarred)",
            "price": "4.80",
            "project": "csgo",
            "floatvalue": null,
            "paintindex": null,
            "paintseed": null,
            "time_created": "2020-09-10 12:11:02"
        }
    ]
}

Retrieve the list of your items currently on sale.

HTTP Request

GET https://shadowpay.com/api/v1/get_items_on_sale_filtered

GET Parameters

Parameter	Required	Description
token	true	Authorization token
steamid	false	Steam id of the subseller, if not provided will return items for all subsellers
limit	false	items limit per request (default = 15000)
offset	false	items list offset (default = 0)

Cancel items from sale

{
    "cancelled_items": [
        {
            "assetid": "15913132055",
            "project": "csgo",
            "state": "cancelled"
        },
        {
            "assetid": "18720843311",
            "project": "csgo",
            "state": "cancelled"
        }
    ],
    "not_cancelled_items": [],
    "status": "success"
}

Cancel the sale for one to 100 items for your subseller account. Deals in pending state will not be canceled.

HTTP Request

POST https://shadowpay.com/api/v1/cancel_items

POST Parameters

Parameter	Required	Description
token	true	Authorization token
steamid	true	user steamid
items[0][id]	true	item id in Shadowpay system
items[1][id]	true	item id in Shadowpay system
items[2][id]	true	item id in Shadowpay system
items[100][id]	true	max items count for cancel

Change item price

{
    "id": "296954",
    "new_price": 2,
    "price_rate": 2,
    "status": "success"
}

Change the price of an item on sale

HTTP Request

POST https://shadowpay.com/api/v1/change_item_price

POST Parameters

Parameter	Required	Description
token	true	Authorization token
steamid	true	user steamid
id	true	item id in Shadowpay system
price	true	new item price
currency	true	USD/EUR/RUB/PLN

Operations

Get operations by custom id

{
    "data": {
        "400": {
            "state": "finished",
            "price": "0.20",
            "steam_trade_token": "96rhgftT",
            "steam_trade_offer_state": "3",
            "steam_tradeofferid": "12341234",
            "steam_to_steamid": "76562222222222222",
            "steam_from_steamid": "76561111111111111",
            "causer": null,
            "time_created": "2019-09-04 23:27:09",
            "custom_id": "400",
            "items": [
                {
                    "state": "finished",
                    "project": "csgo",
                    "steam_market_hash_name": "Tec-9 | Isaac (Well-Worn)",
                    "steam_asset_id": "16560280126",
                    "price": "0.20"
                }
            ]
        }
    },
    "status": "success"
}

This endpoint retrieves trades by custom_id, you can track state of your buy transactions.

custom_id could be set as array of keys or single id.

Available States:

active — Trade created and waiting for action.

cancelled — Trade not accepted or not sent, and went to state cancelled.

finished — Trade done successfully.

HTTP Request

POST https://shadowpay.com/api/v1/list_buy_info_by_custom_id

POST Parameters

Parameter	Required	Description
token	true	Authorization token
custom_id	true	Comma separated custom ids

Get operations history

{
  "data": [
    {
      "id": "1494",
      "state": "finished",
      "price": "0.45",
      "steam_trade_token": "NOuSHAho",
      "steam_trade_offer_state": "3",
      "steam_tradeofferid": "3966326233",
      "steam_to_steamid": "76561198008304019",
      "causer": null,
      "time_created": "2020-03-27 16:33:58",
      "custom_id": "marketplace_73_1585326835",
      "items": [
          {
              "state": "finished",
              "project": "csgo",
              "steam_market_hash_name": "Negev | Loudmouth (Field-Tested)",
              "steam_asset_id": "15778802746",
              "price": "0.45"
          }
      ]
    },
    {
      "id": "1487",
      "state": "cancelled",
      "price": "19.48",
      "steam_trade_token": "NOuSHAho",
      "steam_trade_offer_state": "6",
      "steam_tradeofferid": "3962034843",
      "steam_to_steamid": "76561198008304019",
      "causer": "seller",
      "time_created": "2020-03-24 16:05:33",
      "custom_id": "marketplace_73_1585065930",
      "items": [
          {
              "state": "cancelled",
              "project": "csgo",
              "steam_market_hash_name": "Negev | Loudmouth (Field-Tested)",
              "steam_asset_id": "15778802531",
              "price": "19.48"
          }
      ]
    }
  ],
  "status": "success"
}

This endpoint returns your operation history.

HTTP Request

POST https://shadowpay.com/api/v1/operations_history

POST Parameters

Parameter	Required	Description
token	true	Authorization token

Generic Errors

The Shadowpay API uses the following error messages in general:

Error Code	Meaning
internal_error	Your request is invalid.
wrong_params	Check your params or not found any suitable data
wrong_token	Your API token is wrong or not set
wrong_method	Check your params or not found any suitable api method
disabled	Temporary disabled. Try later
no_access	You have no access to request this endpoint
validation_error	Data validation not passed. Check your params