List topics

GET 
/topics

Returns all topics that match the filters. You can use the name filter to search for topics by name.

Topics are sorted by name, in ascending order.

Cost: 1 credit per call.

Request

Query Parameters

name string
Possible values: non-empty
The name of the topic wanted.
This parameter is case-insensitive.
Example: bitcoin
paginationCursor string

An opaque string representing the pagination cursor.

limit int32

Possible values: >= 1 and <= 100

Default value: 10

The maximum number of objects returned per page.

Header Parameters

X-Exorde-Api-Version stringrequired

Possible values: [v1]

The API version.

Responses

200

Expected response to a valid request

application/json

Schema

Schema

items object[]required
Possible values: <= 100
An array of Topic ressources.
Array [
id int32required
Possible values: >= 1 and <= 2147483647
The topic ID.
name stringrequired
The topic name.
categories object[]required
Possible values: >= 1
The list of categories associated to the topic.
Array [
id int32required
Possible values: >= 1 and <= 2147483647
The category ID.
name stringrequired
The category name.
]
keywords object[]required
Possible values: >= 1
The list of keywords associated to the topic.
Array [
label stringrequired
The keyword label.
language stringrequired
Possible values: [en, zh, ja, ar, hi, ko, th, vi, ru, tr, es, fr, de, fa]
The keyword language.
]
]
pagination object

self uri

Pagination link|cursor pointing to the current page.

prev uri

Pagination link|cursor pointing to the previous page.

This link is not present if there is no previous page.

next uri

Pagination link|cursor pointing to the next page.

This link is not present if there is no next page.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "items": [
    {
      "id": 0,
      "name": "string",
      "categories": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "keywords": [
        {
          "label": "string",
          "language": "en"
        }
      ]
    }
  ],
  "pagination": {
    "self": "string",
    "prev": "string",
    "next": "string"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

429

Too Many Requests

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

Example (from schema)

{
  "requestId": "123e4567-e89b-12d3-a456-426655440000"
}

503

Service Unavailable

Loading...