keepsimple logo
en
picВойти
Выйти

UX CORE API

Welcome to the UXCore API documentation! Our API provides a simple and powerful way to access all information available in the UXCore project. In this documentation, you'll find details about the API's endpoints, parameters, and examples to help you get started quickly. The API is free. Still, we open access per request because of some technicalities. For access request or any other questions please contact us at alexanyanwolf@gmail.com


Base URL to get the list of all UX Core biases

https://api.keepsimple.io/v1/uxcore

Parameters

The following parameters can be used to filter and customize the response.
lang

Specify the language of the returned content.

  • Versions: ru, en
  • Default: en

Example: https://api.keepsimple.io/v1/uxcore/?lang=en

field

Specify the fields to be included with bias names.

  • Versions: usage, desc, link, questions
  • Default: []
  • usage: Add usage field
  • desc: Add bias description field
  • link: Add bias wiki URL field
  • questions: Add Bias questions field
Usage example

Retrieve the list of UX Core biases including all their properties

Copy code

Base URL to get one UX Core bias

https://api.keepsimple.io/v1/uxcore/:ID

Parameters

The following parameters can be used to filter and customize the response.
lang

Specify the language of the returned content.

  • Versions: ru, en
  • Default: en

Example: https://api.keepsimple.io/v1/uxcore/:ID?lang=ru

field

Specify the fields to be included with bias names.

  • Versions: usage, desc, link, questions
  • Default: []
  • usage: Add usage field
  • desc: Add bias description field
  • link: Add bias wiki URL field
  • questions: Add Bias questions field
Usage example

Retrieve 6th bias with its wiki URL

Copy code

Base URL to get the list of all UX Core Guide (UXCG) Questions

https://api.keepsimple.io/v1/uxcg

Parameters

The following parameters can be used to filter and customize the response.
lang

Specify the language of the returned content.

  • Versions: ru, en
  • Default: en

Example: https://api.keepsimple.io/v1/uxcg/?lang=ru

answers

Specify the number of answers for each returned question.

  • default: 0 (all)

Example: https://api.keepsimple.io/v1/uxcg?answers=7

related_questions

Specify the number of related questions for each returned question

  • default: 0 (all)

Example: https://api.keepsimple.io/v1/uxcg?related_questions=10

Usage example

Retrieve all UXCG questions in Russian, with 3 answers for each. Also include 2 related questions for each

Copy code

Base URL to get the list of one UX Core Guide (UXCG) Question

https://api.keepsimple.io/v1/uxcg/:ID

Parameters

The following parameters can be used to filter and customize the response.
lang

Specify the language of the returned content.

  • Versions: ru, en
  • Default: en

Example: https://api.keepsimple.io/v1/uxcg/:ID?lang=ru

answers

Specify the number of answers for each returned question.

  • default: 0 (all)

Example: https://api.keepsimple.io/v1/uxcg/:ID?answers=7

related_questions

Specify the number of related questions for each returned question

  • default: 0 (all)

Example: https://api.keepsimple.io/v1/uxcg?related_questions=10

Usage example

Retrieve UXCG question #15 in English, with all available answers and 2 related questions

Copy code
Проект запущен: 15.05.2023
Be Kind. Do Good.