Crawling

Server

Crawler sources, runs and results.

Get a crawl result

GET

https://api.cineamo.com

/crawl-results/{crawlResultId}

Returns a CrawlResult object by its Id.

Get a crawl result › path Parameters

crawlResultId

integer · required

Get a crawl result › Responses

CrawlResult details

CrawlResult

id

integer | null · readOnly

crawlRunId

integer | null · readOnly

cinemaId

integer · readOnly

adapterId

string · readOnly

status

string · readOnly

crawlerSourceId

integer | null · readOnly

showtimeCount

integer | null · readOnly

rawCount

integer | null · readOnly

skippedCount

integer | null · readOnly

durationMs

integer | null · readOnly

errorMessage

string | null · readOnly

skippedReasons

object | null · readOnly

createdDatetime

string | null · readOnly

List crawl run crawl results

GET

https://api.cineamo.com

/crawl-runs/{runId}/crawl-results

Returns a list of CrawlResult objects for a specific CrawlRun.

List crawl run crawl results › path Parameters

runId

string · required

List crawl run crawl results › query Parameters

page

integer

perPage

integer

sort

string

order

string

statuses

string[]

adapterIds

string[]

List crawl run crawl results › Responses

CrawlResult list for crawl run

CrawlResult[]

CrawlResult

id

integer | null · readOnly

crawlRunId

integer | null · readOnly

cinemaId

integer · readOnly

adapterId

string · readOnly

status

string · readOnly

crawlerSourceId

integer | null · readOnly

showtimeCount

integer | null · readOnly

rawCount

integer | null · readOnly

skippedCount

integer | null · readOnly

durationMs

integer | null · readOnly

errorMessage

string | null · readOnly

skippedReasons

object | null · readOnly

createdDatetime

string | null · readOnly

List crawl runs

GET

https://api.cineamo.com

/crawl-runs

Returns a paginated list of CrawlRun objects.

List crawl runs › query Parameters

page

integer

perPage

integer

sort

string

order

string

statuses

string[]

triggerTypes

string[]

List crawl runs › Responses

CrawlRun list

CrawlRun

id

integer | null · readOnly

runId

string · readOnly

status

string · readOnly

startedAt

string | null · readOnly

finishedAt

string | null · readOnly

sourceCount

integer | null · readOnly

successCount

integer | null · readOnly

failureCount

integer | null · readOnly

totalShowtimeCount

integer | null · readOnly

durationMs

integer | null · readOnly

triggerType

string · readOnly

initiatorId

integer | null · readOnly

errorSummary

object | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Create a crawl run

POST

https://api.cineamo.com

/crawl-runs

Creates a new CrawlRun. It returns the created CrawlRun object.

Create a crawl run › Request Body

CrawlRun

id

integer | null · readOnly

runId

string · readOnly

status

string · readOnly

startedAt

string | null · readOnly

finishedAt

string | null · readOnly

sourceCount

integer | null · readOnly

successCount

integer | null · readOnly

failureCount

integer | null · readOnly

totalShowtimeCount

integer | null · readOnly

durationMs

integer | null · readOnly

triggerType

string · readOnly

initiatorId

integer | null · readOnly

errorSummary

object | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Create a crawl run › Responses

CrawlRun was created

CrawlRun

id

integer | null · readOnly

runId

string · readOnly

status

string · readOnly

startedAt

string | null · readOnly

finishedAt

string | null · readOnly

sourceCount

integer | null · readOnly

successCount

integer | null · readOnly

failureCount

integer | null · readOnly

totalShowtimeCount

integer | null · readOnly

durationMs

integer | null · readOnly

triggerType

string · readOnly

initiatorId

integer | null · readOnly

errorSummary

object | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

POST/crawl-runs

curl https://api.cineamo.com/crawl-runs \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "startedAt": "2026-04-11T04:11:22Z",
  "finishedAt": "2026-04-11T04:11:22Z",
  "sourceCount": 100,
  "successCount": 95,
  "failureCount": 5,
  "totalShowtimeCount": 1500,
  "durationMs": 45000,
  "triggerType": "schedule",
  "initiatorId": 42,
  "errorSummary": {},
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "startedAt": "2026-04-11T04:11:22Z",
  "finishedAt": "2026-04-11T04:11:22Z",
  "sourceCount": 100,
  "successCount": 95,
  "failureCount": 5,
  "totalShowtimeCount": 1500,
  "durationMs": 45000,
  "triggerType": "schedule",
  "initiatorId": 42,
  "errorSummary": {},
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "startedAt": "2026-04-11T04:11:22Z",
  "finishedAt": "2026-04-11T04:11:22Z",
  "sourceCount": 100,
  "successCount": 95,
  "failureCount": 5,
  "totalShowtimeCount": 1500,
  "durationMs": 45000,
  "triggerType": "schedule",
  "initiatorId": 42,
  "errorSummary": {},
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

application/json

Get a crawl run by run ID

GET

https://api.cineamo.com

/crawl-runs/{runId}

Returns a CrawlRun object by its UUID runId.

Get a crawl run by run ID › path Parameters

runId

string · required

Get a crawl run by run ID › Responses

CrawlRun details

CrawlRun

id

integer | null · readOnly

runId

string · readOnly

status

string · readOnly

startedAt

string | null · readOnly

finishedAt

string | null · readOnly

sourceCount

integer | null · readOnly

successCount

integer | null · readOnly

failureCount

integer | null · readOnly

totalShowtimeCount

integer | null · readOnly

durationMs

integer | null · readOnly

triggerType

string · readOnly

initiatorId

integer | null · readOnly

errorSummary

object | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Update a crawl run by run ID

PATCH

https://api.cineamo.com

/crawl-runs/{runId}

Updates a CrawlRun.

Update a crawl run by run ID › path Parameters

runId

string · required

Update a crawl run by run ID › Request Body

CrawlRun

id

integer | null · readOnly

runId

string · readOnly

status

string · readOnly

startedAt

string | null · readOnly

finishedAt

string | null · readOnly

sourceCount

integer | null · readOnly

successCount

integer | null · readOnly

failureCount

integer | null · readOnly

totalShowtimeCount

integer | null · readOnly

durationMs

integer | null · readOnly

triggerType

string · readOnly

initiatorId

integer | null · readOnly

errorSummary

object | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Update a crawl run by run ID › Responses

CrawlRun was updated

CrawlRun

id

integer | null · readOnly

runId

string · readOnly

status

string · readOnly

startedAt

string | null · readOnly

finishedAt

string | null · readOnly

sourceCount

integer | null · readOnly

successCount

integer | null · readOnly

failureCount

integer | null · readOnly

totalShowtimeCount

integer | null · readOnly

durationMs

integer | null · readOnly

triggerType

string · readOnly

initiatorId

integer | null · readOnly

errorSummary

object | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

PATCH/crawl-runs/{runId}

curl https://api.cineamo.com/crawl-runs/:runId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "startedAt": "2026-04-11T04:11:22Z",
  "finishedAt": "2026-04-11T04:11:22Z",
  "sourceCount": 100,
  "successCount": 95,
  "failureCount": 5,
  "totalShowtimeCount": 1500,
  "durationMs": 45000,
  "triggerType": "schedule",
  "initiatorId": 42,
  "errorSummary": {},
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "startedAt": "2026-04-11T04:11:22Z",
  "finishedAt": "2026-04-11T04:11:22Z",
  "sourceCount": 100,
  "successCount": 95,
  "failureCount": 5,
  "totalShowtimeCount": 1500,
  "durationMs": 45000,
  "triggerType": "schedule",
  "initiatorId": 42,
  "errorSummary": {},
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "startedAt": "2026-04-11T04:11:22Z",
  "finishedAt": "2026-04-11T04:11:22Z",
  "sourceCount": 100,
  "successCount": 95,
  "failureCount": 5,
  "totalShowtimeCount": 1500,
  "durationMs": 45000,
  "triggerType": "schedule",
  "initiatorId": 42,
  "errorSummary": {},
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

application/json

List crawler sources

GET

https://api.cineamo.com

/cinemas/{cinemaId}/crawler-sources

Returns a list of CrawlerSource objects for a cinema.

List crawler sources › path Parameters

cinemaId

integer · required

List crawler sources › query Parameters

page

integer

perPage

integer

sort

string

order

string

cinemaSiteId

integer

adapterId

string

isEnabled

boolean

List crawler sources › Responses

CrawlerSource list

CrawlerSource

id

integer · readOnly

cinemaId

integer · readOnly

cinemaName

string · readOnly

cinemaSiteId

integer | null · readOnly

cinemaSiteName

string | null · readOnly

adapterId

string · readOnly

sourceUrl

string · readOnly

sourceConfig

object | null · readOnly

isEnabled

boolean · readOnly

timezone

string · readOnly

locale

string | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Create a crawler source

POST

https://api.cineamo.com

/cinemas/{cinemaId}/crawler-sources

Creates a CrawlerSource. It returns the CrawlerSource object.

Create a crawler source › path Parameters

cinemaId

integer · required

Create a crawler source › Request Body

CrawlerSource

id

integer · readOnly

cinemaId

integer · readOnly

cinemaName

string · readOnly

cinemaSiteId

integer | null · readOnly

cinemaSiteName

string | null · readOnly

adapterId

string · readOnly

sourceUrl

string · readOnly

sourceConfig

object | null · readOnly

isEnabled

boolean · readOnly

timezone

string · readOnly

locale

string | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Create a crawler source › Responses

CrawlerSource was created

CrawlerSource

id

integer · readOnly

cinemaId

integer · readOnly

cinemaName

string · readOnly

cinemaSiteId

integer | null · readOnly

cinemaSiteName

string | null · readOnly

adapterId

string · readOnly

sourceUrl

string · readOnly

sourceConfig

object | null · readOnly

isEnabled

boolean · readOnly

timezone

string · readOnly

locale

string | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

POST/cinemas/{cinemaId}/crawler-sources

curl https://api.cineamo.com/cinemas/:cinemaId/crawler-sources \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaId": 42,
  "cinemaName": "CineStar Berlin",
  "cinemaSiteId": 7,
  "cinemaSiteName": "CineStar Berlin Hauptbahnhof",
  "adapterId": "cineweb",
  "sourceUrl": "https://example.com/showtimes",
  "sourceConfig": {},
  "isEnabled": true,
  "timezone": "Europe/Berlin",
  "locale": "de",
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "cinemaId": 42,
  "cinemaName": "CineStar Berlin",
  "cinemaSiteId": 7,
  "cinemaSiteName": "CineStar Berlin Hauptbahnhof",
  "adapterId": "cineweb",
  "sourceUrl": "https://example.com/showtimes",
  "sourceConfig": {},
  "isEnabled": true,
  "timezone": "Europe/Berlin",
  "locale": "de",
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "cinemaId": 42,
  "cinemaName": "CineStar Berlin",
  "cinemaSiteId": 7,
  "cinemaSiteName": "CineStar Berlin Hauptbahnhof",
  "adapterId": "cineweb",
  "sourceUrl": "https://example.com/showtimes",
  "sourceConfig": {},
  "isEnabled": true,
  "timezone": "Europe/Berlin",
  "locale": "de",
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

application/json

Get a crawler source

GET

https://api.cineamo.com

/cinemas/{cinemaId}/crawler-sources/{crawlerSourceId}

Returns a CrawlerSource object by its Id.

Get a crawler source › path Parameters

cinemaId

integer · required

crawlerSourceId

integer · required

Get a crawler source › Responses

CrawlerSource details

CrawlerSource

id

integer · readOnly

cinemaId

integer · readOnly

cinemaName

string · readOnly

cinemaSiteId

integer | null · readOnly

cinemaSiteName

string | null · readOnly

adapterId

string · readOnly

sourceUrl

string · readOnly

sourceConfig

object | null · readOnly

isEnabled

boolean · readOnly

timezone

string · readOnly

locale

string | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Delete a crawler source

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/crawler-sources/{crawlerSourceId}

Deletes a CrawlerSource. It returns an empty response.

Delete a crawler source › path Parameters

cinemaId

integer · required

crawlerSourceId

integer · required

Delete a crawler source › Responses

CrawlerSource was deleted

No data returned

Update a crawler source

PATCH

https://api.cineamo.com

/cinemas/{cinemaId}/crawler-sources/{crawlerSourceId}

Updates a CrawlerSource. It returns the updated CrawlerSource object.

Update a crawler source › path Parameters

cinemaId

integer · required

crawlerSourceId

integer · required

Update a crawler source › Request Body

CrawlerSource

id

integer · readOnly

cinemaId

integer · readOnly

cinemaName

string · readOnly

cinemaSiteId

integer | null · readOnly

cinemaSiteName

string | null · readOnly

adapterId

string · readOnly

sourceUrl

string · readOnly

sourceConfig

object | null · readOnly

isEnabled

boolean · readOnly

timezone

string · readOnly

locale

string | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Update a crawler source › Responses

200

CrawlerSource was updated

CrawlerSource

id

integer · readOnly

cinemaId

integer · readOnly

cinemaName

string · readOnly

cinemaSiteId

integer | null · readOnly

cinemaSiteName

string | null · readOnly

adapterId

string · readOnly

sourceUrl

string · readOnly

sourceConfig

object | null · readOnly

isEnabled

boolean · readOnly

timezone

string · readOnly

locale

string | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

PATCH/cinemas/{cinemaId}/crawler-sources/{crawlerSourceId}

curl https://api.cineamo.com/cinemas/:cinemaId/crawler-sources/:crawlerSourceId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaId": 42,
  "cinemaName": "CineStar Berlin",
  "cinemaSiteId": 7,
  "cinemaSiteName": "CineStar Berlin Hauptbahnhof",
  "adapterId": "cineweb",
  "sourceUrl": "https://example.com/showtimes",
  "sourceConfig": {},
  "isEnabled": true,
  "timezone": "Europe/Berlin",
  "locale": "de",
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "cinemaId": 42,
  "cinemaName": "CineStar Berlin",
  "cinemaSiteId": 7,
  "cinemaSiteName": "CineStar Berlin Hauptbahnhof",
  "adapterId": "cineweb",
  "sourceUrl": "https://example.com/showtimes",
  "sourceConfig": {},
  "isEnabled": true,
  "timezone": "Europe/Berlin",
  "locale": "de",
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "cinemaId": 42,
  "cinemaName": "CineStar Berlin",
  "cinemaSiteId": 7,
  "cinemaSiteName": "CineStar Berlin Hauptbahnhof",
  "adapterId": "cineweb",
  "sourceUrl": "https://example.com/showtimes",
  "sourceConfig": {},
  "isEnabled": true,
  "timezone": "Europe/Berlin",
  "locale": "de",
  "createdDatetime": "2026-04-11T04:11:22Z",
  "modifiedDatetime": "2026-04-11T04:11:22Z"
}

json

application/json

List all crawler sources

GET

https://api.cineamo.com

/crawler-sources

Returns all crawler sources (no cinema filter). Used by the dispatcher.

List all crawler sources › query Parameters

page

integer

perPage

integer

sort

string

order

string

cinemaSiteId

integer

adapterId

string

isEnabled

boolean

ticketSystem

string

Restrict to cinemas configured with this ticket system (e.g. showtime_collector).

List all crawler sources › Responses

200

CrawlerSource list

CrawlerSource

id

integer · readOnly

cinemaId

integer · readOnly

cinemaName

string · readOnly

cinemaSiteId

integer | null · readOnly

cinemaSiteName

string | null · readOnly

adapterId

string · readOnly

sourceUrl

string · readOnly

sourceConfig

object | null · readOnly

isEnabled

boolean · readOnly

timezone

string · readOnly

locale

string | null · readOnly

createdDatetime

string | null · readOnly

modifiedDatetime

string | null · readOnly

Assets Images