Skip to content

README.md

Latest commit

 

History

History
127 lines (92 loc) · 7.14 KB

README.md

File metadata and controls

127 lines (92 loc) · 7.14 KB
Raw

AxioAPI Java SDK: temp mail, SMS OTP, email validation, proxy, SEO and backlink API

Java client for the AxioAPI REST API: temp mail API, receive SMS and OTP API, email validation API, proxy API, SEO API (keyword data and backlink API) and social scraper APIs. One API key, pay per request. Java 11+, depends only on Jackson.

Get started in 3 steps

1. Get an API key

Create a free account, then open API keys, create a key and copy it. New accounts receive free credits after verification, enough to try every endpoint.

Set it as an environment variable (the SDK reads AXIOAPI_KEY):

export AXIOAPI_KEY=ak_your_key        # macOS / Linux
$env:AXIOAPI_KEY = "ak_your_key"      # Windows PowerShell

2. Install

With JitPack (no account needed):

<repositories>
  <repository><id>jitpack.io</id><url>https://jitpack.io</url></repository>
</repositories>

<dependency>
  <groupId>com.github.axioapi</groupId>
  <artifactId>axioapi-java</artifactId>
  <version>main-SNAPSHOT</version>
</dependency>

Or git clone https://github.com/axioapi/axioapi-java && mvn install, then use com.axioapi:axioapi:1.0.0. Requires Java 11+; depends only on Jackson.

3. Make your first call

import com.axioapi.AxioApi;
import java.util.List;
import java.util.Map;

public class Hello {
    public static void main(String[] args) {
        AxioApi client = AxioApi.builder(null).build();   // null reads AXIOAPI_KEY
        System.out.println(client.group("account").call("limits"));
        System.out.println(client.group("seo").call("keywordMetrics", Map.of("keywords", List.of("api gateway"), "country", "us")));
    }
}

Every endpoint works the same way: client.<group>.<operation>(params). See the examples below and the full reference.

More examples

import com.axioapi.AxioApi;
import com.axioapi.AxioApiException;
import com.fasterxml.jackson.databind.JsonNode;
import java.util.List;
import java.util.Map;

AxioApi client = AxioApi.builder(null).build();   // null reads AXIOAPI_KEY

// Keyword data API: volume, CPC and competition for up to 10 keywords per request
JsonNode rows = client.group("seo").call("keywordMetrics", Map.of("keywords", List.of("api gateway"), "country", "us"));

// Backlink API: summary with every data source that answered
JsonNode backlinks = client.group("seo").call("backlinksSummary", Map.of("domain", "example.com"));
System.out.println(backlinks.get("partial") + " " + backlinks.get("sources").fieldNames().next());

try {
    client.group("verify").call("wait", Map.of("number", "+12025550192"));
} catch (RateLimitException e) {
    System.out.println("retry in " + e.getRetryAfter() + "s, request " + e.getRequestId());
} catch (InsufficientCreditsException e) {
    System.out.println("top up credits");
}
  • client.group("seo").call("keywordMetrics", params) or client.call("seo.keyword-metrics", params) for every endpoint (camelCase, snake_case or kebab-case). client.operations() lists all of them with method, path and credit cost.
  • Returns the data node. client.request("GET", "/api/v1/account/limits", null, null, true) returns the whole envelope. callBinary returns file bytes.
  • Builder options: baseUrl, timeout, maxRetries(2), userAgent. 429 is retried for all methods; 502/503/504 and network errors only for GET and DELETE.
  • Unchecked exceptions extend AxioApiException (getStatus, getCode, getRequestId, getFields).

Docs: https://axioapi.com/docs · Guides: https://axioapi.com/guides · License: MIT

What you can build with the Java SDK

Use case API page Typical call
Temp mail API: disposable inboxes for signup and password-reset tests temporary-email create inbox, list messages, read message
Receive SMS API and OTP API: public numbers and "wait for the code" sms, verify list numbers, wait for OTP
Email validation API: syntax, MX and disposable-address checks email validate, batch validate
Proxy API: sticky and rotating proxy sessions by country proxy create session, rotate, close
SEO API: keyword data API (volume, CPC), backlink API, domain overview and history, on-page audit seo keyword metrics, backlinks summary
TikTok, Facebook, Instagram, YouTube, X (Twitter), LinkedIn and Reddit scraper APIs social profiles, posts, comments, transcripts

Guides with working code

Free tools that need no account: backlink checker, email validator, DNS lookup, BIN checker.

FAQ

Is there a Java client for the AxioAPI backlink API and keyword data API? Yes, this package. seo.backlinks_summary returns the backlink summary of a domain with the figures of every data source, and seo.keyword_metrics returns search volume, CPC and competition for up to 10 keywords per request.

How do I test signup emails and OTP codes from Java? Create a disposable inbox with the temp mail API, submit its address in your form and read the message. For SMS codes, call the verify endpoint, which waits for the OTP on a public number and returns it.

How much does it cost? You pay per request with credits, and each endpoint lists its price on its API page and in the OpenAPI spec (x-credit-cost). New accounts receive free credits after verification. See pricing.

Where is the full reference? axioapi.com/docs, the OpenAPI 3.1 spec and llms.txt for AI agents.

Vietnamese: AxioAPI tiếng Việt, API SEO và API backlink.