Warning - This API and documentation are provided as-is basis and are not supported. They may change at any time!
 

API Key

You can generate or see your API key in API settings. The API key should be provided by appending ?api_key=exampleapikey to the end of the path. For example: /api/scripts/info/1?api_key=3d9j3jd9

PHP Examples
For a few examples written in PHP, primarily for the script versions and script download API's click here

Uploaded Scripts

Permissions
GET|POST /api/scripts/?api_key=key
GET|POST /api/scripts/?steamid=:steamid
If you just give a steamid then you won't see disabled or denied scripts. If you do give an API key it'll just show the scripts of whoever owns the key, but also show all of the scripts.

Response

{
	'status': 'success',
	'scripts': [
		{
			'id': '21',
			'status': '1',
			'name': 'VCMod',
			'views': '1390',
			'banner': 'bannerhash',
			'primary_owner': {
                'steamid': '76561190000000',
                'name": '',
				'avatar': ''
			},
			'is_primary_owner': '1'
		},
		...
	]
}

Script Info

GET|POST /api/scripts/info/:id

Response

{
	'status': 'success',
	'script': {
		'id': 21,
		'name': 'VCMod',
		'description': '',
		'addedDate': '',
		'updatedDate': '',
		'price': '',
		'price_discount': '',
		'status': '',
		'views': '',
		'banner': '',
		'author_steam64': '',
		'author_name': '',
		'author_avatar': '',
		'additional_authors': [
			{
				'steam64': '',
				'name': '',
				'avatar': ''
			}
		],
		'support_team': [
			{
				'steam64': '',
				'name': '',
				'avatar': ''
			}
		]
	}
}

Script Purchases

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/purchases/:id?api_key=key

Response

{
	'status': 'success',
	'purchases': [
		{
			"user_id": "7656119xxxxxxxx",
			"user_name": "Marcuz",
			"purchase_time": "000000000",
			"purchase_revoked": "0",
			"transaction_id": "ABC",
			"price": "0"
		}
	]
}

Script Reviews

GET|POST /api/scripts/reviews/:id

Response

{
	"status": "success",
	"reviews": [
	{
		"review_id": "1",
		"user_id": "7656119xxxxxxxx",
		"user_name": "Happy customer",
		"user_avatar": "steamcdn-a.akamaihd.net\/steamcommunity\/public\/images\/avatars\/a9\/89y3by93yb89.jpg",
		"review_time": "1451620852",
		"purchase_time": "1433369061",
		"review_rating": "5",
		"review_version": "1.0",
		"review_text": "This is like the best script ever!"
	}
}

Script Versions

GET|POST /api/scripts/versions/:id

Response

{
	'status': 'success',
	'versions': [
		{
			'id': 1,
			'title': '1.0.0',
			'description': 'version changes',
			'time': '1451620852'
		}
	]
}

Script Download

Permissions

You must be the owner of the script or purchased the script to successfully download it.

Requires API Key
GET|POST /api/scripts/download/:id?api_key=key&version=versionid

Response

File Download

&version is optional. You can use something like cURL to fetch the file. Please never expose your API key to anyone else, don't download the script with client-side scripts. Download it server side.

List coupons

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/coupon/list/:id?api_key=key

Response

{
	'status': 'success',
	'coupons': [
		{
			'code': '',
			'percent': '',
			'max_uses': '',
			'expires_at': '1451620852',
			'amount_used': ''
		}
	]
}

Script add version

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
POST /api/scripts/version/add/:id?api_key=key
Parameters
  • file
  • - the file itself
  • name
  • - version name
  • changes

Response

{
	"status": "success"
}

Script edit version

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
POST /api/scripts/version/edit/:id?api_key=key
Parameters
  • version
  • - version id, found in versions api
  • file
  • - the file itself, if updated
  • name
  • - version name
  • changes

Response

{
	"status": "success"
}

Script delete version

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/version/delete/:id?api_key=key&version=versionid

Response

{
    "status": "success"
}

Script purchase/unrevoke

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/assignpurchase/:id?api_key=key&steam64=7656119xxxxxxx

Response

{
	"status": "success"
}

Script revoke

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/revokepurchase/:id?api_key=key&steam64=7656119xxxxxxx

Response

{
	"status": "success"
}

Add coupon

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/coupon/add/:id?api_key=key
Parameters
  • code
  • - the actual coupon code
  • percentage
  • - percentage 1-99
  • max_uses
  • - max uses of the coupon code
  • expires
  • - expire time, 0 for never, otherwise a Y-m-d format (e.g: 2016-07-22)

Response

{
	"status": "success"
}

Edit coupon

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/coupon/edit/:id?api_key=key
Parameters
  • id
  • - the id of the coupon
  • code
  • - the actual coupon code
  • percentage
  • - percentage 1-99
  • max_uses
  • - max uses of the coupon code
  • expires
  • - expire time, 0 for never, otherwise a Y-m-d format (e.g: 2016-07-22)

Response

{
	"status": "success"
}

Delete coupon

Permissions

You must be the owner of the script or have sufficient access.

Requires API Key
GET|POST /api/scripts/coupon/delete/:id?api_key=key
Parameters
  • id
  • - the id of the coupon

Response

{
	"status": "success"
}

User search

GET|POST /api/users/search/steam64orname

Response

{
    "status": "success",
    "users": [
        {
            "steamID": "76561197988497435",
            "name": "Marcuz",
            "avatar": "steamcdn-a.akamaihd.net\/steamcommunity\/public\/images\/avatars\/14\/144e5d2b4c91a8d8210f90abf50d65b1d30cb49a_full.jpg",
            "dateRegistered": "1410135487",
            "usergroup": "3",
            "lastAction": "1451245603",
            "country_code": "NO",
            "jobs_rep": "0",
            "scripts_rep": "0"
        }
    ]
}

User search by Steam64

GET|POST /api/users/search/steam64/7656119xxxxx

Response

{
    "status": "success",
    "user": {
        "steamID": "76561197988497435",
        "name": "Marcuz",
        "avatar": "steamcdn-a.akamaihd.net\/steamcommunity\/public\/images\/avatars\/14\/144e5d2b4c91a8d8210f90abf50d65b1d30cb49a_full.jpg",
        "dateRegistered": "1410135487",
        "usergroup": "3",
        "lastAction": "1451245603",
        "country_code": "NO",
        "jobs_rep": "0",
        "scripts_rep": "0"
    }
}

User banned

GET|POST /api/users/banned/steam64

Response

{
    "status": "success",
    "bans": [
        {
            "ban_reason": "Abusing the jobs section",
            "ban_starttime": "1450571340",
            "ban_endtime": "0",
            "ban_unban": null,
            "attributes": {
                "ban_everything": "0",
                "ban_script_creation": "0",
                "ban_script_purchasing": "0",
                "ban_script_downloading": "0",
                "ban_script_reviewing": "0",
                "ban_job_creation": "1",
                "ban_job_applying": "0",
                "ban_user_reviewing": "0",
                "ban_forum_posting": "0",
                "ban_create_appeal": "0"
            }
        }
    ]
}