BitcoinSV API Documentation (1.0.0)

Download OpenAPI specification:Download

Introduction

This is BitcoinSV API providing data such as live pricing, trading column, historical data, and other data.

The BitcoinSV API is free to use.

Authentication

BitcoiSV API uses OAuth2 for authentication. Oauth2 is an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

auth

Authentication API

Authenticate

Get access token.

Request Body schema: application/json

Get access token

email	string <email> User email address
password	string <password> >= 10 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"password": "drowssaP123@X"
}

Response samples

200

Content type

application/json

[{"access_token": "string",
"token_type": "string",
"expires_at": 0
}
]

exchange

Get exchange data

Get volume chart

path Parameters

exchange_id

required

string

Exchange ID

query Parameters

days

required

integer <int64>

Data up to number of days ago

Responses

Response samples

200

Content type

[{"volume": "string",
"timestamp": 0
}
]

To obtain all markets’ ID and Names

Responses

Response samples

200

Content type

[{"id": "string",
"name": "string"
}
]

List all exchange tickers’ data

path Parameters

exchange_id

required

string

Exchange ID

query Parameters

coinIDs	string Get ticker data based on a certain coin ID or multiple ones. Use comma for separation if it’s multiple, i.e: BTC,BSV,...
page	integer <int64> Current page. Default is 1
pageSize	integer <int64> Total results per page Default is 100
orderBy	string Sorts results by field. Valid values: trust_score, volume. Default will be market_cap
orderType	string Order type, valid values: asc, desc Default is desc

Responses

Response samples

200

Content type

{"exchangeName": "string",
"tickers": [{"base": "string",
"target": "string",
"market": {"name": "string",
"identifier": "string",
"has_trading_incentive": true
},
"last": 0,
"convertedLast": {"btc": 0,
"eth": 0,
"usd": 0
},
"convertedVolume": {"btc": 0,
"eth": 0,
"usd": 0
},
"trustScore": "string",
"bidAskSpreadPercentage": 0,
"timestamp": "string",
"lastTradedAt": "string",
"lastFetchAt": "string",
"isAnomaly": 0,
"isStale": 0,
"tradeUrl": "string",
"coinId": "string",
"targetCoinId": "string"
}
]
}

List all exchanges’ data, includes: general information, total volume,...

query Parameters

page	number Current page. Default is 1
pageSize	integer <int64> Total results per page Default is 100

Responses

Response samples

200

Content type

[{"id": "string",
"name": "string",
"yearEstablished": 0,
"country": "string",
"description": "string",
"url": "string",
"image": "string",
"hasTradingIncentive": 0,
"trustScore": 0,
"trustScoreRank": 0,
"tradeVolume24hBSV": 0,
"tradeVolume24hBSVNormalized": 0
}
]

coin

Get coin data

Get all coins’ ID to request a certain coin information related API request calls

Responses

Response samples

200

Content type

[{"id": "string",
"symbol": "string",
"name": "string"
}
]

List all supported coins price, market cap, volume and other market related data

query Parameters

targetCurrency required	string The target currency of market data. i.e: usd, eur,…
ids	string Specify certain Coin IDs for market data. Support multiple IDs, comma separated
page	number Current page. Default is 1
pageSize	integer <int64> Total results per page Default is 100
orderBy	string Sorts results by field. Valid values: market_cap\|volume. Default will be market_cap
orderType	string Order type, valid values: asc, desc Default is desc
sparkline	boolean Include sparklines 7 days data. Valid values: true, false Default is false
priceChangePercentage	string Include price change percentage in a period of time Valid value: 1h, 24h, 7d, 14d, 30d, 200d, 1y (eg. '1h,24h,7d' comma-separated, invalid values will be discarded)

Responses

Response samples

200

Content type

[{"id": "string",
"symbol": "string",
"name": "string",
"image": 0,
"currentPrice": 0,
"marketCap": 0,
"marketCapRank": 0,
"totalVolume24h": 0,
"high24h": 0,
"low24h": 0,
"priceChange24h": 0,
"priceChangePercentage24h": 0,
"marketCapChange24h": 0,
"marketCapPercentageChange24h": 0,
"circulatingSupply": 0,
"totalSupply": 0,
"ath": 0,
"athChangePercentage": 0,
"athDate": "string",
"atl": 0,
"atlChangePercentage": 0,
"atlDate": "string",
"roi": 0,
"lastUpdated": 0
}
]

currency

Get supported currencies

Get all supported currencies, includes crypto and fiat currencies

Responses

Response samples

200

Content type

["string"
]

price

Get price data

Get price of a crypto currency

query Parameters

ids required	string Coin IDs, refer at Get Coin List Use comma for multiple coin IDs btc, eth
currencies required	string Currencies of coins converted to. Refer at Get Supported Currencies Use comma for multiple currencies
includeMarketCap	boolean Valid values: true, false Default is false
include24HVol	boolean Valid values: true, false Default is false
include24HChange	boolean Valid values: true, false Default is false
includeLastUpdatedAt	boolean Valid values: true, false Default is false

Responses

Response samples

200

Content type

{"usd": 0,
"usdMarketCap": 0,
"usd24hVol": 0,
"usd24hChange": 0,
"eur": 0,
"eurMarketCap": 0,
"eur24hVol": 0,
"eur24hChange": 0,
"lastUpdatedAt": 0
}

The Exchange Model

Array ()

id	string
name	string
yearEstablished	number
country	string
description	string
url	string
image	string
hasTradingIncentive	number
trustScore	number
trustScoreRank	number
tradeVolume24hBSV	number
tradeVolume24hBSVNormalized	number

[{"id": "string",
"name": "string",
"yearEstablished": 0,
"country": "string",
"description": "string",
"url": "string",
"image": "string",
"hasTradingIncentive": 0,
"trustScore": 0,
"trustScoreRank": 0,
"tradeVolume24hBSV": 0,
"tradeVolume24hBSVNormalized": 0
}
]

The Price Model

usd	number
usdMarketCap	number
usd24hVol	number
usd24hChange	number
eur	number
eurMarketCap	number
eur24hVol	number
eur24hChange	number
lastUpdatedAt	number

{"usd": 0,
"usdMarketCap": 0,
"usd24hVol": 0,
"usd24hChange": 0,
"eur": 0,
"eurMarketCap": 0,
"eur24hVol": 0,
"eur24hChange": 0,
"lastUpdatedAt": 0
}

The Currency Model

Array ()

string

["string"
]

The Coin Market Model

Array ()

id	string
symbol	string
name	string
image	number
currentPrice	number
marketCap	number
marketCapRank	number
totalVolume24h	number
high24h	number
low24h	number
priceChange24h	number
priceChangePercentage24h	number
marketCapChange24h	number
marketCapPercentageChange24h	number
circulatingSupply	number
totalSupply	number
ath	number
athChangePercentage	number
athDate	string
atl	number
atlChangePercentage	number
atlDate	string
roi	number
lastUpdated	number

[{"id": "string",
"symbol": "string",
"name": "string",
"image": 0,
"currentPrice": 0,
"marketCap": 0,
"marketCapRank": 0,
"totalVolume24h": 0,
"high24h": 0,
"low24h": 0,
"priceChange24h": 0,
"priceChangePercentage24h": 0,
"marketCapChange24h": 0,
"marketCapPercentageChange24h": 0,
"circulatingSupply": 0,
"totalSupply": 0,
"ath": 0,
"athChangePercentage": 0,
"athDate": "string",
"atl": 0,
"atlChangePercentage": 0,
"atlDate": "string",
"roi": 0,
"lastUpdated": 0
}
]

The Coin Model

Array ()

id	string
symbol	string
name	string

[{"id": "string",
"symbol": "string",
"name": "string"
}
]

The Ticket Model

exchangeName	string
	Array of objects

{"exchangeName": "string",
"tickers": [{"base": "string",
"target": "string",
"market": {"name": "string",
"identifier": "string",
"has_trading_incentive": true
},
"last": 0,
"convertedLast": {"btc": 0,
"eth": 0,
"usd": 0
},
"convertedVolume": {"btc": 0,
"eth": 0,
"usd": 0
},
"trustScore": "string",
"bidAskSpreadPercentage": 0,
"timestamp": "string",
"lastTradedAt": "string",
"lastFetchAt": "string",
"isAnomaly": 0,
"isStale": 0,
"tradeUrl": "string",
"coinId": "string",
"targetCoinId": "string"
}
]
}

The Market Model

Array ()

id	string
name	string

[{"id": "string",
"name": "string"
}
]

The Volume Chart Model

Array ()

volume	string
timestamp	integer <int32>

[{"volume": "string",
"timestamp": 0
}
]

The User Login Model

access_token	string
token_type	string
expires_at	integer <int32>

{"access_token": "string",
"token_type": "string",
"expires_at": 0
}

The User Model

id	integer <int32>
type	string
name	string
email	string
active	boolean
access_token	string
created_at	integer <int32>
updated_at	integer <int32>

{"id": 0,
"type": "string",
"name": "string",
"email": "string",
"active": true,
"access_token": "string",
"created_at": 0,
"updated_at": 0
}

The User Login Request Model

id	integer <int64> (Id)
email	string <email> User email address
password	string <password> >= 10 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits

{"id": 0,
"email": "[email protected]",
"password": "drowssaP123@X"
}

The User Sign Up Request Model

id	integer <int64> (Id)
name	string >= 4 characters User name
email	string <email> User email address
password	string <password> >= 10 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ User password, MUST contain a mix of upper and lower case letters, as well as digits
password_confirmation	string <password> >= 10 characters /(?=.[a-z])(?=.[A-Z])(?=.*[0-9])/ Confirmation password must match with password

{"id": 0,
"name": "John78",
"email": "[email protected]",
"password": "drowssaP123@X",
"password_confirmation": "drowssaP123@X"
}