Skip to main content

Find Oracles by Category ID

Retrieves a paginated list of oracles associated with a specific category ID.

Request

GET /v2/admin/oracles/categories/{categoryID}

Parameters

NameTypeInDescription
categoryIDstringpathRequired. The ID of the category to retrieve oracles for
pageintegerqueryOptional. Page number (default: 1)
per_pageintegerqueryOptional. Number of items per page (default: 20)

Headers

NameDescription
AuthorizationRequired. Bearer token for authentication

Example

curl --location '{{baseUrl}}/v2/admin/oracles/categories/677ed6e3cc111aea14a3dfb4?page=1&per_page=20' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Response

{
"data": [
{
"id": "677ed6e3cc111aea14a3dfc3",
"category_id": "677ed6e3cc111aea14a3dfb4",
"type": "TEFAS",
"name": "Gümüş Fonu",
"description": "TEFAS Gümüş Fonu",
"integration": {
"codes": [
{
"code": "IOG",
"name": "Gümüş Fonu"
},
{
"code": "GTZ",
"name": "Gümüş Fonu"
}
]
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"total": 1,
"page": 1,
"per_page": 20
}

Response Fields

Pagination Object

FieldTypeDescription
dataarrayArray of oracle objects
totalintegerTotal number of items
pageintegerCurrent page number
per_pageintegerNumber of items per page

Oracle Object

FieldTypeDescription
idstringUnique ID of the oracle
category_idstringID of the category this oracle belongs to
typestringType of the oracle (e.g., "TEFAS")
namestringName of the oracle
descriptionstringDescription of the oracle
integrationobjectIntegration configuration object
integration.codesarrayArray of integration codes
integration.codes[].codestringIntegration code identifier
integration.codes[].namestringName associated with the integration code
created_atstringOracle creation timestamp (ISO 8601 format)
updated_atstringOracle last update timestamp (ISO 8601 format)

Status Codes

Status CodeDescription
200Success - Oracles retrieved successfully
400Bad Request - Invalid category ID or query parameters
401Unauthorized - Invalid or missing authentication token
404Not Found - Category does not exist
500Internal Server Error