Bitcoin java doc strings
BitPay provides a standards-based REST interface which enables application developers to interact in a powerful, yet secure way with their BitPay account. Using the BitPay API, clients can create and manage invoices, issue bitcoin java doc strings, manage bills, retrieve real-time rates information, view merchant ledger entries, and much more.
Every Identity is represented in public form as a Client IDwhich much like the Bitcoin protocol, is simply a hash of the identity's public key.
For your convenience, all of BitPay's Client Libraries support this functionality. API Tokens are analagous to a real-world event ticket, which grants access to a specific event when presented at the door. Also like tickets, they may grant broad or narrow privileges e. New tokens are provided with each response from the API. For example, creating a new Invoice with one token will provide a new, second token that grants access to view and interact with that Invoice exclusively.
If not using BitPay's Client Librariesyou will need to keep track of these tokens on your own. Facades named collections of capabilities that can be granted, such as the ability to create invoices or grant refunds. In the ticket analogy, this corresponds to the ticket bitcoin java doc strings, where a 'VIP' ticket would confer broader access than a 'Standard' level ticket.
When registering an Identity, it is against a specific facade. Best practices suggest that the requested facade should bitcoin java doc strings limited to the bitcoin java doc strings level that grants the required capabilities. To use any non-public facade a token will need to be sent with the API request.
Tokens can require authentication, which would requiring cryptographically signing each request. This will respond with a new bitcoin java doc strings that will include a pairingCode. This pairing code can then be shared with a merchant organization administrator to approve access. A token without a Client ID authentication restriction can be made, and a token can then be copied directly to make API calls, such as creating invoices.
It is also important to note that pairing codes will expire after 24 hourshowever once a token is approved or claimed the expiration is cleared. Once again bitcoin java doc strings mechanics of this exchange may be simplified through the use of one of the BitPay libraries. For more information about specific resource URIs, please visit the resource documentation. So if you are sending a request to:. The result should be included as the value of the x-signature request header.
If your key becomes compromised, you will want to disable your old Client ID and register a new one. API sessions are an optional feature bitcoin java doc strings our API which can be utilized to provide even greater security and reliability.
In particular it protects against replay attacks and ensures api requests are processed in the same bitcoin java doc strings they are received. The server responds with a sessionId. The sessionId is used in each subsequent request along with a requestNumber.
On the first request, the requestNumber should be 1. Each additional request should increment the requestNumber by 1. If the server receives a request out of order it will return an error. If the client does not hear back from the server because of an interruption in network connectivity or some other problem, the client may retry by sending the same request with the same requestNumber.
The server will then respond with a cached copy of the data if it had already serviced that request but was interrupted when delivering it to the client. API sessions timeout after 15 minutes of inactivity. After 15 minutes, clients will get an error, and must create a new session.
Clients can bitcoin java doc strings programmed to handle creation of new sessions and bitcoin java doc strings automatically. Please see the Node. Codes marked as deprecated may have been used in the past, but are no longer used for newly written ledger bitcoin java doc strings. Bills are payment requests addressed to specific buyers. Bill line items have fixed prices, typically denominated in fiat currency. A client is identified by its access key id.
A client is associated with a token via a pairing process. Invoices are time-sensitive payment requests addressed to specific buyers. An invoice has a fixed price, typically denominated in fiat currency.
It also has a BTC equivalent price, calculated by BitPay, with an expiration time of about 15 minutes. Retrieves invoices for the calling merchant filtered by query.
Payouts are batches of bitcoin payments to employees, customers, partners, etc. Rates are exchange rates, representing the number of bitcoin java doc strings currency units equivalent to one BTC. Creates an API session to protect against replay attacks and ensure requests are received in the same order they are sent. Settlements are transfers of payment profits from BitPay to bank accounts and bitcoin wallets owned by merchants, partners, etc.
This endpoint exposes reports detailing these bitcoin java doc strings. Retrieves settlement reports for the calling merchant filtered by query. Gets a detailed reconciliation report of the activity bitcoin java doc strings the settlement period. Subscriptions are repeat billing agreements with specific buyers. BitPay sends bill emails to buyers identified in active subscriptions according to the specified schedule.
Tokens are API access identifiers which are associated with a set of capabilities. A capability may be very broad, for example, retrieve the list of all exchange rates. Or a capability bitcoin java doc strings be very specific, for example, update bill Overview BitPay provides a standards-based REST interface which enables application developers to interact in a powerful, yet secure way with their BitPay account. Facades Facades named collections of capabilities that can be granted, such as the ability to create invoices or grant refunds.
Facade Capabilities Description public The implicit facade applied when no token is provided. Provides access to public methods for generating merchant applications, generating and claiming tokens, bitcoin java doc strings checking exchange rates. Allows for create, search, and view actions for Invoices and Bills; ledger download, as well as the creation of new merchant or pos tokens associated with the account.
My BitPay Client id e. Each request should include in the HTTP headers: So if you are sending a request to: US wallet provider names used for payouts BitPay Code Name bitgo bitcoin java doc strings circle coinbase gdax gemini itbit kraken. Bills Resource Bills are payment requests addressed to specific buyers.
Indicates whether corresponding invoice web page should display equivalent fiat amount. Default is current time. Required Parameters description price quantity Facades merchant. Parameters status Facades merchant. Parameters none Facades merchant. Required Parameters none Facades public. Parameters none Facades client. Required Parameters none Facades client public. Parameters none Facades public. Resource Invoices are time-sensitive payment requests addressed to specific buyers.
ISO 3-character currency code. This is the currency associated with the price field, supported currencies are listed on https: Can be used by the merchant to assign their own internal Id to an invoice. If used, there should be a direct match between an orderId and an invoiceId.
Contact for notification of invoice status change. If missing, then account notification email address is notified. URL to redirect your shopper back to your website after a successful purchase. Be sure to include "http: The URIs for sending a transaction to the invoice.
The first key is the transaction currency. The transaction currency maps to an object containing the payment URIs. Order reference number from the point-of-sale POS. It should be a unique identifer for each order that you submit. Field is a passthru-variable returned in the payment notification post, without any modifications, for you to match up the BitPay payment notification with the request that was sent to Bitcoin java doc strings. HIGH speed confirmations typically take seconds, and can be used for digital goods or low-risk items.
LOW speed confirmations take about 1 hour, and should be used for high-value items. If missing, then account transaction speed is used. Indicates whether email and IPN notifications should be sent for this invoice. If missing, then account notification settings are used. Indicates whether IPN notifications should be sent for this invoice when the invoice expires or is refunded. If true, then fullNotifications is automatically set to true.
The best API for getting free cryptocurrency live pricing data, OHLC historical data, volume data, tick data or block explorer data from multiple exchanges and blockchains.
We have integrated with over 90 exchanges, coins and have over bitcoin java doc strings, trading pairs listed. Please make sure you credit us with a link if you use our data on your website or app. Some of the great services using our pricing API: Sign up for API updates here. Most of the requests that are related to pricing data are public at the moment and generally available via GET functions. Please do not abuse them, a request every 10 sec should be more than enough.
There is also a streaming api based on socket. Bitcoin java doc strings the moment the public rest api and streaming apis are not delayed. You can see the limits here: CryptoCompare uses session cookies to allow access to private data. You can obtain the cookie by logging in. A session key is only valid for 30 days and it has a sliding window period, so each time you use it, it will get extended by 30 days.
Type less than will mean there was an bitcoin java doc strings. This section deals with all the requests for price data, social data and historical data.
Most of it is used for dealing with subscription, top list, historical and snapshot data. Get the latest price for a list of one or more currencies. Really fast, ms. Cached each 10 seconds. Get all the current trading info price, vol, open, high, low etc of any list of cryptocurrencies in any other currency that you need. If the crypto does not trade directly bitcoin java doc strings the toSymbol requested, BTC will be used for conversion. This API also returns Display values for all the fields.
If the opposite pair trades we invert it eg.: Compute the current trading info price, vol, open, high, low etc of the requested pair as a volume weighted average based on the markets requested. Get day average price. The values are based on hourly vwap data and the average can be calculated in different waysIt uses BTC conversion if data is not available because the coin is not trading in the specified currency.
If tryConversion is set to false it will give you the direct data. If no toTS is given it will automatically bitcoin java doc strings the current day. Get the price of any cryptocurrency in any other currency that you need at a given timestamp.
The price comes from the daily info - so it would be the price at the end of the day GMT based on the requested Bitcoin java doc strings. Tries to get direct trading pair data, if there is none or it is more than 30 days before the ts requested, it uses BTC conversion. Get data for a currency pair. It returns general block explorer information, bitcoin java doc strings data and individual data for each exchange available.
This api is getting abused and will be moved to a min-api path in the near future. Please try not to use it. Get the general, subs used to connect to the streamer and to figure out what exchanges we have data for and what are the exact coin pairs of the coin and the aggregated prices for all pairs available.
AggregatedPrices Array[] yes Snapshot data about the coin volume, price, open, high, low close etc. If called with the id of a cryptopian you just get data from our website that is available to the public. UrlstringnoThe relative path without https: Get open, high, low, close, volumefrom and volumeto from the each minute historical data. This data is only stored for 7 days, if you need more,use the hourly or daily path. It uses BTC conversion if data is not available because the coin is bitcoin java doc strings trading in the specified currency.
The values are based on Used to get all the mining equipment available on the website. It returns an array of mining equipment objects. Get top pairs by volume for a currency always uses our aggregated data.
The number of pairs you get is the minimum of the limit you set default 5 and the total number of pairs available. Get real-time market data updates by connecting to our web socket ' wss: We are using socket. For more example code click here. Subscribe to market data by emitting 'SubAdd' including a list of items you want to get updates on. After the first response, only updates will be sent. The MaskInt parameter maps the response to the properties. Use our utility functions to map the response, you can find the code here.
Introduction The best API for getting free cryptocurrency live pricing data, OHLC historical data, volume data, tick data or block explorer data from multiple exchanges and blockchains. Requests Most of the requests that are related to pricing bitcoin java doc strings are public at the moment and generally available via GET functions. Sessions A session key is only valid for 30 days and it has bitcoin java doc strings sliding window period, so each time you use it, it will get extended by 30 days.
Note that the responses to all requests, both public and private, are sent as the response body. Data This section deals with all the requests bitcoin java doc strings price data, social data and historical data.
Data Object yes Empty if there is no data to return or there is an error Data [Symbol]: Id int yes The internal id, this is used in other calls Data [Symbol]: ImageUrl string yes The logo image of the coin Data [Symbol]: CoinName string yes The name Data [Symbol]: FullName string bitcoin java doc strings A combination of the name and the symbol Data [Symbol]: Algorithm string yes The algorithm of the cryptocurrency Data [Symbol]: ProofType string yes The proof type of the cryptocurrency Data [Symbol]: Invalid Market ", "Data": For PST you would pass -8 for example.
URL Parameters Parameter Type Mandatory Description fsym string yes The symbol of the currency you want to get that for tsym string yes The symbol of the currency that data will be in. Return data Parameter Type Always returned Description Response string yes The type of the response Success or Error Message string yes The message for the response Type integer yes Integer representing the type bitcoin java doc strings response.
Data object yes Empty if there is no data to return or there is an error Data: Algorithm string yes The algorithm of the from currency Data: BlockNumber integer yes The current block number delayed by 1 hour max Data: BlockReward integer yes The current block bitcoin java doc strings delayed by 1 hour max Data: AggregatedData object yes See success request example Data: What are bitcoin java doc strings trying to do?
AggregatedPrices Array[] yes Snapshot data bitcoin java doc strings the coin volume, price, open, high, low close etc Parameter Type Always returned Description Bitcoin java doc strings string yes The type of the response Success or Error Message string yes The message for the response BaseImageUrl string yes The base url for all the images from the ImageUrl field BaseLinkUrl string yes The base url for all the links from the Url field Type int yes Integer representing the type of response.
General object yes The general data available for this coin Data: H1Text string yes The title used on our website a combination of the coin name and the symbol Data: ImageUrl string yes The relative path to the logo of the coin, prefix this value with the BaseImageUrl to get the absolute path Data: DangerTop string yes The text displayed in red on the website at the top, generally a big issue with bitcoin java doc strings coin Data: WarningTop string yes The text displayed in yellow on the website at the top, generally an issue with the coin Data: InfoTop string yes The text displayed in green on the website at the top, generally an announcement or extra info that is important Data: Symbol string yes The symbol of the coin Data: Url string yes The relative path to the coin, prefix this value with the BaseLinkUrl to get the absolute path Data: Name string yes The name of the coin Data: Description string yes The description of the coin, this is returned as html Data: Features string yes The features of the coin, this is returned as html Data: Technology string yes The technology of the coin, this is returned as html Data: TotalCoinSupply int yes The maximum number of coins Data: StartDate string yes The day the first block was mined, so the day the coin actually came into existance Data: Twitter string yes The twitter address of the coin Data: TwitterWidgetId string yes The cryptocompare twitter widget id for this coin Data: Website string yes The coin official website Data: DifficultyAdjustment string yes The difficulty adjustment Data: BlockRewardReduction string yes The value by which the block reward is reduced when there is a block reward reduction Data: BlockNumber int yes The current block number delayed by bitcoin java doc strings hour max Data: BlockTime int yes The estimated time it takes to mine a block Data: TotalCoinsMined int yes The current total coins mined delayed by 1 hour max Data: