UK Share Allotments
UK companies that just issued new shares, often before a funding round is announced.
0 rows in the dataset
Download the dataset
Get every row this scraper has collected as one CSV or JSONL file. If the data is older than maxAgeHours, the scraper is re-run with its configured settings first. The key needs the datasets:export scope.
DOWNLOAD_ID=$(curl -s -X POST "https://api.pandorlabs.com/v1/datasets/uk-share-allotments/downloads" \ -H "Authorization: Bearer $PANDORLABS_KEY" \ -H "Content-Type: application/json" \ -d '{"maxAgeHours":24,"format":"csv"}' | jq -r '.id')while true; do STATUS=$(curl -s "https://api.pandorlabs.com/v1/downloads/$DOWNLOAD_ID" \ -H "Authorization: Bearer $PANDORLABS_KEY" | jq -r '.status') [ "$STATUS" != "refreshing" ] && break sleep 5donecurl -s "https://api.pandorlabs.com/v1/downloads/$DOWNLOAD_ID/file" \ -H "Authorization: Bearer $PANDORLABS_KEY" \ -o dataset.csvThe rate is 1 credit per 100 rows cached and 2 credits live, charged on the rows in the dataset when the download becomes ready. A failed refresh is not charged. The file stays downloadable for 24 hours. See pricing.
Start a run
To choose the targets yourself, send the parameters below as input. The call returns 202 with the run; the key needs the scrapers:run scope and the account a positive credit balance.
curl -X POST "https://api.pandorlabs.com/v1/scrapers/uk-share-allotments/runs" \ -H "Authorization: Bearer $PANDORLABS_KEY" \ -H "Content-Type: application/json" \ -d '{ "input": { "descriptions": [ "capital-allotment-shares", "capital-statement-capital-shares-allotment" ], "maxRecords": 500, "maxDurationSeconds": 180, "enrichCompanies": true } }'A run is billed at the live rate once it finishes: 2 credits per 100 rows it collected. A run that collects nothing costs nothing.
Parameters
Every parameter is optional. Anything you leave out uses the default shown here; an unknown name or an invalid value is rejected with a 400 that lists each problem.
Targeting
descriptionsenum[]
Filing types
The SH01 is the return a company must file within a month of allotting shares — what a funding round looks like on the register. Cancellations and buybacks are deliberately not offered: that is money leaving.
- Default
["capital-allotment-shares","capital-statement-capital-shares-allotment"]- Allowed values
capital-allotment-sharescapital-statement-capital-shares-allotmentcapital-statement-capitalresolution-resolution-class-of-share
maxRecordsnumber
Max allotments per run
The stream never ends, so a run stops on whichever of this and the duration limit comes first.
- Default
500- Range
- 1 to 50000
maxDurationSecondsnumber
Max run duration (seconds)
A quiet stream can go minutes between allotments, so this is usually what ends a run rather than the record ceiling.
- Default
180- Range
- 10 to 3600
enrichCompaniesboolean
Fetch company profiles
The stream event carries a company number but no name. Enrichment adds the name, status, SIC codes, incorporation date and registered address — one REST request per company, and it needs the REST key.
- Default
true
sicPrefixesstring[]
SIC code prefixes
Requires enrichment. Empty means every trade. Software and media: 62, 63, 58, 73, 70. Note that SIC codes are declared at incorporation and rarely updated, so this screen loses real companies.
- Default
- none
- Example
62, 63, 58
incorporatedAfterYearnumber
Incorporated after (year)
Requires enrichment. Zero means no limit.
- Default
0- Range
- 0 to 2200
Advanced
fromTimepointnumber
Resume from timepoint
Zero resumes from the highest timepoint already stored, and from the live edge of the stream if the collection is empty. Set a value only to replay a known point.
- Default
0- Range
- at least 0
requestDelayMsnumber
Delay between enrichment requests (ms)
The REST API allows 600 requests per five minutes. This paces the enrichment calls; the stream itself is not rate limited.
- Default
120- Range
- 0 to 30000
streamKeystring
Streaming key override
Defaults to COMPANIES_HOUSE_STREAM_KEY. A streaming application key is a different key from the REST one.
- Default
- none
restKeystring
REST key override
Defaults to COMPANIES_HOUSE_API_KEY. Used only for company-profile enrichment.
- Default
- none
Input as JSON Schema
The same schema the API validates against. Use it as a tool input schema or to generate a typed client.
{ "type": "object", "additionalProperties": false, "properties": { "descriptions": { "type": "array", "items": { "type": "string", "enum": [ "capital-allotment-shares", "capital-statement-capital-shares-allotment", "capital-statement-capital", "resolution-resolution-class-of-share" ] }, "uniqueItems": true, "title": "Filing types", "description": "The SH01 is the return a company must file within a month of allotting shares — what a funding round looks like on the register. Cancellations and buybacks are deliberately not offered: that is money leaving.", "default": [ "capital-allotment-shares", "capital-statement-capital-shares-allotment" ] }, "maxRecords": { "type": "number", "minimum": 1, "maximum": 50000, "title": "Max allotments per run", "description": "The stream never ends, so a run stops on whichever of this and the duration limit comes first.", "default": 500 }, "maxDurationSeconds": { "type": "number", "minimum": 10, "maximum": 3600, "title": "Max run duration (seconds)", "description": "A quiet stream can go minutes between allotments, so this is usually what ends a run rather than the record ceiling.", "default": 180 }, "enrichCompanies": { "type": "boolean", "title": "Fetch company profiles", "description": "The stream event carries a company number but no name. Enrichment adds the name, status, SIC codes, incorporation date and registered address — one REST request per company, and it needs the REST key.", "default": true }, "sicPrefixes": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "title": "SIC code prefixes", "description": "Requires enrichment. Empty means every trade. Software and media: 62, 63, 58, 73, 70. Note that SIC codes are declared at incorporation and rarely updated, so this screen loses real companies.", "default": [], "examples": [ "62, 63, 58" ] }, "incorporatedAfterYear": { "type": "number", "minimum": 0, "maximum": 2200, "title": "Incorporated after (year)", "description": "Requires enrichment. Zero means no limit.", "default": 0 }, "fromTimepoint": { "type": "number", "minimum": 0, "title": "Resume from timepoint", "description": "Zero resumes from the highest timepoint already stored, and from the live edge of the stream if the collection is empty. Set a value only to replay a known point.", "default": 0 }, "requestDelayMs": { "type": "number", "minimum": 0, "maximum": 30000, "title": "Delay between enrichment requests (ms)", "description": "The REST API allows 600 requests per five minutes. This paces the enrichment calls; the stream itself is not rate limited.", "default": 120 }, "streamKey": { "type": "string", "maxLength": 2000, "title": "Streaming key override", "description": "Defaults to COMPANIES_HOUSE_STREAM_KEY. A streaming application key is a different key from the REST one." }, "restKey": { "type": "string", "maxLength": 2000, "title": "REST key override", "description": "Defaults to COMPANIES_HOUSE_API_KEY. Used only for company-profile enrichment." } }}Run, poll, read rows
The run is asynchronous. Poll it until it reaches a terminal status and its billing is paid, then page through its rows. Until then the rows endpoint answers 409 (still queued or running) or 402 (payment required).
RUN_ID=$(curl -s -X POST "https://api.pandorlabs.com/v1/scrapers/uk-share-allotments/runs" \ -H "Authorization: Bearer $PANDORLABS_KEY" \ -H "Content-Type: application/json" \ -d '{ "input": { "descriptions": [ "capital-allotment-shares", "capital-statement-capital-shares-allotment" ], "maxRecords": 500, "maxDurationSeconds": 180, "enrichCompanies": true } }' | jq -r '.id')while true; do RUN=$(curl -s "https://api.pandorlabs.com/v1/runs/$RUN_ID" \ -H "Authorization: Bearer $PANDORLABS_KEY") STATUS=$(echo "$RUN" | jq -r '.status') BILLING=$(echo "$RUN" | jq -r '.billing.status') case "$STATUS" in queued|running) ;; *) [ "$BILLING" != "pending" ] && break ;; esac sleep 5doneecho "$RUN" | jq '{status, rowCount, billing}'curl -s "https://api.pandorlabs.com/v1/runs/$RUN_ID/rows?page=1&limit=100" \ -H "Authorization: Bearer $PANDORLABS_KEY"See the API reference for pagination, cancelling and listing runs.
Output fields
Rows have no fixed schema; these are the fields observed in the rows collected so far. Coverage is the share of rows where the field is present.
No rows collected yet, so no fields have been observed. Run the scraper once and they will appear here.
