Documentation

SDKs & Collections

Our official SDKs make it easy to integrate CurrencyApi.net into your applications. Each SDK provides a simple, language-specific interface to our API, handling authentication, request formatting, and response parsing automatically.

All SDKs are open source, actively maintained, and follow the same consistent patterns across languages. They're designed to be intuitive for developers familiar with each language's conventions.

Overview

Our SDKs provide several key benefits:

  • Automatic Authentication: SDKs handle API key management and request signing
  • Type Safety: Full type definitions and IntelliSense support where applicable
  • Error Handling: Built-in error handling with proper exception types
  • Response Parsing: Automatic parsing of JSON/XML responses into native objects
  • Documentation: Comprehensive inline documentation and examples

Each SDK is designed to feel natural in its target language while maintaining consistency across all implementations.

Available SDKs

We currently provide official SDKs for the following languages:

Python SDK

GoLang SDK

NodeJs SDK

PHP SDK

Each SDK is available through the language's standard package manager and includes comprehensive documentation, examples, and type definitions.

Installation

Install the SDK for your preferred language using the appropriate package manager

For detailed installation instructions and requirements, visit our SDK page.

Instantiation

After installation, you need to instantiate the SDK client with your API key. Here's how to initialize each SDK:

  • 1. Import the SDK: Import the main client class
  • 2. Initialize the client: Create a new instance with your API key
  • 3. Start making requests: Use the client to interact with the API

Authentication

SDKs handle authentication automatically. You just need to provide your API key when initializing the client:

  • Direct Initialization: Pass the API key directly to the client constructor
  • Security: Never hardcode API keys in your source code

For production applications, always use environment variables or secure configuration management systems to store your API keys.

Error Handling

All SDKs provide consistent error handling with language-appropriate exception types:

  • API Errors: Thrown when the API returns an error response
  • Network Errors: Handled for connection and timeout issues
  • Authentication Errors: Specific exceptions for invalid API keys
  • Validation Errors: Input validation with helpful error messages

Each SDK provides detailed error information including error codes, messages, and HTTP status codes to help you handle errors appropriately.

Postman Collections

We have created a downloadable postman collection for our CurrencyApi. All you need to get started is an API key for our service, which is provided after signup. Just replace our placeholder API key with your own API key and away you go.

What's Next

Now that you understand our SDKs, you're ready to start building with our API: