Nicesi API v1 Documentation
NAV undefined
http

Introduction

Welcome to Nicesi API v1! Our API provides RESTful HTTP access to a large part of the functionality of Nicesi.

Nicesi's API documentation page was inspired by Slate

API Format

API results are currently returned in JSON formats. Specify the JSON format by including the HTTP header in all requests:

Content-type: application/json

REST API Client

We offer a ready to use collection of requests for Insomnia and Postman. The request file contains all example requests from this documentation.

Insomnia

To explore our APIs with Insomnia, follow these steps:

{
  "API_KEY": "api key from email",
  "BASE_URL": "base url from email",
  "PRIVATE_TOKEN": "private token from email"
}

Postman

To explore our APIs with Postman, follow these steps:

Authentication

There is one way to authenticate against Nicesi.

Token Authentication

GET /apiRoute?key=API_KEY HTTP/1.1

To authenticate against Nicesi using tokens, you need to pass an API KEY via an key query parameter.

We will send a api key to your email address when the payment is completed.

Help

If you have any questions/feedback regarding the Nicesi API v1, please reach out to us. We're here to help. You can email Nicesi Support at hello@nicesi.com.

Errors

The Nicesi API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid
401 Unauthorized -- Your API key is incorrect
403 Forbidden -- The resource requested is hidden for administrators only
404 Not Found -- The specified resource could not be found
405 Method Not Allowed -- You tried to access a resource with an invalid method
406 Not Acceptable -- You requested a format that isn't json
429 Too Many Requests -- You're requesting too many resources! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Endpoints

APIs: Location, Email, Exchange, Language, Account

Location APIs

Reverse Geocoding

GET geo/reverse?latlng=35.28502,24.83944&key=API_KEY HTTP/1.1
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "251187",
    "name": "Zonianá",
    "asciiName": "Zoniana",
    "alternateNames": "Zoniana,Zonianá,Ζωνιανά",
    "latitude": "35.29502",
    "longitude": "24.82944",
    "featureClass": "P",
    "featureCode": "PPL",
    "countryCode": "GR",
    "adm1": {
      "name": "Crete",
      "asciiName": "Crete",
      "id": "6697802"
    },
    "adm2": {
      "name": "Nomós Rethýmnis",
      "asciiName": "Nomos Rethymnis",
      "id": "254353"
    },
    "dem": "623",
    "timezone": "Europe/Athens",
    "distance": 1.4353386587850683,
    "openLocationCode": "8G767RPQ+2Q"
}

Reverse geocoding is the process of converting a coordinate or location (latitude, longitude) to a readable address or place name. This permits the identification of nearby street addresses, places, and/or area subdivisions such as a neighborhood, county, state, or country.

GET geo/reverse?latlng={lat,lon}&key={API_KEY}

Query Parameters

Parameter Description
lat,lon The elements (latitude, longitude) of coordinate.
key Api Key.

Time Zone

GET geo/timezone?latlng=35.28502,24.83944&key=API_KEY HTTP/1.1
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json

{
    "countryCode": "GR",
    "timezone": "Europe/Athens",
}

Time Zone API provides time zone info for locations(latitude/longitude) on the earth.

GET geo/timezone?latlng={lat,lon}&key={API_KEY}

Query Parameters

Parameter Description
lat,lon The elements (latitude, longitude) of coordinate.
key Api Key.

Elevation

GET geo/elevation?latlng=35.28502,24.83944&key=API_KEY HTTP/1.1
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json

{
    "latitude": "35.29502",
    "longitude": "24.82944",
    "dem": "623",
    "distance": 1.4353386587850683
}

Elevation API provides digital elevation model data for locations(latitude/longitude) on the earth.

GET geo/elevation?latlng={lat,lon}&key={API_KEY}

Query Parameters

Parameter Description
lat,lon The elements (latitude, longitude) of coordinate.
key Api Key.

Email APIs

Disposable Email Check

GET email/dispose?addr=asd123@10minutetempemail.com&key=API_KEY HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json

{
  "disposable":"true"
}

This endpoint to check if an email comes from 15000+ disposable email provider.

GET email/dispose?addr={email_address}&key={API_KEY}

Query Parameters

Parameter Description
email_address The address of disposable email.
key Api Key.

Exchange APIs

Latest (60min) Exchange Rates

GET exchange/60min?from=EUR&to=USD&key=API_KEY HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json

{
    "from": "EUR",
    "to": "USD",
    "ts": 1550927674,
    "rate": 1.133758
}

This endpoint to get currency exchange rates (60 minute updates).

GET exchange/60min?from={base_currency}&to={target_currency}&key={API_KEY}

Latest (5min) Exchange Rates

GET exchange/5min?from=EUR&to=USD&key=API_KEY HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json

{
    "from": "EUR",
    "to": "USD",
    "ts": 1550927674,
    "rate": 1.133758
}

This endpoint to get currency exchange rates (5 minute updates).

GET exchange/5min?from={base_currency}&to={target_currency}&key={API_KEY}

Query Parameters

Parameter Description
from Base currency.
to Target currency.
key Api Key.

Supported Currencies

Symbol Name
AUD Australian Dollar
BGN Bulgarian Lev
BRL Brazilian Real
CAD Canadian Dollar
CHF Swiss Franc
CNY Chinese Yuan
CZK Czech Republic Koruna
DKK Danish Krone
EUR Euro
GBP British Pound Sterling
HKD Hong Kong Dollar
HRK Croatian Kuna
HUF Hungarian Forint
IDR Indonesian Rupiah
ILS Israeli New Sheqel
INR Indian Rupee
ISK Icelandic Króna
JPY Japanese Yen
KRW South Korean Won
MXN Mexican Peso
MYR Malaysian Ringgit
NOK Norwegian Krone
NZD New Zealand Dollar
PHP Philippine Peso
PLN Polish Zloty
RON Romanian Leu
RUB Russian Ruble
SEK Swedish Krona
SGD Singapore Dollar
THB Thai Baht
TRY Turkish Lira
USD United States Dollar
ZAR South African Rand

Language APIs

Language Detection

GET lang/detect?t=The quick brown fox jumps over the lazy dog&key=API_KEY HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json

{
    "lang": "eng"
}

This endpoint to detect the language of text. Text character length must be greater than 19 and less than 161

Three-letter language code https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes

GET lang/detect?t={text}&key={API_KEY}

Query Parameters

Parameter Description
t Text.
key Api Key.

Account APIs

Credit Balance

GET account/balance?private=KEY HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json

{
  "balance": 9800
}

See how many credits remain on your account.

GET account/balance?private={KEY}

Query Parameters

Parameter Description
private Private Api Key.

Changelog

v1.0

SignUp