Download OpenAPI specification:Download
API oparte jest na protokole HTTP, a treść wszystkich żądań i odpowiedzi przekazywana jest w formie obiektów języka JavaScript (JSON).
W nagłówku HTTP Content-Type
każdego żądania API przesyłanego metodą POST
i zawierającego w treści obiekt JSON należy ustawić wartość application/json
.
W żądaniach API przesyłanych metodą GET parametry należy umieścić w query stringu.
Każda metoda API może zwrócić jeden z kilku możliwych kodów odpowiedzi HTTP. Nagłówki i parametry odpowiedzi opisane poniżej dla każdej z metod zwracane są tylko dla kodu 200 (OK).
Interfejs programistyczny serwisu iMSiG.pl umożliwia wyszukiwanie i pobieranie oryginalnej treści ogłoszeń publikowanych w Monitorze Sądowym i Gospodarczym (MSiG) oraz w Krajowym Rejestrze Zadłużonych (KRZ), a także wyodrębnionych z nich danych w ustrukturyzowanej formie.
W obecnej wersji API umożliwia dostęp do ogłoszeń dotyczących postępowań upadłościowych i restrukturyzacyjnych, pochodzących z numerów MSiG wydanych (od 1 stycznia 2001 r.) oraz z KRZ (od 1 grudnia 2021 r.).
Informacje o zasadach korzystania z interfejsu dostępne są na stronie usługi Lista upadłości.
Słowa kluczowe:
Monitor Sądowy i Gospodarczy (MSiG) to oficjalny dziennik urzędowy, w którym publikowane są ogłoszenia sądowe m.in. na podstawie przepisów kodeksu spółek handlowych, kodeksu postępowania cywilnego i prawa upadłościowego. Nowe numery dziennika są udostępniane codziennie w formie plików PDF na stronie Ministerstwa Sprawiedliwości.
Krajowy Rejestr Zadłużonych (KRZ) to system teleinformatyczny Ministerstwa Sprawiedliwości, w którym gromadzone są wszystkie informacje i dokumenty dotyczące przebiegu postępowań upadłościowych i restrukturyzacyjnych prowadzonych przez polskie sądy (od 1 grudnia 2021 r.).
Format pliku, w jakim udostępniany jest Monitor Sądowy i Gospodarczy, nie umożliwia łatwego wyszukiwania ogłoszeń dotyczących poszczególnych osób fizycznych lub podmiotów. Treść ogłoszeń jest nieustrukturyzowana, co uniemożliwia dalsze przetwarzanie zawartych w niej informacji.
Nasz interfejs programistyczny umożliwia przeszukiwanie bazy ogłoszeń opublikowanych w MSiG oraz KRZ na podstawie kilku różnych kryteriów, pobieranie ich oryginalnej wersji w dwóch formatach, a także dostęp do wybranych informacji wyodrębnionych z tekstowej treści.
Aby sprawdzić, jakie ogłoszenia publikowane są w MSiG, przejdź na stronę główną serwisu iMSiG.pl.
Wyszukiwarka ogłoszeń dostępna na stronie Ministerstwa Sprawiedliwości nie jest przeznaczona do masowego dostępu do bazy ogłoszeń. Nie zostało również udostępnione oficjalne API do integracji z systemami teleinformatycznymi.
W ramach naszego interfejsu programistycznego udostępniamy szereg kryteriów do przeszukiwania bazy ogłoszeń dostępnych w systemie KRZ jak i MSiG. Umożliwia to masowe pobieranie dokumentów bez konieczności ręcznego sprawdzania ogłoszeń w dwóch różnych systemach.
Dodatkowo, wszystkie udostępniane przez nas ogłoszenia są uzupełniane o pominięte w publicznym portalu dane doradców restukturyzacyjnych oraz dane rejestrowe podmiotów, których dotyczą ogłoszenia.
Pobiera treść i wyodrębnione informacje z ogłoszeń tekstowych opublikowanych w wybranych rozdziałach MSiG / KRZ.
W przypadku sukcesu w treści odpowiedzi zwracana jest lista ogłoszeń spełniających kryteria określone w parametrach metody, posortowanych rosnąco według daty publikacji w MSiG / KRZ.
W przypadku, gdy żadne ogłoszenie nie spełnia podanych kryteriów, zwracana jest pusta lista.
Zapytanie może zostać wykonane, gdy całkowita liczba zapytań po jego wykonaniu
nie będzie przekraczać wartości api_requests_used
z parametrów usługi.
Dodatkowo, przy wykonywaniu zapytania archiwalnego, sumaryczna liczba ogłoszeń
wygenerowanych w ramach wszystkich stworzonych do tej pory archiwalnych
raportów i zapytań nie może przekroczyć wartości credits_available
z parametrów usługi.
stream | string (Stream) Default: "json" Example: stream=json Czy odpowiedź ma być streamowana/wysyłana 'porcjami' ? Pokaż możliwe opcje
| ||||||||||||||
id | string (Id) 24 characters Example: id=6189ba008749c5e836fa4cf6 Unikalny identyfikator ogłoszenia | ||||||||||||||
date_from | string <date> (Date From) Example: date_from=2022-01-01 Początek zakresu dla daty publikacji ogłoszenia w MSiG / KRZ | ||||||||||||||
date_to | string <date> (Date To) Example: date_to=2022-12-31 Koniec zakresu dla daty publikacji ogłoszenia w MSiG / KRZ | ||||||||||||||
msig_signature | string (Msig Signature) Example: msig_signature=BMSiG-68591/2021 Sygnatura ogłoszenia w MSiG | ||||||||||||||
krz_signature | string (Krz Signature) Example: krz_signature=22220111/00004 Sygnatura ogłoszenia w KRZ | ||||||||||||||
nip | string (Nip) 10 characters Example: nip=9491827824 Numer NIP podmiotu, którego dotyczy ogłoszenie | ||||||||||||||
regon | string (Regon) 9 characters Example: regon=152074271 Numer REGON podmiotu, którego dotyczy ogłoszenie | ||||||||||||||
krs | string (Krs) 10 characters Example: krs=0000136890 Numer KRS podmiotu, którego dotyczy ogłoszenie | ||||||||||||||
pesel | string (Pesel) 11 characters Example: pesel=75121968629 Numer PESEL osoby, której dotyczy ogłoszenie | ||||||||||||||
first_name | string (First Name) Example: first_name=Adam Imię osoby, której dotyczy ogłoszenie | ||||||||||||||
last_name | string (Last Name) Example: last_name=Kowalczyk Nazwisko osoby, której dotyczy ogłoszenie | ||||||||||||||
cleaned_name | string (Cleaned Name) Example: cleaned_name=Jan Kowalski Imię i nazwisko osoby lub nazwa podmiotu gospodarczego, których dotyczy ogłoszenie | ||||||||||||||
signature | string (Signature) Example: signature=XIX GUp 113/20 Sygnatura postępowania | ||||||||||||||
commissioner_name | string (Commissioner Name) Example: commissioner_name=Ryszard Nowak Imię i nazwisko sędziego komisarza | ||||||||||||||
administrator_name | string (Administrator Name) Example: administrator_name=Jan Kowalski Imię i nazwisko nadzorcy sądowego | ||||||||||||||
projection | string (ProjectionEnum) Example: projection=entity Lista zwracanych grup informacji Pokaż możliwe opcje
| ||||||||||||||
Array of CategoriesEnum (string) or strings (Category) Example: category=K.0.1,M.0.9,M.1.22 Lista możliwych wartości dostępna jest pod adresem /v2/dicts/announcement-categories | |||||||||||||||
archival | boolean (Archival) Default: false Example: archival=true Umożliwia odpytywanie bazy o ogłoszenia sprzed daty archive_date_from z parametrów usługi | ||||||||||||||
append_first_entry | boolean (Append First Entry) Default: false Example: append_first_entry=true Umożliwia wyszukiwanie po danych dłużnika lub postępowania (np. numerach PESEL/NIP, sygnaturze sprawy) opublikowanych w pierwszym ogłoszeniu w ramach tego samego postępowania. W odpowiedzi dane dłużnika i postępowania pochodzące z obwieszczenia są nadpisywane danymi pochodzącymi z pierwszego ogłoszenia w ramach tej samej sprawy | ||||||||||||||
filter_id | string (Filter Id) 24 characters Example: filter_id=62c4261f8a99edae0409fbc0 Umożliwia odpytywanie bazy o ogłoszenia na podstawie unikalnego identyfikatora filtra | ||||||||||||||
update_id | integer (Update Id) Umożliwia odpytywanie bazy o ogłoszenia ze wskazanej aktualizacji | ||||||||||||||
update_id_from | integer (Update Id From) Umożliwia odpytywanie bazy o ogłoszenia z update_id większym od podanej wartości | ||||||||||||||
update_id_to | integer (Update Id To) Umożliwia odpytywanie bazy o ogłoszenia z update_id mniejszym od podanej wartości |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
[- {
- "id": "642d7d281c62e3a72c70cd8d",
- "meta": {
- "issue_date": "2021-11-04",
- "category": "K.1.20.30",
- "first_update_date": "2022-11-11",
- "last_update_date": "2023-01-11",
- "is_administrator_data_consistent": true,
- "is_correction": false,
- "is_entity_data_consistent": true
}, - "entity": [
- {
- "info": {
- "first_name": "Jan",
- "last_name": "Kowalski",
- "legal_form": "osoby fizyczne nieprowadzące działalności gospodarczej",
- "birth_date": "1975-03-09",
- "cleaned_name": "Jan Kowalski",
- "ownership_type": "własność krajowych osób fizycznych"
}, - "numbers": {
- "pesel": "75030957433"
}, - "address": {
- "town": "Warszawa",
- "state": "mazowieckie",
- "gmina": "Warszawa-Mokotów",
- "street": "Jadźwingów",
- "powiat": "Warszawa"
}
}
], - "proceeding": {
- "signatures": [
- "XIX GUp 113/20"
], - "court_department": "XIX Wydział Gospodarczy ds. Upadłościowych i Restrukturyzacyjnych",
- "court_name": "Sąd Rejonowy dla m.st. Warszawy w Warszawie"
}, - "order": {
- "order_date": "2021-09-01",
- "expiration_period": 7,
- "expiration_date": "2021-11-11"
}, - "msig_entry": {
- "chapter": 0,
- "issue_date": "2021-11-04",
- "signature": "BMSiG-68591/2021",
- "position_number": "67445",
- "section": 9,
- "yearly_number": "214"
}, - "krz_entry": {
- "chapter": 1,
- "issue_date": "2022-01-11",
- "section": 20,
- "subsection": 30,
- "signature": "20220111/00004"
}, - "content": {
- "text": "Postanowieniem z dnia ...",
- "html": "<tresc><p style=\"margin:15px 0px 0px 0px\">Postanowieniem z dnia ...</p></tresc>",
}
}
]
Zwraca ogłoszenie o podanym id
.
id required | string (Id) 24 characters Example: 6221c40ca9ab2f868237cd47 Unikalny identyfikator ogłoszenia |
projection | string (ProjectionEnum) Example: projection=entity Lista zwracanych grup informacji Pokaż możliwe opcje
| ||||||||||||||
append_first_entry | boolean (Append First Entry) Default: false Example: append_first_entry=true Umożliwia wyszukiwanie po danych dłużnika lub postępowania (np. numerach PESEL/NIP, sygnaturze sprawy) opublikowanych w pierwszym ogłoszeniu w ramach tego samego postępowania. W odpowiedzi dane dłużnika i postępowania pochodzące z obwieszczenia są nadpisywane danymi pochodzącymi z pierwszego ogłoszenia w ramach tej samej sprawy |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "id": "642d7d281c62e3a72c70cd8d",
- "meta": {
- "issue_date": "2021-11-04",
- "category": "K.1.20.30",
- "first_update_date": "2022-11-11",
- "last_update_date": "2023-01-11",
- "is_administrator_data_consistent": true,
- "is_correction": false,
- "is_entity_data_consistent": true
}, - "entity": [
- {
- "info": {
- "first_name": "Jan",
- "last_name": "Kowalski",
- "legal_form": "osoby fizyczne nieprowadzące działalności gospodarczej",
- "birth_date": "1975-03-09",
- "cleaned_name": "Jan Kowalski",
- "ownership_type": "własność krajowych osób fizycznych"
}, - "numbers": {
- "pesel": "75030957433"
}, - "address": {
- "town": "Warszawa",
- "state": "mazowieckie",
- "gmina": "Warszawa-Mokotów",
- "street": "Jadźwingów",
- "powiat": "Warszawa"
}
}
], - "proceeding": {
- "signatures": [
- "XIX GUp 113/20"
], - "court_department": "XIX Wydział Gospodarczy ds. Upadłościowych i Restrukturyzacyjnych",
- "court_name": "Sąd Rejonowy dla m.st. Warszawy w Warszawie"
}, - "order": {
- "order_date": "2021-09-01",
- "expiration_period": 7,
- "expiration_date": "2021-11-11"
}, - "msig_entry": {
- "chapter": 0,
- "issue_date": "2021-11-04",
- "signature": "BMSiG-68591/2021",
- "position_number": "67445",
- "section": 9,
- "yearly_number": "214"
}, - "krz_entry": {
- "chapter": 1,
- "issue_date": "2022-01-11",
- "section": 20,
- "subsection": 30,
- "signature": "20220111/00004"
}, - "content": {
- "text": "Postanowieniem z dnia ...",
- "html": "<tresc><p style=\"margin:15px 0px 0px 0px\">Postanowieniem z dnia ...</p></tresc>",
}
}
Udostępniamy podgląd na aktualizacje naszej wewnętrznej bazy ogłoszeń. W ten sposób możemy sprawdzić aktualność naszych danych.
Zwraca dane aktualizacji bazy ogłoszeń o podanym id
.
required | integer or string (Id) non-empty Example: 1 Unikalny identyfikator aktualizacji |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "id": 1,
- "creation_datetime": "2022-03-04T08:47:24.864903+01:00",
- "issue_date": "2022-03-04",
- "announcements_count": 100,
- "source": "krz"
}
Zwraca listę aktualizacji bazy ogłoszeń dla podanych parametrów.
creation_datetime_from required | string <date-time> (Creation Datetime From) Example: creation_datetime_from=2019-01-01T00:00:00Z Początek zakresu dla daty i czasu utworzenia aktualizacji |
creation_datetime_to required | string <date-time> (Creation Datetime To) Example: creation_datetime_to=2019-12-31T00:00:00Z Koniec zakresu dla daty i czasu utworzenia aktualizacji |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
[- {
- "id": 1,
- "creation_datetime": "2022-03-04T08:47:24.864903+01:00",
- "issue_date": "2022-03-04",
- "announcements_count": 100,
- "source": "krz"
}
]
Udostępniamy możliwość utworzenia filtra na potrzeby monitorowania wybranych podmiotów, osób czy postępowań. W ten sposób, w tworzonych raportach możemy zawęzić listę ogłoszeń do:
Zwraca listę filtrów przypisanych do aktualnego użytkownika.
exclude | Array of strings (Exclude) Example: exclude=content&exclude=items_count Pola, które nie będą zwrócone w odpowiedzi. Pokaż możliwe opcje
|
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
[- {
- "id": "6221c40ca9ab2f868237cd47",
- "name": "Dłużnicy 2021-11",
- "content": {
- "nip": [
- "7272849598"
], - "regon": [
- "272404100"
], - "krs": [
- "0000422121"
], - "pesel": [
- "41041202774"
], - "krz_signature": [
- "BY1B/GUp/13/2021"
], - "msig_signature": [
- "XIV GUp 83/16"
], - "person_name": [
- "Jan Kowalski",
- "Ambroży Nielepszy"
]
}, - "items_count": 8,
- "creation_datetime": "2022-03-02T08:47:24.672670+01:00",
- "last_update_datetime": "2022-03-04T06:47:24.672929+01:00"
}
]
Tworzy nowy filtr przypisany do aktualnego użytkownika.
W parametrze content
podajemy przynajmniej jeden identyfikator dowolnego
typu. Łączna liczba przekazanych w żądaniu identyfikatorów nie może przekraczać
wartości filter_items_limit
z parametrów usługi.
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
name required | string (Name) non-empty Nazwa filtra |
required | object (StrictContentFiltersModel) Zawartość filtra |
{- "name": "string",
- "content": {
- "nip": [
- "7272849598"
], - "regon": [
- "272404100"
], - "krs": [
- "0000422121"
], - "pesel": [
- "41041202774"
], - "krz_signature": [
- "BY1B/GUp/13/2021"
], - "msig_signature": [
- "XIV GUp 83/16"
], - "person_name": [
- "Jan Kowalski",
- "Ambroży Nielepszy"
]
}
}
{- "id": "6241914e815d3e6b3771fc81",
- "name": "Dłużnicy 2021-11",
- "content": {
- "nip": [
- "7272849598"
], - "regon": [
- "272404100"
], - "krs": [
- "0000422121"
], - "pesel": [
- "41041202774"
], - "krz_signature": [
- "BY1B/GUp/13/2021"
], - "msig_signature": [
- "XIV GUp 83/16"
], - "person_name": [
- "Jan Kowalski",
- "Ambroży Nielepszy"
]
}, - "items_count": 8,
- "creation_datetime": "2022-03-26T12:43:26.269733+01:00",
- "last_update_datetime": "2022-03-28T10:43:26.269763+02:00"
}
Usuwa filtry o identyfikatorach przekazanych w parametrze ids
w query stringu,
identyfikatory muszą być oddzielone przecinkami.
W przypadku sukcesu metoda zwraca kod odpowiedzi 204 No Content
.
ids required | string (List of id) >= 24 characters Example: ids=6221c40ca9ab2f868237cd47,6189ba008749c5e836fa4cf6 Lista identyfikatorów filtra |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "error": "Bad Request",
- "details": "One of given ids is incorrect"
}
Zwraca filtr o podanym id
.
required | string or string (Id) 24 characters Example: 6221c40ca9ab2f868237cd47 Unikalny identyfikator filtra |
exclude | Array of strings (Exclude) Example: exclude=content&exclude=items_count Pola, które nie będą zwrócone w odpowiedzi. Pokaż możliwe opcje
|
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "id": "6221c40ca9ab2f868237cd47",
- "name": "Dłużnicy 2021-11",
- "content": {
- "nip": [
- "7272849598"
], - "regon": [
- "272404100"
], - "krs": [
- "0000422121"
], - "pesel": [
- "41041202774"
], - "krz_signature": [
- "BY1B/GUp/13/2021"
], - "msig_signature": [
- "XIV GUp 83/16"
], - "person_name": [
- "Jan Kowalski",
- "Ambroży Nielepszy"
]
}, - "items_count": 8,
- "creation_datetime": "2022-03-02T08:47:24.672670+01:00",
- "last_update_datetime": "2022-03-04T06:47:24.672929+01:00"
}
Modyfikuje filtr o podanym id
.
Ustawiając parametr content
, podajemy przynajmniej jeden identyfikator
dowolnego typu. Łączna liczba przekazanych w żądaniu identyfikatorów nie może
przekraczać wartości filter_items_limit
z parametrów usługi.
id required | string (Id) 24 characters Example: 6221c40cff11c462e837cd51 Unikalny identyfikator filtra |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
name | string (Name) non-empty Nazwa filtra |
object (StrictContentFiltersModel) Zawartość filtra |
{- "name": "string",
- "content": {
- "nip": [
- "7272849598"
], - "regon": [
- "272404100"
], - "krs": [
- "0000422121"
], - "pesel": [
- "41041202774"
], - "krz_signature": [
- "BY1B/GUp/13/2021"
], - "msig_signature": [
- "XIV GUp 83/16"
], - "person_name": [
- "Jan Kowalski",
- "Ambroży Nielepszy"
]
}
}
{- "id": "6241914e815d3e6b3771fc81",
- "name": "Dłużnicy 2021-11",
- "content": {
- "nip": [
- "7272849598"
], - "regon": [
- "272404100"
], - "krs": [
- "0000422121"
], - "pesel": [
- "41041202774"
], - "krz_signature": [
- "BY1B/GUp/13/2021"
], - "msig_signature": [
- "XIV GUp 83/16"
], - "person_name": [
- "Jan Kowalski",
- "Ambroży Nielepszy"
]
}, - "items_count": 8,
- "creation_datetime": "2022-03-26T12:43:26.269733+01:00",
- "last_update_datetime": "2022-03-28T10:43:26.269763+02:00"
}
Udostępniamy mechanizm tworzenia plików z listą ogłoszeń opublikowanych w wybranym zakresie dat. Wygenerowane archiwum ZIP zawiera plik w jednym ze wskazanych formatów: CSV, XLSX, XML, JSON albo DEF.
Zwraca listę raportów przypisanych do aktualnego użytkownika.
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
[- {
- "id": "639740d112aacc69fa7707c2",
- "type": 0,
- "name": "example report",
- "query": {
- "custom_categories": [
- "K"
], - "from_date": "2021-11-02",
- "to_date": "2021-11-04",
- "filter_id": "639740d14a61d5fa007707c1",
- "append_first_entry": true
}, - "custom_content": [ ],
- "status": 1,
- "progress": 0,
- "file_format": 3,
- "file_password": "mgbi2021",
- "credits_used": 0,
- "creation_datetime": "2022-12-12T15:55:13.629761+01:00",
- "downloads": [
- {
- "download_datetime": "2022-12-12T15:55:13.207386+01:00"
}
], - "records_count": 3,
- "file_encoding": 0
}
]
Tworzy nowy raport - plik z listą ogłoszeń - przypisany do aktualnego użytkownika.
Raport możemy tworzyć w dwóch trybach:
query.from_date
ograniczona jest przez wartość archive_date_from
z parametrów usługi,query_from.date
nie jest ograniczona.Raport aktualny/archiwalny może zostać utworzony, gdy liczba raportów po jego
utworzeniu nie będzie przekraczać wartości odpowiednio
current_reports_available
/archival_reports_available
z parametrów usługi.
Dodatkowo, przy tworzeniu raportu archiwalnego, sumaryczna liczba ogłoszeń
wygenerowanych w ramach wszystkich stworzonych do tej pory archiwalnych
raportów i zapytań nie może przekroczyć wartości credits_available
z parametrów usługi.
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
type required | integer (Types) Default: 0 Rodzaj raportu. Pokaż możliwe opcje
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string (Name) Nazwa raportu | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | QueryRaportByDateRangeModel (object) or QueryRaportByNotificationModel (object) (Query) Kryteria filtrowania ogłoszeń uwzględnionych w raporcie | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_content | Array of any (Custom Content) Default: [] Identyfikatory pól raportu wybranych przez użytkownika. W przypadku pustej listy raport zawiera wszystkie dostępne pola obwieszczenia. Pokaż możliwe opcje
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
file_format required | integer (FormatLU) An enumeration.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
file_password required | string (File Password) Hasło do pliku raportu | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
file_encoding | integer Default: 0 System kodowania znaków w pliku
|
{- "type": 0,
- "name": "example raport",
- "query": {
- "custom_categories": [
- "K"
], - "from_date": "2021-11-02",
- "to_date": "2021-11-04",
- "filter_id": "639740d14a61d5fa007707c1",
- "append_first_entry": true
}, - "custom_content": [ ],
- "file_format": 3,
- "file_password": "mgbi2021",
- "file_encoding": 0
}
{- "id": "639740d112aacc69fa7707c2",
- "type": 0,
- "name": "example report",
- "query": {
- "custom_categories": [
- "K"
], - "from_date": "2021-11-02",
- "to_date": "2021-11-04",
- "filter_id": "639740d14a61d5fa007707c1",
- "append_first_entry": true
}, - "custom_content": [ ],
- "status": 1,
- "progress": 0,
- "file_format": 3,
- "file_password": "mgbi2021",
- "credits_used": 0,
- "creation_datetime": "2022-12-12T15:55:13.629761+01:00",
- "downloads": [
- {
- "download_datetime": "2022-12-12T15:55:13.207386+01:00"
}
], - "records_count": 3,
- "file_encoding": 0
}
Usuwa raporty o identyfikatorach przekazanych w parametrze ids
w query stringu,
identyfikatory muszą być oddzielone przecinkami.
W przypadku sukcesu metoda zwraca kod odpowiedzi 204 No Content
.
ids required | string (List of id) >= 24 characters Example: ids=6221c40ca9ab2f868237cd47,6189ba008749c5e836fa4cf6 Lista identyfikatorów raportów. |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "error": "Bad Request",
- "details": "One of given ids is incorrect"
}
Zwraca raport o podanym id
.
required | string or string (Report Id) 24 characters Example: 6221c40cff11c462e837cd51 Unikalny identyfikator raportu |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "id": "639740d112aacc69fa7707c2",
- "type": 0,
- "name": "example report",
- "query": {
- "custom_categories": [
- "K"
], - "from_date": "2021-11-02",
- "to_date": "2021-11-04",
- "filter_id": "639740d14a61d5fa007707c1",
- "append_first_entry": true
}, - "custom_content": [ ],
- "status": 1,
- "progress": 0,
- "file_format": 3,
- "file_password": "mgbi2021",
- "credits_used": 0,
- "creation_datetime": "2022-12-12T15:55:13.629761+01:00",
- "downloads": [
- {
- "download_datetime": "2022-12-12T15:55:13.207386+01:00"
}
], - "records_count": 3,
- "file_encoding": 0
}
Pobiera plik wygenerowanego raportu o podanym id
.
Plik raportu można pobrać tylko w sytuacji, gdy status raportu ma wartość 2
(gotowy).
required | string or string (Report Id) 24 characters Example: 6221c40cff11c462e837cd51 Unikalny identyfikator raportu |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "error": "Validation error",
- "details": [
- {
- "loc": [
- "path",
- "report_id"
], - "msg": "Invalid objectid",
- "type": "value_error"
}, - {
- "loc": [
- "path",
- "report_id"
], - "msg": "unexpected value; permitted: 'last'",
- "type": "value_error.const",
- "ctx": {
- "given": "abcd",
- "permitted": [
- "last"
]
}
}
]
}
Udostępniamy możliwość monitorowania nowych ogłoszeń w ramach list identyfikatorów podanych w filtrze. Na wskazane adresy e-mail będzie raz dziennie wysyłana wiadomość o nowych ogłoszeniach dotyczących wybranych podmiotów, osób bądź sygnatur.
Zwraca monitoring o podanym id
.
required | string or string (Id) 24 characters Example: 6221c40c843d0d773f37cd4b Unikalny identyfikator monitoringu |
exclude | Array of strings (Exclude) Example: exclude=notifications Pola, które nie będą zwrócone w odpowiedzi. Pokaż możliwe opcje
|
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "id": "6221c40c843d0d773f37cd4b",
- "filter_id": "6221c40cdeb9dcdccf37cd4c",
- "emails": [
- "abc@mgbi.pl",
- "def@mgbi.pl"
], - "append_first_entry": false,
- "send_empty_notification": true,
- "show_snippets": true,
- "creation_datetime": "2022-03-02T08:47:24.769095+01:00",
- "last_update_datetime": "2022-03-04T06:47:24.769118+01:00",
- "notifications": [
- {
- "sent_datetime": "2022-02-27T08:47:24.769125+01:00",
- "email": "abc@mgbi.pl",
- "status": 1
}
]
}
Modyfikuje monitoring o podanym id
.
W parametrze emails
podajemy przynajmniej jeden adres e-mail, na który będą
wysyłane powiadomienia o nowych ogłoszeniach w ramach monitoringu.
Liczba adresów e-mail nie może przekraczać wartości monitors_emails_limit
z parametrów usługi.
id required | string (Id) 24 characters Example: 6221c40c843d0d773f37cd4b Unikalny identyfikator monitoringu |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
filter_id | string (Filter Id) 24 characters Identyfikator filtra wykorzystanego do utworzenia monitoringu |
emails | Array of strings (Emails) Default: [] Adresy e-mail do wysyłki powiadomień z monitoringów |
append_first_entry | boolean (Append First Entry) Czy uwzględniać również identyfikatory podane w pierwszym ogłoszeniu w ramach postępowania? |
send_empty_notifications | boolean (Send Empty Notifications) Czy wysyłać powiadomienie, jeśli nie pojawiły się nowe ogłoszenia w ramach monitoringu? |
show_snippets | boolean (Show Snippets) |
{- "filter_id": "6221c40c843d0d773f37cd4b",
- "emails": [
- "kura@wp.pl"
], - "append_first_entry": false,
- "send_empty_notifications": false,
- "show_snippets": true
}
{- "id": "6221c40c843d0d773f37cd4b",
- "filter_id": "6221c40cdeb9dcdccf37cd4c",
- "emails": [
- "abc@mgbi.pl",
- "def@mgbi.pl"
], - "append_first_entry": false,
- "send_empty_notification": true,
- "show_snippets": true,
- "creation_datetime": "2022-03-02T08:47:24.769095+01:00",
- "last_update_datetime": "2022-03-04T06:47:24.769118+01:00",
- "notifications": [
- {
- "sent_datetime": "2022-02-27T08:47:24.769125+01:00",
- "email": "abc@mgbi.pl",
- "status": 1
}
]
}
Zwraca listę monitoringów przypisanych do aktualnego użytkownika.
Aby ograniczyć listę zwracanych pól, warto ustawić parametr exclude
na pole, które nie jest wymagane w odpowiedzi, np. exclude=notifications
.
Można ukrywać wiele (niewymaganych w odpowiedzi) pól przekazując nazwy pól w kolejnych parametrach exclude
.
exclude | Array of strings (Exclude) Example: exclude=notifications Pola, które nie będą zwrócone w odpowiedzi. Pokaż możliwe opcje
|
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
[- {
- "id": "6221c40c843d0d773f37cd4b",
- "filter_id": "6221c40cdeb9dcdccf37cd4c",
- "emails": [
- "abc@mgbi.pl",
- "def@mgbi.pl"
], - "append_first_entry": false,
- "send_empty_notification": true,
- "show_snippets": true,
- "creation_datetime": "2022-03-02T08:47:24.769095+01:00",
- "last_update_datetime": "2022-03-04T06:47:24.769118+01:00",
- "notifications": [
- {
- "sent_datetime": "2022-02-27T08:47:24.769125+01:00",
- "email": "abc@mgbi.pl",
- "status": 1
}
]
}
]
Tworzy nowy monitoring przypisany do aktualnego użytkownika.
W parametrze emails
podajemy przynajmniej jeden adres e-mail, na który będą
wysyłane powiadomienia o nowych ogłoszeniach w ramach monitoringu.
Liczba adresów e-mail nie może przekraczać wartości monitors_emails_limit
z parametrów usługi.
Monitoring może zostać utworzony, gdy liczba monitoringów po jego utworzeniu
nie będzie przekraczać wartości monitors_available
z parametrów usługi.
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
filter_id | string (Filter Id) 24 characters Identyfikator filtra wykorzystanego do utworzenia monitoringu |
emails | Array of strings (Emails) Default: [] Adresy e-mail do wysyłki powiadomień z monitoringów |
append_first_entry required | boolean (Append First Entry) Czy uwzględniać również identyfikatory podane w pierwszym ogłoszeniu w ramach postępowania? |
send_empty_notifications | boolean (Send Empty Notifications) Default: false Czy wysyłać powiadomienie, jeśli nie pojawiły się nowe ogłoszenia w ramach monitoringu? |
show_snippets | boolean (Show Snippets) Default: true |
{- "filter_id": "6221c40c843d0d773f37cd4b",
- "emails": [
- "jajko@wp.pl"
], - "append_first_entry": true,
- "send_empty_notifications": false,
- "show_snippets": true
}
{- "id": "6221c40c843d0d773f37cd4b",
- "filter_id": "6221c40cdeb9dcdccf37cd4c",
- "emails": [
- "abc@mgbi.pl",
- "def@mgbi.pl"
], - "append_first_entry": false,
- "send_empty_notification": true,
- "show_snippets": true,
- "creation_datetime": "2022-03-02T08:47:24.769095+01:00",
- "last_update_datetime": "2022-03-04T06:47:24.769118+01:00",
- "notifications": [
- {
- "sent_datetime": "2022-02-27T08:47:24.769125+01:00",
- "email": "abc@mgbi.pl",
- "status": 1
}
]
}
Usuwa monitoringi o identyfikatorach przekazanych w parametrze ids
w query stringu,
identyfikatory muszą być oddzielone przecinkami.
W przypadku sukcesu metoda zwraca kod odpowiedzi 204 No Content
.
ids required | string (List of id) >= 24 characters Example: ids=6221c40ca9ab2f868237cd47,6189ba008749c5e836fa4cf6 Lista identyfikatorów monitoringów. |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "error": "Bad Request",
- "details": "One of given ids is incorrect"
}
Udostępniamy podgląd na listę powiadomień o nowych ogłoszeniach w ramach zdefiniowanych monitoringów.
Zwraca powiadomienia dla aktualnego użytkownika.
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
[- {
- "id": "6221c40c51fce5ae9f37cd48",
- "dispatch_id": "6221c40c5cb436601e37cd49",
- "monitor_id": "6221c40c5278893ac137cd4a",
- "sent_datetime": "2022-03-02T08:47:24.765264+01:00",
- "email": "abc@def.pl",
- "status": 1,
- "records_count": 14,
- "error": "ERROR !"
}
]
Zwraca powiadomienie o podanym id
.
id required | string (Id) 24 characters Example: 6221c40c51fce5ae9f37cd48 Unikalny identyfikator powiadomienia |
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "id": "6221c40c51fce5ae9f37cd48",
- "dispatch_id": "6221c40c5cb436601e37cd49",
- "monitor_id": "6221c40c5278893ac137cd4a",
- "sent_datetime": "2022-03-02T08:47:24.765264+01:00",
- "email": "abc@def.pl",
- "status": 1,
- "records_count": 14,
- "error": "ERROR !"
}
Zwraca aktualne informacje o użytkowniku
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "id": "67ac98d92526d4159e54ff4d",
- "email": "abc@mgbi.pl",
- "is_active": true,
- "is_admin": false,
- "creation_datetime": "2025-02-11T13:49:29.449592+01:00",
- "deactivation_datetime": "2025-06-11T13:49:29.450008+02:00"
}
Zwraca parametry usługi dla aktualnego użytkownika.
Authorization | string (Authorization) Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Klucz autoryzacji |
{- "archive_date_from": "2021-04-23",
- "current_reports_available": 25,
- "current_reports_used": 5,
- "current_reports_filter_required": false,
- "archival_reports_available": 5,
- "archival_reports_used": 0,
- "archival_reports_filter_required": false,
- "credits_available": 5,
- "credits_used": 0,
- "available_content": [
- "entity.info.cleaned_name",
- "entity.info.first_name",
- "entity.info.last_name",
- "entity.info.legal_form",
- "entity.info.ownership_type",
- "entity.info.primary_business",
- "entity.info.commencement_date",
- "entity.info.birth_date",
- "entity.numbers.nip",
- "entity.numbers.regon",
- "entity.numbers.krs",
- "entity.numbers.pesel",
- "entity.address.state",
- "entity.address.powiat",
- "entity.address.gmina",
- "entity.address.town",
- "entity.address.street",
- "entity.address.house_number",
- "entity.address.flat_number",
- "entity.address.zip_code",
- "entity.address.post_office",
- "proceeding.court_name",
- "proceeding.court_department",
- "proceeding.signatures",
- "proceeding.commissioner_name",
- "proceeding.commissioner_deputy_name",
- "proceeding.administrator_name",
- "proceeding.administrator_function",
- "proceeding.administrator_licence_number",
- "proceeding.administrator_address",
- "proceeding.administrator_zip_code",
- "proceeding.administrator_town",
- "proceeding.administrator_source_url",
- "order.order_date",
- "order.expiration_period",
- "order.expiration_date",
- "msig_entry.chapter",
- "msig_entry.section",
- "msig_entry.signature",
- "msig_entry.issue_date",
- "msig_entry.yearly_number",
- "msig_entry.position_number",
- "msig_entry.url",
- "krz_entry.chapter",
- "krz_entry.section",
- "krz_entry.subsection",
- "krz_entry.signature",
- "krz_entry.issue_date",
- "krz_entry.url",
- "content.text",
- "content.html",
- "content.url",
- "meta.issue_date",
- "meta.first_update_date",
- "meta.last_update_date",
- "meta.category",
- "meta.is_administrator_data_consistent",
- "meta.is_correction",
- "meta.is_entity_data_consistent"
], - "monitors_available": 5,
- "monitors_used": 2,
- "monitors_emails_limit": 5,
- "api_requests_available": 1000,
- "api_requests_used": 100,
- "monthly_reset_limits": true,
- "monitors_filter_required": false,
- "available_categories": [
- "K.0",
- "K.1",
- "K.2",
- "M.0",
- "M.1"
]
}