BREAGEN Logo
List Management

Fetcher Management

Fetcher Operations provide management of data fetchers, including adding new fetchers, filtering existing fetchers, and performing indexing operations.

Fetcher - Add Fetcher POST /v1/api/fetcher/add

Resource URL/v1/api/fetcher/add
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'POST' \
'https://lm-gen-1.braegen.ai/v1/api/fetcher/add' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "fetcher_name": "eu_sanctions",
    "display_name": "EU Sanctions List",
    "fetcher_url": "https://api.braegen.ai/eu-sanctions",
    "fetcher_type": 1,
    "jurisdictions": [
        {
            "country_code": "EU",
            "country_name": "European Union"
        }
    ],
    "list_types": [
        {
            "list_type_name": "SANCTIONS",
            "display_name": "Sanctions List"
        }
    ]
}'

Example Response

{
	"is_error": false,
	"message": "Fetcher added successfully",
	"results": {
		"id": 1,
		"fetcher_name": "eu_sanctions",
		"display_name": "EU Sanctions List",
		"fetcher_url": "https://api.braegen.ai/eu-sanctions",
		"fetcher_type": 1,
		"create_datetime": "2024-06-12T08:15:30",
		"jurisdictions": [
			{
				"country_code": "EU",
				"country_name": "European Union"
			}
		],
		"list_types": [
			{
				"list_type_name": "SANCTIONS",
				"display_name": "Sanctions List"
			}
		]
	}
}

HTTP Responses

HTTP CodeMessage
200Success
400Bad Request
401Unauthorized
403Invalid Input
404Invalid or not found type

Fetcher - Filter Fetcher GET /v1/api/fetcher/filter_fetcher

Resource URL/v1/api/fetcher/filter_fetcher
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescriptionRequired
fetcher_nameName of the fetcher to filter (optional)No

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/fetcher/filter_fetcher?fetcher_name=eu_sanctions' \
-H 'accept: application/json'

Example Response

{
	"is_error": false,
	"message": "Fetchers retrieved successfully",
	"results": [
		{
			"id": 1,
			"fetcher_name": "eu_sanctions",
			"display_name": "EU Sanctions List",
			"fetcher_url": "https://api.braegen.ai/eu-sanctions",
			"fetcher_type": 1,
			"create_datetime": "2024-06-12T08:15:30",
			"jurisdictions": [
				{
					"country_code": "EU",
					"country_name": "European Union"
				}
			],
			"list_types": [
				{
					"list_type_name": "SANCTIONS",
					"display_name": "Sanctions List"
				}
			]
		}
	]
}

HTTP Responses

HTTP CodeMessage
200Success
400Bad Request
401Unauthorized
403Invalid Input
404Invalid or not found type

Fetcher - Open Sanction Indexing POST /v1/api/fetcher/open_sanction_indexing

Resource URL/v1/api/fetcher/open_sanction_indexing
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

This endpoint triggers the indexing process for open sanctions data.

Example Request

curl -X 'POST' \
'https://lm-gen-1.braegen.ai/v1/api/fetcher/open_sanction_indexing' \
-H 'accept: application/json'

Example Response

{
	"is_error": false,
	"message": "Indexing process started successfully",
	"results": {
		"job_id": "idx_123456",
		"status": "started",
		"timestamp": "2024-06-12T08:20:15"
	}
}

HTTP Responses

HTTP CodeMessage
200Success
400Bad Request
401Unauthorized
403Invalid Input
404Invalid or not found type

Common Response Codes for All Fetcher Endpoints

Each Fetcher endpoint returns standard HTTP response codes:

HTTP CodeMessageDescription
200SuccessRequest processed successfully
204No ContentRequest successful but no content returned
400Bad RequestInvalid parameters or request format
401UnauthorizedMissing or invalid authentication credentials
403Invalid InputRequest parameters failed validation
404Invalid or not found typeRequested resource not found
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer encountered an unexpected condition

Previous

Visual Link Analysis

Next

List Data Management

On this page