iMSiG.pl
Documentation Powered by ReDoc

Dokumentacja API serwisu iMSiG.pl - MSIG API, KRZ API (1.0.477)

Download OpenAPI specification:Download

MGBI sp. z o.o.: info@imsig.pl URL: https://api.imsig.pl

Ogólne informacje

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).

Autentykacja

api_key

Do uwierzytelniania użytkowników API wykorzystywany jest klucz użytkownika przekazywany w nagłówku HTTP Authorization przy wywoływaniu poszczególnych metod.

Security Scheme Type API Key
Header parameter name: Authorization

Ogłoszenia

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 API (MSIG API)
  • Krajowy Rejestr Zadłużonych API (KRZ API)

Źródło danych

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.).

Ustrukturyzowane informacje

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.

Masowy dostęp

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.

GET /v2/announcements

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.

query Parameters
stream
string (Stream)
Default: "json"
Example: stream=json

Czy odpowiedź ma być streamowana/wysyłana 'porcjami' ?

Pokaż możliwe opcje
Wartość Opis
none Stream wyłączony, odpowiedź przesyłana w całości w formacie JSON (ograniczona do 1000 pierwszych rekordów)
json Odpowiedź streamowana w formacie JSON
ndjson Odpowiedź streamowana w formacie NDJSON (Newline Delimited JSON)
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
Identyfikator Grupa informacji
entity Lista podmiotów, których dotyczy ogłoszenie
proceeding Informacje o postępowaniu
order Informacje o postanowieniu, którego dotyczy ogłoszenie
msig_entry Informacje dotyczące publikacji ogłoszenia w msig
krz_entry Informacje dotyczące publikacji ogłoszenia w krz
content Nieprzetworzona treść ogłoszenia
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

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET /v2/announcements/{id}

Zwraca ogłoszenie o podanym id.

path Parameters
id
required
string (Id) 24 characters
Example: 6221c40ca9ab2f868237cd47

Unikalny identyfikator ogłoszenia

query Parameters
projection
string (ProjectionEnum)
Example: projection=entity

Lista zwracanych grup informacji

Pokaż możliwe opcje
Identyfikator Grupa informacji
entity Lista podmiotów, których dotyczy ogłoszenie
proceeding Informacje o postępowaniu
order Informacje o postanowieniu, którego dotyczy ogłoszenie
msig_entry Informacje dotyczące publikacji ogłoszenia w msig
krz_entry Informacje dotyczące publikacji ogłoszenia w krz
content Nieprzetworzona treść ogłoszenia
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

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "id": "642d7d281c62e3a72c70cd8d",
  • "meta": {
    },
  • "entity": [
    ],
  • "proceeding": {
    },
  • "order": {
    },
  • "msig_entry": {},
  • "krz_entry": {
    },
  • "content": {}
}

Aktualizacje

Udostępniamy podgląd na aktualizacje naszej wewnętrznej bazy ogłoszeń. W ten sposób możemy sprawdzić aktualność naszych danych.

GET /v2/updates/{id}

Zwraca dane aktualizacji bazy ogłoszeń o podanym id.

path Parameters
required
integer or string (Id) non-empty
Example: 1

Unikalny identyfikator aktualizacji

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "creation_datetime": "2022-03-04T08:47:24.864903+01:00",
  • "issue_date": "2022-03-04",
  • "announcements_count": 100,
  • "source": "krz"
}

GET /v2/updates

Zwraca listę aktualizacji bazy ogłoszeń dla podanych parametrów.

query Parameters
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

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Filtry

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:

  • podmiotów z wybranej listy numerów NIP, REGON albo KRS,
  • osób fizycznych z wybrabej listy numerów PESEL albo listy imion i nazwisk,
  • postępowań z wybranej listy sygnatur z MSiG albo KRZ.

GET /v2/filters

Zwraca listę filtrów przypisanych do aktualnego użytkownika.

query Parameters
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
Wartość Nazwa
content Zawartość filtra
items_count Liczba wszystkich identyfikatorów w filtrze
header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST /v2/filters

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.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Request Body schema: application/json
name
required
string (Name) non-empty

Nazwa filtra

required
object (StrictContentFiltersModel)

Zawartość filtra

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6241914e815d3e6b3771fc81",
  • "name": "Dłużnicy 2021-11",
  • "content": {
    },
  • "items_count": 8,
  • "creation_datetime": "2022-03-26T12:43:26.269733+01:00",
  • "last_update_datetime": "2022-03-28T10:43:26.269763+02:00"
}

DELETE /v2/filters

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.

query Parameters
ids
required
string (List of id) >= 24 characters
Example: ids=6221c40ca9ab2f868237cd47,6189ba008749c5e836fa4cf6

Lista identyfikatorów filtra

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "details": "One of given ids is incorrect"
}

GET /v2/filters/{id}

Zwraca filtr o podanym id.

path Parameters
required
string or string (Id) 24 characters
Example: 6221c40ca9ab2f868237cd47

Unikalny identyfikator filtra

query Parameters
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
Wartość Nazwa
content Zawartość filtra
items_count Liczba wszystkich identyfikatorów w filtrze
header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "id": "6221c40ca9ab2f868237cd47",
  • "name": "Dłużnicy 2021-11",
  • "content": {
    },
  • "items_count": 8,
  • "creation_datetime": "2022-03-02T08:47:24.672670+01:00",
  • "last_update_datetime": "2022-03-04T06:47:24.672929+01:00"
}

PATCH /v2/filters/{id}

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.

path Parameters
id
required
string (Id) 24 characters
Example: 6221c40cff11c462e837cd51

Unikalny identyfikator filtra

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Request Body schema: application/json
name
string (Name) non-empty

Nazwa filtra

object (StrictContentFiltersModel)

Zawartość filtra

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6241914e815d3e6b3771fc81",
  • "name": "Dłużnicy 2021-11",
  • "content": {
    },
  • "items_count": 8,
  • "creation_datetime": "2022-03-26T12:43:26.269733+01:00",
  • "last_update_datetime": "2022-03-28T10:43:26.269763+02:00"
}

Raporty

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.

GET /v2/reports

Zwraca listę raportów przypisanych do aktualnego użytkownika.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST /v2/reports

Tworzy nowy raport - plik z listą ogłoszeń - przypisany do aktualnego użytkownika.

Raport możemy tworzyć w dwóch trybach:

  • w trybie raportu aktualnego, gdzie podana wartość pola query.from_date ograniczona jest przez wartość archive_date_from z parametrów usługi,
  • w trybie raportu archiwalnego, gdzie podana wartość pola 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.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Request Body schema: application/json
type
required
integer (Types)
Default: 0

Rodzaj raportu.

Pokaż możliwe opcje
Wartość Nazwa
0 Aktualny
1 Archiwalny
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
Wartość Nazwa
entity Lista podmiotów, których dotyczy ogłoszenie
entity.info Podstawowe dane podmiotu
entity.info.cleaned_name Nazwa podmiotu
entity.info.first_name Imię
entity.info.last_name Nazwisko
entity.info.legal_form Forma prawna
entity.info.ownership_type Forma własności
entity.info.primary_business Przeważająca działalność gospodarcza (kod PKD)
entity.info.commencement_date Data rozpoczęcia działalności
entity.info.birth_date Data urodzenia
entity.numbers Numery rejestrowe podmiotu
entity.numbers.nip NIP
entity.numbers.regon REGON
entity.numbers.krs KRS
entity.numbers.pesel PESEL
entity.address Adres pocztowy siedziby podmiotu lub miejsca zamieszkania
entity.address.state Województwo
entity.address.powiat Powiat
entity.address.gmina Gmina
entity.address.town Miejscowość
entity.address.street Ulica
entity.address.house_number Numer nieruchomości
entity.address.flat_number Numer lokalu
entity.address.zip_code Kod pocztowy
entity.address.post_office Poczta
proceeding Informacje o postępowaniu
proceeding.court_name Nazwa sądu
proceeding.court_department Nazwa wydziału
proceeding.signatures Sygnatura sprawy
proceeding.commissioner_name Sędzia komisarz
proceeding.commissioner_deputy_name Zastępca sędziego komisarza
proceeding.administrator_name Nadzorca w postępowaniu
proceeding.administrator_function Funkcja nadzorcy
proceeding.administrator_licence_number Numer licencji doradcy restrukturyzacyjnego
proceeding.administrator_address Adres nadzorcy (ulica)
proceeding.administrator_zip_code Adres nadzorcy (kod pocztowy)
proceeding.administrator_town Adres nadzorcy (miejscowość)
proceeding.administrator_source_url Źródło danych nadzorcy
order Informacje o postanowieniu, którego dotyczy ogłoszenie
order.order_date Data wydania postanowienia
order.expiration_period Okres do działania (w dniach)
order.expiration_date Koniec okresu do działania
msig_entry Informacje dotyczące publikacji ogłoszenia w MSiG
msig_entry.chapter Rozdział MSiG
msig_entry.section Sekcja MSiG
msig_entry.signature Sygnatura ogłoszenia w MSiG
msig_entry.issue_date Data publikacji ogłoszenia w MSiG
msig_entry.yearly_number Numer wydania MSiG
msig_entry.position_number Numer pozycji MSiG
msig_entry.url Link do ogłoszenia w serwisie imsig.pl
krz_entry Informacje dotyczące publikacji ogłoszenia w KRZ
krz_entry.chapter Rozdział KRZ
krz_entry.section Sekcja KRZ
krz_entry.subsection Podsekcja KRZ
krz_entry.signature Sygnatura ogłoszenia w KRZ
krz_entry.issue_date Data publikacji ogłoszenia w KRZ
krz_entry.url Link do ogłoszenia w serwisie KRZ
content Nieprzetworzona treść ogłoszenia
content.text Treść ogłoszenia (tekst)
content.html Treść ogłoszenia (HTML)
content.url Link do podglądu treści ogłoszenia
file_format
required
integer (FormatLU)

An enumeration.

Pokaż możliwe opcje

Wartość Nazwa
1 Csv
2 Xlsx
3 Xml
4 Json
5 Def
6 Novum
file_password
required
string (File Password)

Hasło do pliku raportu

file_encoding
integer
Default: 0

System kodowania znaków w pliku

Pokaż możliwe opcje

Wartość Nazwa
0 utf-8
1 cp1250
2 iso-8859-2

Responses

Request samples

Content type
application/json
{
  • "type": 0,
  • "name": "example raport",
  • "query": {
    },
  • "custom_content": [ ],
  • "file_format": 3,
  • "file_password": "mgbi2021",
  • "file_encoding": 0
}

Response samples

Content type
application/json
{
  • "id": "639740d112aacc69fa7707c2",
  • "type": 0,
  • "name": "example report",
  • "query": {
    },
  • "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": [
    ],
  • "records_count": 3,
  • "file_encoding": 0
}

DELETE /v2/reports

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.

query Parameters
ids
required
string (List of id) >= 24 characters
Example: ids=6221c40ca9ab2f868237cd47,6189ba008749c5e836fa4cf6

Lista identyfikatorów raportów.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "details": "One of given ids is incorrect"
}

GET /v2/reports/{report_id}

Zwraca raport o podanym id.

path Parameters
required
string or string (Report Id) 24 characters
Example: 6221c40cff11c462e837cd51

Unikalny identyfikator raportu

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "id": "639740d112aacc69fa7707c2",
  • "type": 0,
  • "name": "example report",
  • "query": {
    },
  • "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": [
    ],
  • "records_count": 3,
  • "file_encoding": 0
}

GET /v2/reports/{report_id}/download

Pobiera plik wygenerowanego raportu o podanym id.

Plik raportu można pobrać tylko w sytuacji, gdy status raportu ma wartość 2 (gotowy).

path Parameters
required
string or string (Report Id) 24 characters
Example: 6221c40cff11c462e837cd51

Unikalny identyfikator raportu

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "error": "Validation error",
  • "details": [
    ]
}

Monitoringi

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.

GET /v2/monitors/{id}

Zwraca monitoring o podanym id.

path Parameters
required
string or string (Id) 24 characters
Example: 6221c40c843d0d773f37cd4b

Unikalny identyfikator monitoringu

query Parameters
exclude
Array of strings (Exclude)
Example: exclude=notifications

Pola, które nie będą zwrócone w odpowiedzi.

Pokaż możliwe opcje
Wartość Nazwa
notifications Lista powiadomień
header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "id": "6221c40c843d0d773f37cd4b",
  • "filter_id": "6221c40cdeb9dcdccf37cd4c",
  • "emails": [
    ],
  • "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": [
    ]
}

PATCH /v2/monitors/{id}

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.

path Parameters
id
required
string (Id) 24 characters
Example: 6221c40c843d0d773f37cd4b

Unikalny identyfikator monitoringu

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Request Body schema: application/json
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)

Responses

Request samples

Content type
application/json
{
  • "filter_id": "6221c40c843d0d773f37cd4b",
  • "emails": [
    ],
  • "append_first_entry": false,
  • "send_empty_notifications": false,
  • "show_snippets": true
}

Response samples

Content type
application/json
{
  • "id": "6221c40c843d0d773f37cd4b",
  • "filter_id": "6221c40cdeb9dcdccf37cd4c",
  • "emails": [
    ],
  • "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": [
    ]
}

GET /v2/monitors

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.

query Parameters
exclude
Array of strings (Exclude)
Example: exclude=notifications

Pola, które nie będą zwrócone w odpowiedzi.

Pokaż możliwe opcje
Wartość Nazwa
notifications Lista powiadomień
header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST /v2/monitors

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.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "filter_id": "6221c40c843d0d773f37cd4b",
  • "emails": [
    ],
  • "append_first_entry": true,
  • "send_empty_notifications": false,
  • "show_snippets": true
}

Response samples

Content type
application/json
{
  • "id": "6221c40c843d0d773f37cd4b",
  • "filter_id": "6221c40cdeb9dcdccf37cd4c",
  • "emails": [
    ],
  • "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": [
    ]
}

DELETE /v2/monitors

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.

query Parameters
ids
required
string (List of id) >= 24 characters
Example: ids=6221c40ca9ab2f868237cd47,6189ba008749c5e836fa4cf6

Lista identyfikatorów monitoringów.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "error": "Bad Request",
  • "details": "One of given ids is incorrect"
}

Powiadomienia

Udostępniamy podgląd na listę powiadomień o nowych ogłoszeniach w ramach zdefiniowanych monitoringów.

GET /v2/notifications

Zwraca powiadomienia dla aktualnego użytkownika.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET /v2/notifications/{id}

Zwraca powiadomienie o podanym id.

path Parameters
id
required
string (Id) 24 characters
Example: 6221c40c51fce5ae9f37cd48

Unikalny identyfikator powiadomienia

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "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 !"
}

Użytkownicy

Informacje o aktualnym użytkowniku.

GET /v2/users/me

Zwraca aktualne informacje o użytkowniku

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "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"
}

Parametry

Parametry usługi przypisane do użytkownika.

GET /v2/params

Zwraca parametry usługi dla aktualnego użytkownika.

header Parameters
Authorization
string (Authorization)
Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Klucz autoryzacji

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "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": [
    ]
}

Słowniki

Etykiety dla zwracanych stałych.

GET /v2/dicts/announcement-categories

Zwraca słownik zawierający etykiety dla kategorii ogłoszeń.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET /v2/dicts/report-statuses

Zwraca słownik zawierający etykiety dla statusów pliku raportu.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET /v2/dicts/report-types

Zwraca słownik zawierający etykiety dla typów raportu.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET /v2/dicts/announcement-fields

Zwraca słownik zawierający etykiety dla identyfikatorów pól dostępnych w raportach.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET /v2/dicts/report-formats

Zwraca słownik zawierający etykiety dla formatów pliku raportu.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET /v2/dicts/report-encodings

Zwraca słownik zawierający etykiety dla systemów kodowania znaków w pliku raportu

Responses

Response samples

Content type
application/json
[
  • {
    }
]