API Documentation for EchoMTG

Authenticate a user to receive an access token which allows you to make API calls on behalf of the user. You will want to store the token to your application's memory or database for further use. A new token is generated every time a user is auth'd from anywhere. Tokens expire after 24 hours.

Param	Required	Description
email	required	user email address
password	required	user password
type	optional	Send curl to received a plain text token (no json)

Access user information like name, email, about, and other meta data that can control the interface like currency code and default sort orders.

Checks if a name is available

type options: username, email, discord, twitter

Update user profile information and settings.

Default Sort Options

Date Entered = i.id 
Card Name = c.card_name 
Price = p.tcg_mid 
Personal Gain = personal_gain 
7-Day Movement = p.change 
Expansion = c.expansion

Register a new user into the system.

Param	Required	Description
email	required	user email address
password	required	user password, must contain a letter and number
username	required	public handle
referrer	optional	referring hash of the user who invite. This can be found in user/meta call.

Email of the user who forgot their password. Sends a hash link to the requesting email which kicks off a reset password flow for that user.

Authenticated way to change a user password.

Add a card to the user inventory.

Param	Required	Default	Description
emid	required		EchoID
quantity	optional	1	number to record
language	optional	EN	Card text language. See language options below
condition	optional	NM	Card condition, see options below
foil	optional	0	1=foiled, 0=regular
image	optional		A remote URL to an uploaded image. To add an image through Echo, see the Upload Image endpoint

Condition Options

NM = Near Mint  
LP = Lightly Played  
MP = Moderately Played  
HP = Heavily Played  
D = Damaged  
ALT = Altered  
ART = Artist Proof  
PRE = Pre-release  
TS = Timestamped  
SGN = Signed  
BGS = BGS  
B10 = BGS 10  
B95 = BGS 9.5  
B9 = BGS 9.0  
B85 = BGS 8.5  
B8 = BGS 8.0  
B75 = BGS 7.5  
B7 = BGS 7.0  
PSA = PSA  
P10 = PSA 10  
P95 = PSA 9.5  
P9 = PSA 9.0  
P85 = PSA 8.5  
P8 = PSA 8.0  
P75 = PSA 7.5  
P7 = PSA 7.0

Language Options

EN = english  
DE = german  
FR = french  
RU = russian  
IT = italian  
ES = spanish  
PT = portuguese  
CT = chinese traditional  
CS = chinese simplified  
JP = japanese  
KR = korean  

Update an inventory item.

Param	Required	Default	Description
id	required		Inventory ID
quantity	optional	1	number to record
language	optional	EN	Card text language. See language options below
condition	optional	NM	Card condition, see options below
foil	optional	0	1=foiled, 0=regular
image	optional		A remote URL to an uploaded image. To add an image through Echo, see the Upload Image endpoint

Condition Options

NM = Near Mint  
LP = Lightly Played  
MP = Moderately Played  
HP = Heavily Played  
D = Damaged  
ALT = Altered  
ART = Artist Proof  
PRE = Pre-release  
TS = Timestamped  
SGN = Signed  
BGS = BGS  
B10 = BGS 10  
B95 = BGS 9.5  
B9 = BGS 9.0  
B85 = BGS 8.5  
B8 = BGS 8.0  
B75 = BGS 7.5  
B7 = BGS 7.0  
PSA = PSA  
P10 = PSA 10  
P95 = PSA 9.5  
P9 = PSA 9.0  
P85 = PSA 8.5  
P8 = PSA 8.0  
P75 = PSA 7.5  
P7 = PSA 7.0

Language Options

EN = english  
DE = german  
FR = french  
RU = russian  
IT = italian  
ES = spanish  
PT = portuguese  
CT = chinese traditional  
CS = chinese simplified  
JP = japanese  
KR = korean  

The call will remove an inventory record from a user's inventory.

View user inventory. All options can be combined.

Maximum limit is 1000.

Searches automatically limit to 1000 returned.

Meta data in return contains information for pagination.

Param	Required	Default	Description
start	optional	0
limit	optional	100	Number to records to return. Maximum 250
sort	optional	date_acquired	price_acquired, date_acquired, name, set, price_change, tcg_market, tcg_mid, foil_price
direction	optional	ASC	Change sort direction
cmc	optional		A math equation like '<=1' or '=0' or '>=5'
color	optional		colorless, blue, white, red, multicolor, black, green
tradable	optional		true, false
reserve_list	optional		true, false
price_under	optional		float number, return any item worth less than number
price_over	optional		float number, return any item worth more than number

Quick response on user collection statistics, its faster then the normal /stats/ call, and is used to update the main nav bar and inventory app on update.

Create a note in the system.

field	required	default	description
target_app	optional	inventory	name of app to create note for
target_id	required		id of the resource the note is for, inventory id, earnings id, etc.
note	required		text string note

Get all the user lists

Add an item to a list. If a non-foil is added as foil, it will default to non-foil vice versa.

Param	Description
emid	(int) EchoID of card to add
list	(int) list id, see lists/all/
foil	(int) 0=false, 1=true
sb	(int) sideboard 0=false, 1=true

Delete a list.

Param	Description
list	(int) list id, see lists/all/
status	(int) 0=delete, 1=undelete

Read a deck, support formats are COD, DEC, Areana, Modo, DEK

'COD' => '/ '/ '/SB: \d\s(.*)\\n/', 'ARENA' => '/\d+\s+(.*)\s\([A-Za-z0-9]+\)\s\d+/', //1 Baird, Steward of Argive (DAR) 4 'MODO' => '/\d+\s+(.*)/'

Param	Description
text	deck text

Add an item to a list. If a non-foil is added as foil, it will default to non-foil vice versa.

Param	Description
emid	(int) EchoID of card to add
list	(int) list id, see lists/all/
foil	(int) 0=false, 1=true
sb	(int) sideboard 0=false, 1=true

Access the users earning data.

Add a card to the user inventory.

Param	Required	Default	Description
emid	required		EchoID
quantity	optional	1	number to record
language	optional	EN	Card text language. See language options below
condition	optional	NM	Card condition, see options below
foil	optional	0	1=foiled, 0=regular
image	optional		A remote URL to an uploaded image. To add an image through Echo, see the Upload Image endpoint

Condition Options

NM = Near Mint  
LP = Lightly Played  
MP = Moderately Played  
HP = Heavily Played  
D = Damaged  
ALT = Altered  
ART = Artist Proof  
PRE = Pre-release  
TS = Timestamped  
SGN = Signed  
BGS = BGS  
B10 = BGS 10  
B95 = BGS 9.5  
B9 = BGS 9.0  
B85 = BGS 8.5  
B8 = BGS 8.0  
B75 = BGS 7.5  
B7 = BGS 7.0  
PSA = PSA  
P10 = PSA 10  
P95 = PSA 9.5  
P9 = PSA 9.0  
P85 = PSA 8.5  
P8 = PSA 8.0  
P75 = PSA 7.5  
P7 = PSA 7.0

Language Options

EN = english  
DE = german  
FR = french  
RU = russian  
IT = italian  
ES = spanish  
PT = portuguese  
CT = chinese traditional  
CS = chinese simplified  
JP = japanese  
KR = korean  

View user inventory. All options can be combined.

Param	Required	Default	Description
user	required		The public user hash of the tradable user.
conversion	optional	1	NOT SUPPORTED, currency return related to user trade list. Will be used for currency conversion against USD, 1.5 would return all prices 1.5*USD
start	optional	0
limit	optional	100	Number to records to return, max is 250
sort	optional	date_acquired	price_acquired, date_acquired, name, set, price_change, tcg_market, tcg_mid, foil_price
direction	optional	ASC	Change sort direction
min_value	optional		float number, return any item worth more than number
max_value	optional		float number, return any item worth less than number

View user inventory. All options can be combined.

Param	Required	Default	Description
start	optional	0
limit	optional	100	Number to records to return, max is 250
search			user name search

Change the count wanted on a want entry.

Param	Required	Default	Description
emid	required		EchoID
quantity	required	1	number to change the count. negative numbers will subtract

Get watchlist items.

Param	default	Description
start	0	Item to start from, used for pagination
limit	100	total items to return, used for pagination

Create a comment on the platform.

field	required	description
resource_id	required	id of the target resource
resource	required	string of the resource type
comment	required	comment string, markdown accepted
url	required	full URL of where the coment was made
thread_parent_id	optional	ID of the comment being responded to

Create a note in the system.

field	required	default	description
target_app	optional	inventory	name of app to create note for
target_id	required		id of the resource the note is for, inventory id, earnings id, etc.
note	required		text string note

Fetched items dedicated in a group based on specific request parameters. Defaults to sorting by pricing high to low.

Unique Options

true or false, determins where to return unique cards with no variants or not. default: false

Name Options

• magic-reserved-list - magic reserve list

• commanders - magic legendary creatures

• lands - magic rare land cycles

• artifacts - top 150 magic artifacts

• tokens - top 150 magic tokens

• creatures - top 150 magic creatures

• power9 - magic power 9

• tiny - magic tiny leaders

• trendingup - magic items increasing in value

• trendingdown - magic item decreasing in value

• custom - look for a specific card type, see type options

Type Options

Type param only work with name=custom. Must be one part of a type like "merfolk" or "instant" or a fully qualified type like "Elf Druid". Examples:

• Merfolk

• Goblin

• Instant

• Elf Druid

• Tribal

• Enchantment

• World Enchantment

Limit Options

Default is 150, accepting an integer. Optional.

Upload a CSV of card and get back a mapping to EchoMTG ID's

Returns popular cards for a given game based on data in EchoMTG. This endpoint is restricted to login and EchoMTG websites.

	Required	Description
tcg_id	true	TCGplayer ID
set	optional	Set Code as stored in EchoMTG
card	optional	Card name as stored in EchoMTG

Returns popular cards for a given game based on data in EchoMTG. This endpoint is restricted to login and EchoMTG websites.

	Required	Description
tcg_id	true	TCGplayer ID
set	optional	Set Code as stored in EchoMTG
card	optional	Card name as stored in EchoMTG

Fetches a set. Larger sets struggle to load in SSR apps. ?minified=true option added to reduce return sizes in half.

Param	Required	Default	Description
set_code	true		3-5 letter set code
minified	false	true	Return results without card_text and purchase link
start	false	0	index to start at
limit	false	5000	total items to reutrn

Returns the games supported by EchoMTG