Skip to content

echokrist/Firi-SDK-Kotlin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

24 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Firi SDK for Kotlin

Welcome to the Firi SDK for Kotlin, an easy-to-use SDK for interacting with the Firi cryptocurrency trading platform. This SDK allows developers to integrate Firi's functionality into their Kotlin-based applications with minimal effort.


Start Investing in Cryptocurrency with Firi! ๐Ÿš€

โš ๏ธ IMPORTANT NOTE (READ BEFORE REGISTERING):

  • Buying and selling cryptocurrency involves high risk, and past performance is not a guarantee of future results.
  • You must be at least 18 years old to register.
  • BankID or MitID is required to verify your identity.

Stay informed and invest responsibly! ๐Ÿ’ก

If you want to start investing in cryptocurrency with Firi, you can use my Referral Link and receive 55 kr in welcome bonus! ๐ŸŽ‰

Or scan the QR code below to get started:

Firi Referral


Features

  • Seamless Integration: Easily integrate Firi's trading, portfolio, and account management features into your Kotlin projects.
  • Comprehensive API Coverage: Supports a wide range of Firi's API endpoints for trading, fetching market data, managing wallets, and more.
  • Simple and Intuitive: Built with Kotlin idioms and best practices to ensure ease of use and clean code.

Installation

Gradle

Add the following to your build.gradle.kts file:

dependencies {
    implementation("com.github.echokrist:Firi-SDK-Kotlin:latest-version")
}

Replace latest-version with the latest version of the SDK available on the repository.

Maven

Add the dependency to your pom.xml:

<dependency>
    <groupId>com.github.echokrist</groupId>
    <artifactId>Firi-SDK-Kotlin</artifactId>
    <version>latest-version</version>
</dependency>

Usage

Initialization

Start by initializing the SDK with your API key and secret:

import com.firi.sdk.FiriSDK

val firiSDK = FiriSDK(
    apiVersion = "latest-api-version",
    apiKey = "your-api-key",
    apiClientId = "your-api-client-id",
    apiSecretKey = "your-api-secret-key"
)

Fetch Account Balance

val balance = firiSDK.getUserWalletBalances()
println("Your user balances: $balance")

Place an Order

val orderResponse = firiSDK.createOrder(
    symbol = "BTCNOK",
    amount = 0.01,
    price = 500000.0,
    orderType = "LIMIT"
)
println("Order placed: $orderResponse")

Fetch Market Data

val marketData = firiSDK.getMarketData("BTCNOK")
println("Market Data: $marketData")

Requirements

  • Kotlin: Version 1.8 or later
  • JDK: OpenJDK 11 or higher
  • Internet access to interact with Firi's APIs

Development

Contributing

Contributions are welcome! Please fork the repository, create a new branch, and submit a pull request.

Build applicaiton

To build locally, use the following command:

./gradlew clean build

Running Tests

To run tests, use the following command:

./gradlew test

Upgrading the gradle wrapper

Find the newest version of gradle here: https://gradle.org/releases/ Then run this command: (Remeber to repealce $gradleVersjon with the newest version)

./gradlew wrapper --gradle-version $gradleVersjon

License

This project is licensed under the MIT License. See the LICENSE file for details.


Acknowledgements

  • Thanks to the Firi team for providing comprehensive API documentation.
  • Kotlin community for best practices and support.

For more details, visit the official Firi API documentation.


Donate

If you find this project helpful, consider supporting its development with crypto donations:

Bitcoin (BTC - Network = Bitcoin network): bc1qfkgfyr0s3hcca9x6aql7xxktzzl7vx82z4e4a9

Bitcoin wallet QR-code


Cardano (Cardano - Network = Cardano network): addr1qyknlvfy3e30dunqrc7e3qtkgc3gdlwa5a8wuvnltncw24kqtdqwarj7we5latygaveylr8kah0yz6wck7eg0mp20dkqp4mcau

Cardano wallet QR-code


Ethereum (ETH - Network = ERC20): 0xdA5B88a6D8F74100a0074d27d09Afd988E1B58d1

Ethereum wallet QR-code


Stellar (XLM - Network = Stellar network) GDXNWYFNOESHEQGDUUC2ASOX4E2X3AEXBJJUFS7MBPVNXIVXXFWIJL7S - (Destination tag) 2576692763

Stellar wallet QR-code


Polkado (DOT - Network = Polkadot network) : 1eTouCDKhwiPDLSFid3FTs8eThhJrHAedYjeUtzRdhy2kWq

Polkadot wallet QR-code