{"info":{"_postman_id":"e2010052-c5fa-4e56-8054-7bea551f145c","name":"RANDUS.ORG API 2.0 (EN)","description":"

Welcome to RANDUS.ORG API Documentation in English!

To start using our API, you need to register on our website and get an authorization token, which is specified in the header of each request in the following format: Authorization: Bearer <your token>. Please keep in mind that we provide API access according to our Pricing Plans. Therefore, we ask you to familiarize yourself with our tariff plans and their capabilities. After registration, you automatically have access to a Free tariff plan. Below you can find the available API methods.

Example of API Request in Python

import requests\nheaders = {\"Authorization\": \"Bearer Token\"} # instead of a Token, your valid token received on the site during registration is specified\nrequests.get(\"https://randus.org/api/person\", headers=headers).json()\n

Support

If you have any technical questions, you can open a ticket in your Personal Account on our website.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8649158","collectionId":"e2010052-c5fa-4e56-8054-7bea551f145c","publishedId":"SztEYRxL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-05-30T20:46:06.000Z"},"item":[{"name":"Get user data","id":"c81be163-644a-4257-869c-a68e096008cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://randus.org/api/user","description":"

This method allows you to get information about your account, including data about your tariff plan and current limits.

Please pay attention to the fields expired_at, left_requests and bulk_limit. expired_at — date when your plan expires, left_requests — number of remaining daily requests, bulk_limit — maximum value of the count parameter.

This is the main method of our API. It returns a json response with generated data about a random person. Please note that the response contains the fields that are provided by your pricing plan. You can find the available fields for your tariff plan here.

This parameter allows you to select the language of the generated data. All pricing plans have different lists of available languages. You can find this list here.

Available language codes:

en — English
ru — Russian
uk — Ukrainian

You can combine this parameter with others through the & sign.

You can select the fields that should be returned in the json response. You can view the names of available fields using a normal query without using parameters. You can enter the names of the required fields separated by commas. For example, request with the parameter fields=name,gender will return only the name and gender of a random person.

You can combine this parameter with others through the & sign.

You can generate multiple personalities at once within a single request. The maximum value of this parameter is regulated by the parameter bulk_limit, the value of which can be found by the request described in the section «Get user data». Please note that bulk_limit is the maximum value of the count parameter, its valid value is actually determined by the length of the response from the API.

You can combine this parameter with others through the & sign.

Note that this parameter doesn't work with the fileds=neuralPhoto parameter.

This parameter allows you to select the specific gender of the generated random person.

Available gender codes:

0 — male
1 — female

You can combine this parameter with others through the & sign.

Note that this parameter doesn't work with the fileds=neuralPhoto parameter.

You can generate a photo of a random person using neural networks, if this option is provided by your tariff plan. You can check the possibility of using neural networks here.

This method returns a single photo of a person generated by the neural network in base64 format. Below is an example of Python code that decodes binary data obtained using our API:

import requests\nfrom PIL import Image\nfrom io import BytesIO\nfrom base64 import b64decode\nheaders = {\"Authorization\": \"Bearer Token\"} # instead of a Token, your valid token received on the site during registration is specified\ncontent = requests.get(\"https://randus.org/api/person?fields=neuralPhoto\", headers=headers).json()['result'][0]\nwith BytesIO(b64decode(content['neuralPhoto'])) as f:\n    with Image.open(f) as img:\n        img.save('test.jpg')\n\n

You can use this parameter with other fields that are available in your pricing plan.

Note that this parameter doesn't work with the count=count_value and gender=gender_code parameters.

This function is in the beta test, so it may be unstable.

Here is an example of a combined request. You can use different combinations of parameters if they are compatible.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Your Token"}]},"isInherited":true,"source":{"_postman_id":"e2010052-c5fa-4e56-8054-7bea551f145c","id":"e2010052-c5fa-4e56-8054-7bea551f145c","name":"RANDUS.ORG API 2.0 (EN)","type":"collection"}},"urlObject":{"path":["api","person"],"host":["https://randus.org"],"query":[{"key":"lang","value":"lang_code"},{"key":"gender","value":"gender_code"},{"key":"fields","value":"fields_list"},{"key":"count","value":"count_value"}],"variable":[]}},"response":[],"_postman_id":"1cc21b57-535f-40fa-af04-4bc90fd84fc9"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Your Token"}]}},"event":[{"listen":"prerequest","script":{"id":"d6812552-0718-4b38-b4ba-6204a1000989","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6e7fda06-6ae4-4793-b727-3916b7447282","type":"text/javascript","exec":[""]}}],"variable":[{"key":"token","value":"Your Token"},{"key":"site","value":"https://randus.org"},{"key":"lang_code","value":"lang_code"},{"key":"fields","value":"fields_list"},{"key":"count","value":"count_value"},{"key":"gender","value":"gender_code"}]}