Giter VIP home page Giter VIP logo

freenom's Introduction

Freenom

An async C# library for automatically renewing Freenom domains.

Warning
This library doesn't implement domain registration and configuration web API routes, as these can be easily abused for spam.

Usage

Provides an easy interface for interacting with the Freenom web API routes. This allows you to programmatically renew your domains.

To get started, add the library into your solution with either the NuGet Package Manager or the dotnet CLI.

dotnet add package Freenom.NET

For the primary classes to become available, import the used namespace.

using Freenom;

Need more examples? Under the Example directory you can find a working demo project that implements this library.

Dependencies

  • HtmlAgilityPack (GitHub) (Website): For efficiently parsing the DOM and reading data out of it.

Code Samples

Creating a new Freenom client

FreenomClient freenom = new();

Logging in

string name = await freenom.Login("EMAIL", "PASSWORD");

Getting basic account information

AccountInfo info = await freenom.GetAccountInfo();

Getting all domains under the account that might be renewable

RenewalDomain[] renewals = await freenom.GetRenewals();

Filtering domains that are currently renewable using LINQ

RenewalDomain[] renewable = renewals.Where(x => x.Renewable).ToArray();

Renewing a domain for 12 months

long orderId = await freenom.RenewDomain(6236693445, 12);

Features

  • Built for .NET 6 and .NET 7
  • Fully async
  • Extensive XML documentation
  • Custom exceptions (FreenomException) for advanced catching
  • Automatically renew Freenom domains that are expiring soon
  • Automatic request retries
  • Example project to show the usage of the library

Available methods

  • Task<string> Login(string email, string password)
  • Task Logout()
  • Task<AccountInfo> GetAccountInfo()
  • Task<RenewalDomain[]> GetRenewals()
  • Task<long> RenewDomain(long id, int months)

References

This is a community-ran library. Not affiliated with OpenTLD BV.

freenom's People

Contributors

actually-akac avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

dexveloper

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.