What's Faker API?

Faker API it's a collection of completely free APIs that helps web developers and web designers generate fake data in a fast and easy way. No registration is required. No tokens, no authentication.

Every resource allows to choose the API language by "_locale" parameter and also allows to select the number of rows requested by "_quantity" parameter. Max 1000 rows.

Check the Docs to read more about every resource. In addition, it's available the Postman collection to use these APIs directly in the well-known client.

At the end of this page you will find the Test section, where you can test our APIs throug the specific form.

Current version: 1.0.2

Docs

No registration is required. No tokens, no keys or other types of authentication. Faker API it's a free service for every developer who want to use it.

Postman:
Download here the Postman collection (v 2.1)
Download Postman Collection

Base URL #

https://fakerapi.it/api/v1/{resource}

Basic Usage #

Some resources allow to filter data by GET parameters.
The names of these parameters are always preceded by an underscore character "_", for example:

https://fakerapi.it/api/v1/images?_width=380

Data are always wrapped inside "data" and are always returned with the total number of rows ("total") and with the Http response "code".

Every resource accepts 3 GET common parameters:

_locale #

Default: en_US

This parameter means the language of the API response we want to get and accept the locale format "en_EN". For example:

https://fakerapi.it/api/v1/persons?_locale=fr_FR

This example returns people with french names.

_quantity #

Default: 10

Max: 1000

This parameter means the number of rows we want to obtain and accept only integers. If you request more than 1000 rows (maximum) the system will return 1000 rows anyway. Example:

https://fakerapi.it/api/v1/companies?_quantity=5

This example returns 5 companies.

_seed #

Default: null

This parameter accept an integer and allows to get always the same results. So, executing the same request with _seed parameter set to the same number (ex. 12345) the results will never change. Example:

https://fakerapi.it/api/v1/companies?_seed=12456

Resources #

Request:

https://fakerapi.it/api/v1/addresses?_quantity=1

Response:

Request:

https://fakerapi.it/api/v1/books?_quantity=1

Response:

Request:

https://fakerapi.it/api/v1/companies?_quantity=1

Response:

Request:

https://fakerapi.it/api/v1/credit_cards?_quantity=1

Response:

Additional optional parameters:

Parameter Description Example
_type any, animals, architecture, nature, people, tech, kittens, pokemon
_type=architecture
_width pixels (default: 640)
_width=500
_height pixels (default: 480)
_height=230

Request:

https://fakerapi.it/api/v1/images?_quantity=1&_type=kittens&_height=300

Response:

Additional optional parameters:

Parameter Description Example
_gender male, female
_gender=female
_birthday_start date in format Y-m-d (default: -90 years)
_birthday_start=1994-02-09
_birthday_end date in format Y-m-d (default: now)
_birthday_end=2018-10-09

Request:

https://fakerapi.it/api/v1/persons?_quantity=1&_gender=male&_birthday_start=2005-01-01

Response:

Request:

https://fakerapi.it/api/v1/places?_quantity=1

Response:

Additional optional parameters:

Parameter Description Example
_price_min number in format 10.35 (default: 0.01)
_price_min=20.50
_price_max number in format 10.35 (default: none)
_price_max=10320.99
_taxes percentage (default: 22)
_taxes=10
_categories_type integer, string, uuid (default: integer)
_categories_type=uuid

Request:

https://fakerapi.it/api/v1/products?_quantity=1&_taxes=12&_categories_type=uuid

Response:

Additional optional parameters:

Parameter Description Example
_characters integer (default: 200)
_characters=350

Request:

https://fakerapi.it/api/v1/texts?_quantity=1&_characters=500

Response:

Additional optional parameters:

Parameter Description Example
_gender male, female
_gender=female

Request:

https://fakerapi.it/api/v1/users?_quantity=1&_gender=male

Response:

This resource is the only one which does'nt follow the same rules of the others.
The 3 common parameters (_quantity, _locale, _seed) have the same usage of the other resources, but this request it's managed in a different way.

Request to this resource accepts custom parameters following this pattern:

myCustomName1=customType1&myCustomName2=customType2

where myCustomName1 and myCustomName2 are my custom parameters names, and customType1 and customType2 are my custom parameters types. See below the allowed types.

This allows to generate a custom ad hoc resource, using type parameters listed below:

Parameter Example
boolean false
boolean_digit 0
buildingNumber "1213"
card_expiration "12\/23"
card_number "4929226385117941"
card_type "MasterCard"
city "Bridiebury"
company_name "Emmerich, Ferry and Schmitt"
counter 2
country "Costa Rica"
countryCode "KI"
date "1992-12-23"
dateTime {"date":"1981-08-16 08:38:35.000000","timezone_type":3,"timezone":"UTC"}
ean "3881164229172"
email "zoila.herman@hotmail.com"
firstName "Noemy"
image "http:\/\/placeimg.com\/640\/480\/any"
lastName "Williamson"
latitude -7.645108
longText "I almost wish I'd gone to see the Hatter grumbled: 'you shouldn't have put it more clearly,' Alice replied in a rather offended tone, 'so I can't tell you my history, and you'll understand why it is right?' 'In my youth,' said his father, 'I took to the shore. CHAPTER III. A Caucus-Race and a crash of broken glass, from which she concluded that it had VERY long claws and a scroll of parchment in the world! Oh, my dear paws! Oh my dear Dinah! I wonder what was the White Rabbit cried out, 'Silence in the distance would take the hint; but the three gardeners at it, busily painting them red. Alice thought to herself, 'Which way? Which way?', holding her hand again, and did not like to see it quite plainly through the doorway; 'and even if my head would go through,' thought poor Alice, 'it would have made a snatch in the shade: however, the moment she appeared on the second verse of the house!' (Which was very like a wild beast, screamed 'Off with his head!' she said, 'and see whether."
longitude 148.237861
name "Stacey Weber"
null null
number 26734
phone "+8020915308165"
pokemon "Natu"
postcode "82787-5273"
state "Alaska"
streetAddress "2059 Graciela River Suite 945"
streetName "Hilpert Mission"
text "Alice; 'that's not at all a proper way of keeping up the chimney, has he?' said Alice desperately: 'he's perfectly idiotic!' And she began shrinking directly. As soon as look at a king,' said Alice."
upc "604969265034"
uuid "603e7654-c7fc-3867-853a-cb3bced71b9f"
vat "98062299753"
website "renner.com"
word "esse"

Custom request:

https://fakerapi.it/api/v1/custom?_quantity=1&customfield1=name&customfield2=dateTime&customfield3=phone

Response:

Test APIs

Test Response.

Changelogs

Date of release: 23 April 2020

  • Added "pokemon" type to Custom resource
  • Added Pokémon images to Image resource

Date of release: 14 April 2020

  • Added "counter" type to Custom resource

Date of release: 12 April 2020

  • First release