Api Documentation V1
Welcome to the ISX API documentation. This API (Application Programming Interface) will allow you to access the functionality of this exchange by means of HTTP requests, making integration with your own applications possible. In Public section you can find those endpoints which don't require authentication and is free for everyone. Instead you can find user related endpoints in Private section, which require the access token. The access token can be generated in Setting page after you log in. The access token can be generated with permission. To get more info please visit the Settings page. Another point we would like to state, is that if you use max_ or min_ at the beginning of a column which is set for filtering data, will be consider as you want to retrieve all data which is greater or less the given value. (exmaple: {url}?max_amount=30)
Language
currencies
GET
Select Currencies
http://api.go.is/v1/currencies
Lists available currencies
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: is_crypto
Required: false
Type: integer
Description: Set to true (or 1) to only retrieve the list of cryptocurrencies
Values: 0, 1
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: is_crypto, code
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/currencies' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
},
{
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
]
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
GET
Select Currency
http://api.go.is/v1/currencies/{code}
Get information on a specific currency
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {code}
Required: true
Type: string
Description: Specify the currency (code) you want to retrieve information about
Values: BTC, ISK, ...
Validation: max: 3 characters
Example Request
curl --location --request GET 'http://api.go.is/v1/currencies/{code}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
},
]
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
pairs
GET
Select Pairs
http://api.go.is/v1/pairs
Get a list of the available trading pairs
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Example Request
curl --location --request GET 'http://api.go.is/v1/pairs' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"name": "AUR/ISK",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
{
"name": "BTC/ISK",
"currency1": {
"code": "BTC",
"name": "Bitcoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
]
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
transactions
GET
Select Transactions
http://api.go.is/v1/transactions-public
Get the latest transactions from the exchange, ordered by date in descending order
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: pair
Required: false
Type: string
Description: The trading pair you want to retrieve information for
Values: BTC/ISK, AUR/ISK
Parameter: amount
Required: false
Type: number
Description: The amount for the transaction
Parameter: price
Required: false
Type: number
Description: The price for the transaction
Parameter: total
Required: false
Type: number
Description: The total sum for the transaction
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: amount, price, total, created_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/transactions-public' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 100,
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
{
"id": 101,
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
]
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
GET
Select Transaction
http://api.go.is/v1/transactions-public/{id}
List your account’s transactions, ordered by date in descending order
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID for the transaction
Example Request
curl --location --request GET 'http://api.go.is/v1/transactions-public/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 100,
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
]
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
orders
GET
Select Orders Books
http://api.go.is/v1/orders-book/{pair}
Returns the open orders currently in the order book. The results will be grouped into two different arrays for bid and ask respectively.
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: pair
Required: true
Type: string
Description: The trading pair you want to retrieve orders for
Values: BTC/ISK, AUR/ISK, ...
Example Request
curl --location --request GET 'http://api.go.is/v1/orders-book/{pair}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
"BIDs": {
{
"amount": "1.00000000",
"total": "5.00",
"price": "5.00",
},
{
"amount": "2.00000000",
"total": "8.00",
"price": "4.00",
}
},
"ASKs": {
{
"amount": "1.00000000",
"total": "9.00",
"price": "9.00",
},
{
"amount": "2.00000000",
"total": "16.00",
"price": "8.00",
}
},
]
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
bank accounts
GET
Select Bank Accounts
http://api.go.is/v1/bank-accounts
Get information about your bank accounts
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: code
Required: false
Type: string
Description: The unique short code for the particular currency you want to get address info for
Parameter: account
Required: false
Type: integer
Description: Get information about the specified account
Parameter: utibu
Required: false
Type: integer
Description: Get information about accounts from a particular branch (útibú)
Parameter: hb
Required: false
Type: integer
Description: Get information about accounts of a certain type (Höfuðbók)
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: updated_at
Required: false
Type: string
Description: Specify an update date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: name, account, utibu, hb, created_at, updated_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/bank-accounts' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
{
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
GET
Select Bank Account
http://api.go.is/v1/bank-accounts/{id}
Get information about a specific bank account
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID for the bank account
Example Request
curl --location --request GET 'http://api.go.is/v1/bank-accounts/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
POST
Create Bank Account
http://api.go.is/v1/bank-accounts
Create a new bank account
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: name
Required: true
Type: string
Description: The name you want to give the account
Validation: max: 255 characters
Parameter: utibu
Required: true
Type: integer
Description: The bank accounts branch
Validation: maximum 4 digits
Parameter: hb
Required: true
Type: integer
Description: The bank account type
Validation: maximum 2 digits
Parameter: account
Required: true
Type: integer
Description: The account number
Validation: maximum 6 digits
Example Request
curl --location --request POST 'http://api.go.is/v1/bank-accounts' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--form 'name=Landsbankinn' \
--form 'utibu=0301' \
--form 'hb=26' \
--form 'account=111000'
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency":{
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 422,
"duration": 0.54,
"errors": {
"utibu": [
"The Utibu field is required.",
],
"account": [
"The Account must be between 1 and 6 digits.",
]
}
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
PUT
Update Bank Account
http://api.go.is/v1/bank-accounts/{id}
Update an existing bank account
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of the bank account to update
Parameter: name
Required: true
Type: string
Description: The name of the bank account
Validation: max: 255 characters
Parameter: utibu
Required: true
Type: integer
Description: The bank accounts branch
Validation: maximum 4 digits
Parameter: hb
Required: true
Type: integer
Description: The bank account type
Validation: maximum 2 digits
Parameter: account
Required: true
Type: integer
Description: The account number
Validation: maximum 6 digits
Example Request
curl --location --request PUT 'http://api.go.is/v1/bank-accounts/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--data-raw '{
"name":"Landsbankinn",
"utibu":"0301",
"hb":"26",
"account":"111000"
}'
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency":{
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 422,
"duration": 0.54,
"errors": {
"utibu": [
"The Utibu field is required.",
],
"account": [
"The Account must be between 1 and 6 digits.",
]
}
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
DELETE
Delete Bank Account
http://api.go.is/v1/bank-accounts/{id}
Delete an existing bank account
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of the bank account to delete
Example Request
curl --location --request DELETE 'http://api.go.is/v1/bank-accounts/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency":{
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
crypto deposit addresses
GET
Select Crypto Deposit Addresses
http://api.go.is/v1/crypto-addresses
Get a list of the account’s existing cryptocurrency addresses
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: code
Required: false
Type: string
Description: The unique short code for the particular currency you want to get address info for
Parameter: address
Required: false
Type: string
Description: Specify a particular address you want to get information on
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: updated_at
Required: false
Type: string
Description: Specify an update date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: id, address, created_at, updated_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/crypto-addresses' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 100,
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
},
{
"id": 101,
"address": "ds5hAfAn6vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-27 07:05:14",
"currency": {
"code": "BTC",
"name": "Bitcoin",
"is_crypto": true,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
GET
Select Crypto Deposit Address
http://api.go.is/v1/crypto-addresses/{id}
Get information on a specific cryptocurrency address
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of the address you want to get information on
Example Request
curl --location --request GET 'http://api.go.is/v1/crypto-addresses/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 100,
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
POST
Create Crypto Deposit Address
http://api.go.is/v1/crypto-addresses
Create a cryptocurrency address for deposits
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: code
Required: true
Type: string
Description: The unique code for the particular cryptocurrency you want to create an address for
Validation: max: 3 characters
Example Request
curl --location --request POST 'http://api.go.is/v1/crypto-addresses' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--form 'code=AUR'
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 100,
"address": "dg64nARht56vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency":{
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 422,
"duration": 0.54,
"errors": {
"code": [
"The Code field is required.",
]
}
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
DELETE
Delete Crypto Deposit Address
http://api.go.is/v1/crypto-addresses/{id}
Delete an existing deposit cryptocurrency address
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: The ID of the particular cryptocurrency address you want to delete
Example Request
curl --location --request DELETE 'http://api.go.is/v1/crypto-addresses/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 1607,
"address": "d2dsa2s3n6vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency":{
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
withdrawals
GET
Select Withdrawals
http://api.go.is/v1/withdrawals
Get a list of withdrawals (cryptocurrency or fiat) from the account, ordered by date, in descending order.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: status
Required: false
Type: string
Description: Specify a particular status that you want to restrict the results to
Values: PENDING, COMPLETED, CANCELED, AUTH
Parameter: amount
Required: false
Type: number
Description: Specify an amount that you want to restrict the results to
Parameter: tx
Required: false
Type: number
Description: Specify a particular transaction ID
Parameter: fee
Required: false
Type: number
Description: Specify the fee amount that you want to restrict your results to
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: updated_at
Required: false
Type: string
Description: Specify an update date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: id, amount, fee, created_at, updated_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/withdrawals' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 100,
"tx": null,
"amount": "10.00000000",
"fee": "0.00100000",
"status": "AUTH",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"bank_account": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
"crypto_address": {
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
{
"id": 101,
"tx": null,
"amount": "10.00000000",
"fee": "0.00100000",
"status": "COMPLETED",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "BTC",
"name": "Bitcoin",
"is_crypto": true,
},
"bank_account": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
"crypto_address": {
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
GET
Select Withdrawal
http://api.go.is/v1/withdrawals/{id}
Get information on a specific cryptocurrency or fiat withdrawal
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of the specific withdrawal
Example Request
curl --location --request GET 'http://api.go.is/v1/withdrawals/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 100,
"tx": null,
"amount": "10.00000000",
"fee": "0.00100000",
"status": "AUTH",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"bank_account": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
"crypto_address": {
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
POST
Create Withdrawal
http://api.go.is/v1/withdrawals
Make a withdrawal from your account to an existing cryptocurrency address or fiat bank account.
Please note that you must link the desired bank account number to your account in the bank accounts page in order for this feature to work. Otherwise, your withdrawals will fail. If the response returns: { status = "AUTH" } you must confirm the withdrawal via email.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: code
Required: true
Type: string
Description: The unique short code for the particular currency you want to create a withdrawal for
Validation: max: 3 characters
Parameter: to
Required: true
Type: string
Description: The respective bank account or cryptocurrency address which you want to withdraw funds to
Validation: max: 255 characters
Format: XXXX-XX-XXXXXX even without 0s
Parameter: amount
Required: true
Type: integer
Description: fill no higher than your balance
Validation: max: 255 characters,
Example Request
curl --location --request POST 'http://api.go.is/v1/withdrawals' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--form 'code=AUR' \
--form 'to=address name' \
--form 'amount=10'
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 9366,
"type": "WITHDRAW",
"tx": null,
"amount": "10.00000000",
"fee": "0.00100000",
"status": "AUTH",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency":{
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
"crypto_address":{
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 422,
"duration": 0.54,
"errors": {
"code": [
"The selected Code is invalid.",
],
"account": [
"The Amount may not be greater than 10000000.",
],
"to": [
"The To field is required.",
]
}
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 422,
"duration": 0.54,
"message": "Please, submit the AML form to be able to withdraw funds. - http://go.is/aml-submit",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
DELETE
Delete Withdrawal
http://api.go.is/v1/withdrawals/{id}
Delete an existing cryptocurrency or bank withdrawal request
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of the specific withdrawal request you want to delete
Example Request
curl --location --request DELETE 'http://api.go.is/v1/withdrawals/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 9366,
"type": "WITHDRAW",
"tx": null,
"amount": "10.00000000",
"fee": "0.00100000",
"status": "AUTH",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency":{
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
"bank_account":{
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
}
"crypto_address":{
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 208,
"duration": 0.432,
"message": "The withdrawal request is already canceled",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 208,
"duration": 0.432,
"message": "The withdrawal request is already completed",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
deposits
GET
Select Deposits
http://api.go.is/v1/deposits
Get a list of deposits (cryptocurrency or fiat) made to the account, ordered by date, in descending order.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: amount
Required: false
Type: number
Description: Specify an amount that you want to restrict the results to
Parameter: tx
Required: false
Type: number
Description: Specify a particular transaction ID
Parameter: fee
Required: false
Type: number
Description: Specify the fee amount that you want to restrict your results to
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: updated_at
Required: false
Type: string
Description: Specify an update date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: id, tx, amount, fee, created_at, updated_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/deposits' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 100,
"tx": "1a5bb81f86478a43004088563b21660577e513a978f5c42475bc7a21f14339f",
"amount": "1000.00000000",
"fee": "0.00000000",
"status": "COMPLETED",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"bank_account": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
"crypto_address": {
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
{
"id": 101,
"tx": null,
"amount": "99.00",
"fee": "0.00",
"status": "PENDING",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"bank_account": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
"crypto_address": {
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
GET
Select Deposit
http://api.go.is/v1/deposits/{id}
Get information on a particular deposit
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of a specific deposit
Example Request
curl --location --request GET 'http://api.go.is/v1/deposits/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 100,
"tx": "1a5bb81f86478a43004088563b21660577e513a978f5c42475bc7a21f14339f",
"amount": "1000.00000000",
"fee": "0.00000000",
"status": "COMPLETED",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"bank_account": {
"id": 80,
"name": "Landsbankinn",
"utibu": "0301",
"hb": "26",
"account": "111000",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
},
"crypto_address": {
"address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
history logs
GET
Select History Logs
http://api.go.is/v1/histories
Get the history of actions performed on your account
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {type}
Required: false
Type: string
Description: Specify the type of action you want to restrict the results to
Values: order-buy, order-sell, withdraw, deposit
Parameter: id
Required: false
Type: integer
Description: Unique ID of a specific log item to fetch
Parameter: ip
Required: false
Type: string
Description: Specify an IP address which you like to restrict the results to
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: updated_at
Required: false
Type: string
Description: Specify an update date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: id, ip, created_at, updated_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/histories' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 1.823,
"msg": "Success",
"data": [
{
"id": 100,
"ip": "127.0.0.1",
"created_at": "2016-02-05 22:47:23",
"updated_at": "2019-09-04 12:24:49",
"history_type": {
"slug": "deposit",
}
},
{
"id": 101,
"ip": "127.0.0.1",
"created_at": "2015-12-14 13:55:31",
"updated_at": "2019-09-04 12:27:06",
"history_type": {
"slug": "order-buy",
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
user balances
GET
Select User Balances
http://api.go.is/v1/user-balances
List account balances across available currencies. Returns a Balance entry for each currency for which there is either a balance or an address.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: balance
Required: false
Type: number
Description: Specify a balance amount that you want to restrict your results to
Parameter: hold_order
Required: false
Type: number
Description: Specify an amount for the total sum of orders that are on hold
Parameter: hold_withdraw
Required: false
Type: number
Description: Specify an amount for the total sum of withdrawal requests
Parameter: available
Required: false
Type: number
Description: Specify the available balance after subtracting the amounts on hold in orders and withdrawals
Parameter: created_at
Required: false
Type: date
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: updated_at
Required: false
Type: date
Description: Specify an update date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: id, balance, hold_order, hold_withdraw, created_at, updated_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/user-balances' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 100,
"balance": "2211544.9",
"hold_order": "88998.33",
"hold_withdraw": "48.00",
"available": "2122498.57",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
},
{
"id": 101,
"balance": "2211544.9",
"hold_order": "88998.33",
"hold_withdraw": "48.00",
"available": "2122498.57",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
GET
Select User Balance
http://api.go.is/v1/user-balances/{code}
Returns the balance for a specific balance ID
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: code
Required: true
Type: string
Description: api.user_balances_api.params.post.code
Validation: max: 3 characters
Example Request
curl --location --request GET 'http://api.go.is/v1/user-balances/{code}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 101,
"balance": "2211544.9",
"hold_order": "88998.33",
"hold_withdraw": "48.00",
"available": "2122498.57",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
transactions
GET
Select Transactions
http://api.go.is/v1/transactions
List your account’s transactions, ordered by date in descending order
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: pair
Required: false
Type: string
Description: The trading pair you want to retrieve information for
Values: BTC/ISK, AUR/ISK
Parameter: amount
Required: false
Type: number
Description: The amount for the transaction
Parameter: price
Required: false
Type: number
Description: The price for the transaction
Parameter: total
Required: false
Type: number
Description: The total sum for the transaction
Parameter: fee
Required: false
Type: number
Description: Specify the total fee for the transaction
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: amount, price, total, created_at
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/transactions' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 100,
"type": "BUY",
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"fee": "1.79",
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
{
"id": 101,
"type": "SELL",
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"fee": "18.27",
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "BTC",
"name": "Bitcoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
GET
Select Transaction
http://api.go.is/v1/transactions/{id}
List your account’s transactions, ordered by date in descending order
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID for the transaction
Example Request
curl --location --request GET 'http://api.go.is/v1/transactions/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 100,
"type": "BUY",
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"fee": "1.79",
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
orders
GET
Select Orders
http://api.go.is/v1/orders
Returns information on your currently active orders. Results will be grouped into two different arrays for bid and ask respectively.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: pair
Required: false
Type: string
Description: The trading pair you want to retrieve information for
Values: BTC/ISK, AUR/ISK
Parameter: type
Required: false
Type: string
Description: Specify if you want to retrieve BID or ASK orders
Values: BID, ASK
Parameter: amount
Required: false
Type: number
Description: Specify an amount that you want to restrict the results to
Parameter: price
Required: false
Type: number
Description: Specify a price that you want to restrict the results to
Parameter: total
Required: false
Type: number
Description: Specify a total order sum that you want to restrict the results to
Parameter: is_market_price
Required: false
Type: integer
Description: Specify if you want to restrict the results to market price orders
Values: 0, 1
Parameter: created_at
Required: false
Type: string
Description: Specify a creation date or a date range that you want to restrict the results to
Parameter: page
Required: false
Type: integer
Description: You can use the {page} parameter for pagination
Parameter: per_page
Required: false
Type: integer
Description: You can use the {per_page} parameter to show the number of items in each page
Parameter: sort
Required: false
Type: string
Description: You can use the {sort} parameter for order
Values: amount, price, total
For order type DESC: add dash (-) in the beginning of the parameter
For order type ASC: nothing to add
Example Request
curl --location --request GET 'http://api.go.is/v1/orders' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"per_page": 10,
"page": 1,
"total": 2,
"current_page": 1,
"last_page": 1,
"status": true,
"code": 200,
"duration": 0.823,
"msg": "Success",
"data": [
{
"id": 100,
"type": "BID",
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"is_market_price": false,
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
{
"id": 101,
"type": "BID",
"pair": "BTC/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"is_market_price": false,
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "BTC",
"name": "Bitcoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
GET
Select Order
http://api.go.is/v1/orders/{id}
Returns information on your currently active orders. Results will be grouped into two different arrays for bid and ask respectively.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of the specific order
Example Request
curl --location --request GET 'http://api.go.is/v1/orders/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": [
{
"id": 100,
"type": "BID",
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"is_market_price": false,
"created_at": "2015-12-14 12:01:06",
"currency1": {
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
],
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
orders
POST
Create Order
http://api.go.is/v1/orders/{pair}
Create a new market order
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {pair}
Required: true
Type: string
Description: The trading pair you want to retrieve information for
Values: BTC/ISK, AUR/ISK, ...
Parameter: amount
Required: true
Type: numeric
Description: Specify the amount for the order
Validation: min: 0.00000001 characters
Parameter: price
Required: true if is_market=0
Type: numeric
Description: Specify the price for the order
Validation: numeric, min: 0.01 characters
Parameter: type
Required: true
Type: string
Description: Specify the order type
Values: BID, ASK
Parameter: is_market
Required: true
Type: boolean
Description: Specify if the order is a market order
Values: 0, 1
Example Request
curl --location --request POST 'http://api.go.is/v1/orders/{pair}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--form 'amount=10' \
--form 'price=0.9' \
--form 'type=BID' \
--form 'is_market=0'
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"user_id": 100,
"currency1_id": 28,
"currency2_id": 43,
"amount": "100.00000000",
"price": "10.00",
"total": "1000.00",
"fee": "10.00",
"type": "BID",
"is_market": 0,
"order_log_id": 15553,
"pair": "AUR/ISK",
"is_market_price": false,
"currency1":{
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
"currency2":{
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": ,
"code": 422,
"duration": 0.54,
"errors": {
"type": [
"The selected Type is invalid.",
]
}
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
DELETE
Delete Order
http://api.go.is/v1/orders/{id}
Delete a specific order
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
is, en (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: Unique ID of the order you want to delete
Example Request
curl --location --request DELETE 'http://api.go.is/v1/orders/{id}' \
--header 'Authorization: Bearer {access_token}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
Example Response
200 － OK
208 － The withdrawal request is already canceled
208 － The withdrawal request is already completed
404 － Not Found
404 － Invalid URL
405 － Invalid URL
422 － Unprocessable Entity
406 － Not Acceptable
401 － Forbidden
403 － Forbidden
423 － Unauthorized
{
"status": true,
"code": 200,
"duration": 0.54,
"msg": "Success",
"data": {
"id": 100,
"type": "BID",
"pair": "AUR/ISK",
"amount": "2.00000000",
"price": "7.05",
"total": "14.10",
"is_market_price": false,
"created_at": "2015-12-14 12:01:06",
"currency1":{
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
}
"currency2":{
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
}
},
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
} {
"status": ,
"code": 404,
"duration": 0.54,
"message": "Invalid URL",
}
{
"status": ,
"code": 404,
"duration": 0.54,
"message": "Record not found",
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": ,
"code": 405,
"duration": 0.54,
"message": "Method Not Allowed",
}
{
"status": false
"message": "locked"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}
{
"status": false
"code": 401
"duration": 1.105,
"message": "Unauthenticated"
}
{
"status": false
"message": "no permission"
"user": {
"id": 100,
"name": "John Doe",
"email": "john.doe@gmail.com",
"ssn": "1209783309"
}
}