Programming languages API (1.0.0)

Download OpenAPI specification:Download

This page describes how to consume the API following the REST API standard. You need an HTTP client to query the endpoints.

You can use: Postman, Insomnia, Hoppscotch

Or whatever client you are comfortable with.

Data Pagination

For each response returned, only thirty items will be inside the body. You will also have metadata that will help you query the following data.

Rate Limiting

There is a maximum number of calls you can make on every endpoint during a specific interval. In a window of fifteen minutes, you can make one hundred requests on any endpoints.

API request logging

When sending a request to the API, the information about it is stored to process some analytics. Here are the data stored: the path, the IP address, the response status and the execution time.

Disable request logging

For some reason, if you don't want your request to be logged, you can disable it by adding a custom header when sending your request.

  • Header name: x-client-origin
  • Header value: brwsr

Year Group

Retrieve all years groups

query Parameters
countLanguage
any

Indicate if we want to include the number of languages for each year group

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieve a year's group

path Parameters
id
required
any

ID of the year's group to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "612103bb20aaf1e4d5e84bd4",
  • "name": "2020s",
  • "position": 1
}

Author

Retrieve authors with pagination

query Parameters
page
integer >= 1
Example: page=5

Page's number of items to retrieve

search
string non-empty
Example: search=java

Search items containing this keyword

author (string) <field1,field2,...,fieldn>
Example: fields=id,name,picture

Select specific fields to return in the response

Responses

Response samples

Content type
application/json
{}

Retrieve all authors

query Parameters
author (string) <field1,field2,...,fieldn>
Example: fields=id,name,picture

Select specific fields to return in the response

Responses

Response samples

Content type
application/json
{}

Retrieve an author

path Parameters
id
required
any
Example: 612103be20aaf1e4d5e85641

ID of the author to retrieve

Responses

Response samples

Content type
application/json
{}

Language

Retrieve languages with pagination

query Parameters
page
integer >= 1
Example: page=5

Page's number of items to retrieve

search
string non-empty
Example: search=java

Search items containing this keyword

author (string) <field1,field2,...,fieldn>
Example: fields=id,name,company,authors

Select specific fields to return in the response

yearGroup
string
Example: yearGroup=2000s

Name of a year's group

Responses

Response samples

Content type
application/json
{}

Retrieve all languages

query Parameters
author (string) <field1,field2,...,fieldn>
Example: fields=id,name,company,authors

Select specific fields to return in the response

Responses

Response samples

Content type
application/json
{}

Retrieve a language

path Parameters
id
required
any
Example: java

ID of the language to retrieve

Responses

Response samples

Content type
application/json
{}