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
test description
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: is_crypto
Required: false
Type: integer
Description: test
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",
"icon": "Ƶ",
"is_crypto": false,
},
{
"code": "AUR",
"name": "Auroracoin",
"icon": "ᚠ",
"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/{currency}
test description
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: currency
Required: true
Type: string
Description: test
Example Request
curl --location --request GET 'http://api.go.is/v1/currencies/{currency}' \
--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",
"icon": "Ƶ",
"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
test description
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (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",
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
}
},
{
"name": "BTC/ISK",
"currency1": {
"code": "BTC",
"name": "Bitcoin",
},
"currency2": {
"code": "ISK",
"name": "Icelandic króna",
}
},
]
}
{
"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 that occurred in the exchange, ordered by date in descending order.
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: pair
Required: false
Type: string
Description: test
Values: BTC/ISK, AUR/ISK
Parameter: amount
Required: false
Type: number
Description: test
Parameter: price
Required: false
Type: number
Description: test
Parameter: total
Required: false
Type: number
Description: test
Parameter: created_at
Required: false
Type: string
Description: test
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}
Get the latest transactions that occurred in the exchange, ordered by date in descending order.
HEADERS
Authorization (optional):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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 information on the orders currently in the order book. Return 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):
en, is (default)
Parameters:
Parameter: pair
Required: true
Type: string
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
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: account
Required: false
Type: integer
Description: test
Parameter: utibu
Required: false
Type: integer
Description: test
Parameter: hb
Required: false
Type: integer
Description: test
Parameter: created_at
Required: false
Type: string
Description: test
Parameter: updated_at
Required: false
Type: string
Description: test
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": 81,
"name": "address Name",
"account": "700001",
"utibu": "0001",
"hb": "01",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency": {
"code": "ISK",
"name": "Icelandic króna",
}
},
{
"id": 80,
"name": "address Name",
"account": "700001",
"utibu": "0001",
"hb": "01",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency": {
"code": "ISK",
"name": "Icelandic króna",
}
},
],
"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}
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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": "address Name",
"account": "700001",
"utibu": "0001",
"hb": "01",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency": {
"code": "ISK",
"name": "Icelandic króna",
}
},
],
"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
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: name
Required: true
Type: string
Description: test
Validation: max: 255 characters
Parameter: utibu
Required: true
Type: integer
Description: test
Validation: maximum 4 digits
Parameter: hb
Required: true
Type: integer
Description: test
Validation: maximum 2 digits
Parameter: account
Required: true
Type: integer
Description: test
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=Address Name' \
--form 'utibu=0001' \
--form 'hb=01' \
--form 'account=000101'
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": "address Name",
"account": "700001",
"utibu": "0001",
"hb": "01",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency":{
"code": "ISK",
"name": "Icelandic króna",
}
},
"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}
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
Parameter: name
Required: true
Type: string
Description: test
Validation: max: 255 characters
Parameter: utibu
Required: true
Type: integer
Description: test
Validation: maximum 4 digits
Parameter: hb
Required: true
Type: integer
Description: test
Validation: maximum 2 digits
Parameter: account
Required: true
Type: integer
Description: test
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":"Address name",
"utibu":"0001",
"hb":"01",
"account":"010121"
}'
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": "address Name",
"account": "700001",
"utibu": "0001",
"hb": "01",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency":{
"code": "ISK",
"name": "Icelandic króna",
}
},
"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}
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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": "address Name",
"account": "700001",
"utibu": "0001",
"hb": "01",
"created_at": "2020-02-03 14:08:47",
"updated_at": "2020-02-04 12:21:30",
"currency":{
"code": "ISK",
"name": "Icelandic króna",
}
},
"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 addresses for receiving Bitcoin.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: address
Required: false
Type: string
Description: test
Parameter: created_at
Required: false
Type: string
Description: test
Parameter: updated_at
Required: false
Type: string
Description: test
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": "d234gAf68fn6vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
}
},
{
"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",
}
},
],
"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 a list of the account's existing addresses for receiving Bitcoin.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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": "d234gAf68fn6vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
}
},
],
"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
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: code
Required: true
Type: string
Description: test
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",
}
},
"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}
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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",
}
},
"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 (crypto or fiat) from the account, ordered by date, in descending order.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: status
Required: false
Type: string
Description: test
Values: PENDING, COMPLETED, CANCELED, AUTH
Parameter: amount
Required: false
Type: number
Description: test
Parameter: tx
Required: false
Type: number
Description: test
Parameter: fee
Required: false
Type: number
Description: test
Parameter: created_at
Required: false
Type: string
Description: test
Parameter: updated_at
Required: false
Type: string
Description: test
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": {
"name": "Test Address",
"utibu": "0301",
"hb": "13",
"account": "111559",
},
"crypto_address": {
"address": "addressName",
}
},
{
"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": {
"name": "Test Address2",
"utibu": "0302",
"hb": "13",
"account": "111552",
},
"crypto_address": {
"address": "Test Address2",
}
},
],
"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 a list of withdrawals (crypto or fiat) from the account, ordered by date, in descending order.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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": {
"name": "Test Address",
"utibu": "0301",
"hb": "13",
"account": "111559",
},
"crypto_address": {
"address": "addressName",
}
},
],
"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
To make a withdrawal from your account to an existing crypto address or fiat bank account. Please note, 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 in response returns data: { status = "AUTH" } you must confirm the transfer via email
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: code
Required: true
Type: string
Description: test
Validation: max: 3 characters
Parameter: to
Required: true
Type: string
Description: test
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": "addressName",
}
},
"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}
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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":{
"name": "Test Address",
"utibu": "0301",
"hb": "13",
"account": "111559",
}
"crypto_address":{
"address": "addressName",
}
},
"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 (crypto 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):
en, is (default)
Parameters:
Parameter: amount
Required: false
Type: number
Description: test
Parameter: tx
Required: false
Type: number
Description: test
Parameter: fee
Required: false
Type: number
Description: test
Parameter: created_at
Required: false
Type: string
Description: test
Parameter: updated_at
Required: false
Type: string
Description: test
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": {
"name": "Landsbankinn",
"utibu": 65,
"hb": 10,
"account": 65,
},
"crypto_address": {
"address": "AKp7RiqkEzdLhgnP6mhsnXdNgd2H283YTueAC",
}
},
{
"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": false,
},
"bank_account": {
"name": "Arion",
"utibu": "0125",
"hb": "26",
"account": "008523",
},
"crypto_address": {
"address": "AKp7RiqkEzdLhgnP6mhsnXdNgd2H283YTusdeAC",
}
},
],
"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 a list of deposits (crypto 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):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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": {
"name": "Landsbankinn",
"utibu": 65,
"hb": 10,
"account": 65,
},
"crypto_address": {
"address": "AKp7RiqkEzdLhgnP6mhsnXdNgd2H283YTueAC",
}
},
],
"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
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {type}
Required: false
Type: string
Description: test
Values: order-buy, order-sell, withdraw, deposit
Parameter: id
Required: false
Type: integer
Description: test
Parameter: ip
Required: false
Type: string
Description: test
Parameter: created_at
Required: false
Type: string
Description: test
Parameter: updated_at
Required: false
Type: string
Description: test
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
Obtain the account's balances and fee levels.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: balance
Required: false
Type: number
Description: test
Parameter: hold_order
Required: false
Type: number
Description: test
Parameter: hold_withdraw
Required: false
Type: number
Description: test
Parameter: available
Required: false
Type: number
Description: test
Parameter: created_at
Required: false
Type: date
Description: test
Parameter: updated_at
Required: false
Type: date
Description: test
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": "hyg7sa5678n6vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "AUR",
"name": "Auroracoin",
}
},
{
"id": 101,
"balance": "2211544.9",
"hold_order": "88998.33",
"hold_withdraw": "48.00",
"available": "28h6uk8gun6vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "ISK",
"name": "Icelandic króna",
}
},
],
"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/{id}
Obtain the account's balances and fee levels.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
Example Request
curl --location --request GET 'http://api.go.is/v1/user-balances/{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": 101,
"balance": "2211544.9",
"hold_order": "88998.33",
"hold_withdraw": "48.00",
"available": "28h6uk8gun6vww5CqYKAbHLeQ372922365",
"created_at": "2020-02-26 07:05:14",
"updated_at": "2020-02-26 07:05:14",
"currency": {
"code": "ISK",
"name": "Icelandic króna",
}
},
],
"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
Get the latest transactions that occurred in the exchange, ordered by date in descending order.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: pair
Required: false
Type: string
Description: test
Values: BTC/ISK, AUR/ISK
Parameter: amount
Required: false
Type: number
Description: test
Parameter: price
Required: false
Type: number
Description: test
Parameter: total
Required: false
Type: number
Description: test
Parameter: fee
Required: false
Type: number
Description: test
Parameter: created_at
Required: false
Type: string
Description: test
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": "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"
}
}
GET
Select Transaction
http://api.go.is/v1/transactions/{id}
Get the latest transactions that occurred in the exchange, ordered by date in descending order.
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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 the orders currently in the order book. Return 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):
en, is (default)
Parameters:
Parameter: pair
Required: false
Type: string
Description: test
Values: BTC/ISK, AUR/ISK
Parameter: type
Required: false
Type: string
Description: test
Values: BID, ASK
Parameter: amount
Required: false
Type: number
Description: test
Parameter: price
Required: false
Type: number
Description: test
Parameter: total
Required: false
Type: number
Description: test
Parameter: is_market_price
Required: false
Type: integer
Description: test
Values: 0, 1
Parameter: created_at
Required: false
Type: string
Description: test
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 the orders currently in the order book. Return 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):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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/{currency}/{currency}
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: amount
Required: true
Type: numeric
Description: test
Validation: min: 0.00000001 characters
Parameter: price
Required: true if is_market=0
Type: numeric
Description: test
Validation: numeric, min: 0.01 characters
Parameter: type
Required: true
Type: string
Description: test
Values: BID, ASK
Parameter: is_market
Required: true
Type: boolean
Description: test
Values: 0, 1
Example Request
curl --location --request POST 'http://api.go.is/v1/orders/{currency}/{currency}' \
--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":{
"id": 28,
"code": "AUR",
"name": "Auroracoin",
"is_crypto": true,
"is_active": 1,
}
"currency2":{
"id": 43,
"code": "ISK",
"name": "Icelandic króna",
"is_crypto": false,
"is_active": 1,
}
},
"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}
test description
HEADERS
Authorization (required):
Bearer {access_token}
Accept (required):
application/json
Accept-Language (optional):
en, is (default)
Parameters:
Parameter: {id}
Required: true
Type: integer
Description: test
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"
}
}