The ControlResell public API
Automate your business from your own scripts and tools: read your accounts, items and conversations with an API key.
The public API is being rolled out. It is reserved for subscriptions that include it and opened progressively: the key management page is not yet visible on every account. Without access, the API answers with a 402 error.
Generate your API key
Keys are created in the app, with your session. A key cannot create, list or revoke another key.
- Sign in to the ControlResell web app.
- Open Settings, then Developers.
- Create a key: give it a name, tick at least one scope and, if you wish, an expiry date (5 years at most).
- Copy the secret right away: it is shown only once.
The secret starts with cr_live_. Treat it like a password: ControlResell only keeps a hash of it and cannot show it again. If in doubt, revoke the key and create a new one.
Send the key in the Authorization header of every call. Example to read your profile:
curl https://api.controlresell.com/api/public/v1/me \
-H "Authorization: Bearer cr_live_..."You can have at most 10 active keys, each revocable at any time.
Available scopes
accounts:read– Read marketplace accountsitems:read– Read items and their listingsitems:write– Write itemsorders:read– Read ordersconversations:read– Read conversationsconversations:write– Write conversationscustomers:read– Read customerswebhooks:read– Read webhookswebhooks:write– Write webhooks
API documentation
The interactive reference (Swagger) and the OpenAPI specification are public and generated from the production API.
The API is versioned (/api/public/v1). v1 only evolves by additions; on a breaking change a v2 is opened and v1 stays available for at least twelve months after the announcement.
Official SDKs and CLI
SDKs generated from the specification and a CLI, open source on GitHub.
- TypeScriptcontrolresell/typescript-sdkView the repository
npm
npm install controlresell-sdk - Pythoncontrolresell/python-sdkView the repository
PyPI (import controlresell)
pip install controlresell-sdk - Gocontrolresell/go-sdkView the repository
Go modules (Git tag v1.0.0)
go get github.com/controlresell/[email protected] - Javacontrolresell/java-sdkView the repository
Maven Central (pom.xml)
<dependency> <groupId>com.controlresell</groupId> <artifactId>java-sdk</artifactId> <version>1.0.0</version> </dependency> - Kotlincontrolresell/kotlin-sdkView the repository
Maven Central (Gradle)
implementation("com.controlresell:kotlin-sdk:1.0.0") - C#controlresell/csharp-sdkView the repository
NuGet (.NET)
dotnet add package ControlResell.Sdk - Swiftcontrolresell/swift-sdkView the repository
Swift Package Manager (Git tag 1.0.0)
.package(url: "https://github.com/controlresell/swift-sdk", from: "1.0.0") - PHPcontrolresell/php-sdkView the repository
Packagist (Composer)
composer require controlresell/sdk - Rustcontrolresell/rust-sdkView the repository
crates.io (Cargo)
cargo add controlresell-sdk - Command linecontrolresell/cliView the repository
macOS / Linux
curl -fsSL https://github.com/controlresell/cli/releases/latest/download/install.sh | shWindows (PowerShell)
& { $f = Join-Path $env:TEMP ([IO.Path]::GetRandomFileName() + '.ps1'); try { Invoke-WebRequest -UseBasicParsing 'https://github.com/controlresell/cli/releases/latest/download/install.ps1' -OutFile $f; & ([scriptblock]::Create([IO.File]::ReadAllText($f))) } finally { Remove-Item $f -ErrorAction SilentlyContinue } }
Install the SDK for your language from its registry, or the CLI with its install script. Version 1.0.0 matches API v1.