API

Basic information

API requests are made at the following address:
https://quix.email/api/v1/<API_KEY>/<METHOD>

Where:
API_KEY - API access key, which you can get on the Profile page.
METHOD - API method name. The list of available methods is presented below.

The response content will be in JSON format with the following fields:

Name	Type	Description
success	bool	Whether the request was successful. If false, the error field will be present, but the result will be absent, and vice versa.
error	string	Error text.
result	mixed	Response Contents (response fields).

You can restrict access to the API with your key by IP. To do this, go to Profile, specify from which IP addresses access will be allowed, enter the password for the account and click the "Change allowed IP addresses" button.

Get account balance

GET

http://quix.email/api/v1/<API_KEY>/accountBalance

Response fields

Name	Type	Description
balance	float	Your account balance in USD.

Get domains list. Returns an array

GET

http://quix.email/api/v1/<API_KEY>/emailDomains

Request parameters

Name	Type	Required	Description
info	bool	false	Whether to also return information about the number and cost of mail. If true, each element of the returned array will contain the response fields described below. Otherwise (false) - each element of the returned array will contain only a string with the domain. Default - true.
site	string	false	Show available quantity for this site only. Also need to pass info=true.

Response fields

Name	Type	Description
domain	string	Email domain.
quantity	int	Available quantity.
price	float	Cost of one mail.
customUsername	bool	Whether custom usernames available for this email domain.

Activation. Order

GET

http://quix.email/api/v1/<API_KEY>/emailGet

Request parameters

Name	Type	Required	Description
site	string	true	The domain of the site from which the email will be sent.
domain	string	true	Email domain. Can be: any domain from the emailDomains request; all - all available domains; quixemail - ouw domains (customUsername=true); own - domains added by you. You can specify multiple values by separating them with a comma, for example: gmx.com,gmail.com,own
username	string	false	Customize username. Available only for our email domains (see emailDomains request). Ignored if own is passed in domain.

Response fields

Name	Type	Description
id	string	Activation ID.
email	string	Email you can use.
site	string	The domain from which the email will be expected.

Activation. Get status and email content (if any)

GET

http://quix.email/api/v1/<API_KEY>/emailStatus

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID.
html	bool	false	This parameter is not used.

Response fields

Name	Type	Description
id	string	Activation ID.
email	string	Email you can use.
status	string	Activation status, one of: - completed - cancelled - no_email.
data	string	Contents of the email. Available with completed status.
parsed	string	Parsed activation code or link.

Activation. Code

GET

http://quix.email/api/v1/<API_KEY>/emailCode

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID.

Response fields

Name	Type	Description
code	string	Activation code or link that was parsed from the letter.

Activation. Complete

GET

http://quix.email/api/v1/<API_KEY>/emailComplete

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID.

Response fields

Name	Type	Description
completed	bool	Whether the activation successfully completed.

Activation. Cancel

GET

http://quix.email/api/v1/<API_KEY>/emailCancel

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID.

Response fields

Name	Type	Description
cancelled	bool	Whether the cancellation performed.

Activation. Repeat

GET

http://quix.email/api/v1/<API_KEY>/emailRepeat

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID, email and domain which must be reused.

Response fields

Name	Type	Description
id	string	New activation ID.
email	string	Email you can use.
site	string	The domain from which the email will be expected.

Rent. Order

GET

http://quix.email/api/v1/<API_KEY>/rentOrder

Request parameters

Name	Type	Required	Description
domain	string	true	Email domain.
username	string	false	Email username. Available only for email domains with customUsername=true.

Response fields

Name	Type	Description
id	string	Rent ID.
email	string	Email for use.
expire	int	Number of seconds before rent expires.

Rent. Get information

GET

http://quix.email/api/v1/<API_KEY>/rentInfo

Request parameters

Name	Type	Required	Description
id	string	true	Rent ID.

Response fields

Name	Type	Description
id	string	Rent ID.
email	string	Email for use.
expire	int	Number of seconds before rent expires. It may be negative.
expired	bool	Whether the rental period ended.

Rent. Receive letters. Returns array

GET

http://quix.email/api/v1/<API_KEY>/rentLetters

Request parameters

Name	Type	Required	Description
id	string	true	Rent ID.
html	bool	false	This parameter is not used.

Response fields

Name	Type	Description
from	string	Sender's email.
subject	string	Subject of the letter.
data	string	Contents of the letter.

Rent. Repeat

GET

http://quix.email/api/v1/<API_KEY>/rentReorder

Request parameters

Name	Type	Required	Description
id	string	true	Rent ID.

Response fields

Name	Type	Description
id	string	new rent ID.
email	string	Email for use.
expire	int	Number of seconds before rent expires.

Rent. Extend

GET

http://quix.email/api/v1/<API_KEY>/rentExtend

Request parameters

Name	Type	Required	Description
id	string	true	Rent ID.
days	int	true	Number of days. From 1 to 7.

Response fields

Name	Type	Description
	bool	Whether the rent extended.