Stream Records - Dokumentacja MGBI API

Pobiera rekordy z informacjami o dokumentach z Repozytorium Dokumentów Finansowych Krajowego Rejestru Sądowego (KRS RDF) spełniające podane kryteria w postaci strumienia danych.

W przypadku sukcesu w odpowiedzi zwraca listę rekordów posortowaną malejąco według daty publikacji dokumentów.

W przypadku braku rekordów spełniających podane kryteria zwraca pustą listę.

Poprawne wywołanie endpointu zwiększa liczniki:

api i api_search o 1

records i records_api_search o liczbę zwróconych rekordów

curl --location --request GET 'https://api.mgbi.pl/v1/models/pl-krs-rdf-record/stream?media_type=&last_update_datetime_from=&last_update_from_datetime=&last_update_datetime_to=&last_update_to_datetime=&type=&identifiers.pl_krs=&identifiers.pl_nip=&identifiers.pl_regon=&period_from_date=&period_to_date=&period_end_year=&period_major_year=&is_correction=&is_ias_compliant=&projection=&content=' \ --header 'Authorization;'

{ "id": "666cca1fccafd64563cf9f9b", "identifiers": { "pl_krs": "0000203107", "pl_nip": "9111852372", "pl_regon": "932989096" }, "document": { "type": "balance_sheet", "filing_date": "2018-05-25", "period_from_date": "2017-01-01", "period_to_date": "2017-12-31", "period_end_year": 2017, "period_major_year": 2017, "is_correction": false, "is_ias_compliant": false, "language": "pl", "document_id": 157269, "submission_id": 43509 }, "files": { "main_document": { "original": { "url": "https://api.mgbi.pl/v1/models/pl-krs-rdf-record/records/666cca1fccafd64563cf9f9b/files/main_document_uri", "content_type": "application/pdf" }, "pdf_preview": { "url": "https://api.mgbi.pl/v1/models/pl-krs-rdf-record/records/666cca1fccafd64563cf9f9b/files/main_document_uri:pdf", "content_type": "application/pdf" }, "html_preview": { "url": "https://api.mgbi.pl/v1/models/pl-krs-rdf-record/records/666cca1fccafd64563cf9f9b/files/main_document_uri:html", "content_type": "text/html" } } }, "meta": { "first_update_datetime": "2024-06-14T22:18:55.572000", "last_update_datetime": "2024-06-14T22:18:55.572000", "source_record_id": 157269 } }

Request

Query Params

media_type

enum<string>

optional

Format zwracanej listy

Allowed values:

jsonndjson

last_update_datetime_from

string <date-time>

optional

Data i czas ostatniej aktualizacji od

last_update_from_datetime

string <date-time>

deprecated

Data i czas ostatniej aktualizacji od

last_update_datetime_to

string <date-time>

optional

Data i czas ostatniej aktualizacji do

last_update_to_datetime

string <date-time>

deprecated

Data i czas ostatniej aktualizacji do

type

enum<string>

optional

Rodzaj dokumentu

Allowed values:

financial_statementbalance_sheetfootnotescash_flow_statementprofit_and_loss_statementequity_statementresolution_on_approvalactivity_reportauditors_opinionconsolidated_financial_statementconsolidated_footnotesconsolidated_balance_sheetconsolidated_cash_flow_statementconsolidated_profit_and_loss_statementconsolidated_equity_statementconsolidated_resolution_on_approvalparent_activity_reportconsolidated_and_parent_activity_reportconsolidated_auditors_opinionresolution_on_profit_distributionreport_on_paymentsconsolidated_report_on_paymentssustainability_report_assurance_statementsustainability_report_of_parent_entity_from_outside_eea

identifiers.pl_krs

string

optional

Numer KRS

Match pattern:

^\d{10}$

identifiers.pl_nip

string

optional

Numer NIP

Match pattern:

^\d{10}$

identifiers.pl_regon

string

optional

Numer REGON

Match pattern:

^\d{9}$

period_from_date

string <date>

optional

Data początkowa okresu, którego dotyczy dokument

period_to_date

string <date>

optional

Data końcowa okresu, którego dotyczy dokument

period_end_year

integer

optional

Rok z daty końcowej okresu, którego dotyczy dokument

period_major_year

integer

optional

Rok przeważającej części okresu, którego dotyczy dokument

is_correction

boolean

optional

Informacja, czy dokument jest korektą

is_ias_compliant

boolean

optional

Informacja, czy dokument został sporządzony zgodnie z Międzynarodowymi Standardami Rachunkowości

projection

string

optional

Nazwa projekcji

content

array[string]

optional

Lista zwracanych pól z modelu danych

Header Params

Authorization

string

optional

Klucz autoryzacji

Example:

aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Responses

🟢200Success

application/json

Lista rekordów

Body

array of:

string

required

Identyfikator rekordu

identifiers

object

required

Identyfikatory podmiotu

pl_krs

string

required

Numer KRS

pl_nip

string

required

Numer NIP

pl_regon

string

required

Numer REGON

document

object

required

Informacje o dokumencie

type

enum<string>

required

Rodzaj dokumentu

Allowed values:

filing_date

string

required

Data publikacji dokumentu w RDF

preparation_date

string

required

Data sporządzenia dokumentu

period_from_date

string

required

Data początkowa okresu, którego dotyczy dokument

period_to_date

string

required

Data końcowa okresu, którego dotyczy dokument

period_end_year

string

required

Rok z daty końcowej okresu, którego dotyczy dokument

period_major_year

string

required

Rok przeważającej części okresu, którego dotyczy dokument

is_correction

string

required

Informacja, czy dokument jest korektą

is_ias_compliant

string

required

Informacja, czy dokument został sporządzony zgodnie z Międzynarodowymi Standardami Rachunkowości

language

string

required

Język, w którym sporządzono dokument (dwuliterowy kod języka ISO 639-1)

document_id

string

required

Identyfikator dokumentu w RDF

submission_id

string

required

Wewnętrzny identyfikator zgłoszenia w RDF

content

object

required

Treść dokumentu

extracted_fields

object

required

Pola z danymi odczytanymi ze sprawozdania w formacie XML (skontaktuj się z nami, aby uzyskać pełną listę pól)

standardized_fields

object

required

Ustandaryzowane pola z danymi finansowymi

schema

object

required

Informacje o schemie XML użytej w dokumencie

files

object

required

Pliki dokumentu

main_document

object

required

Główny dokument