Giter Club home page Giter Club logo

api-v1-client-csharp's Introduction

Blockchain API library (C#, .NET Core, v1)

An official C# (.NET Core) library for interacting with the Blockchain.info API.

Latest changes

This library is a migration of the original .NET library to .NET Core. Some models and namespaces have been modified. Most notably:

  • Receive Payments v2 API functionality has been introduced
  • Additional chart functionality has been added to the StatisticsExplorer class
  • All documentation has been brought up to date
  • All models have been moved to Info.Blockchain.API.Models
  • The client, exception and helper classes under the root namespace have been moved to Info.Blockchain.API.Client
  • CreateWallet.cs, which previously contained the CreateWallet response and request models, was split into two separate models and moved to the Data namespace
  • The Info.Blockchain.API.CreateWallet namespace was removed, the WalletCreator.cs class moved to Info.Blockchain.API.Wallet

Getting started

The library requires .NET Core 1.1. It is possible to use this library with the .NET Framework by editing Info.Blockchain.Api.csproj

and changing

<TargetFramework>netcoreapp1.1</TargetFramework>

to your project's .NET version, e.g.

<TargetFramework>net46</TargetFramework>

The recommended way to install and use the library is via NuGet:

PM> Install-Package BlockchainAPI

The library consists of the following namespaces:

The following namespacse contain helpers and models used by the above:

  • Info.Blockchain.API.Client
  • Info.Blockchain.API.Data
  • Info.Blockchain.API.Json

In order to use the Wallet and CreateWallet functionality, you must provide a URL to an instance of service-my-wallet-v3 as first parameter to BlockchainApiHelper. If you don't intend to use these functionalities, this parameter can be null.

Error handling

All methods may throw exceptions caused by incorrectly passed parameters or other problems. If a call is rejected server-side, the APIException exception will be thrown. Other exceptions may also be thrown by the environment (e.g. no internet connection etc).

Connection timeouts

It is possible to set arbitrary connection timeouts.

// time out after 5 seconds
Info.Blockchain.API.HttpClient.TimeoutMs = 5000;

Request limits and API keys

In order to prevent abuse some API methods require an API key approved with some basic contact information and a description of its intended use. Please request an API key here. The API key can be passed to the constructor of the BlockchainHttpClient class, which can be passed to the constructor of all other classes in this library.

The same API key can be used to bypass the request limiter.

api-v1-client-csharp's People

Contributors

alecalve avatar kmhouk avatar tuzzolo avatar assafy avatar clarkmoody avatar

Watchers

James Cloos avatar Dara Oladapo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.