Dokumentacja API serwisu iMSiG.pl - KRS API, MSIG API, KRZ API (1.0.466)
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 RDF dostępny w serwisie iMSiG.pl umożliwia wyszukiwanie i pobieranie dokumentów złożonych w Repozytorium Dokumentów Finansowych Krajowego Rejestru Sądowego.
Skontaktuj się z nami, aby uzyskać informacje o zasadach korzystania z interfejsu.
Słowa kluczowe:
- Krajowy Rejestr Sądowy API (KRS API)
- Repozytorium Dokumentów Finansowych API (RDF API)
- Sprawozdania finansowe API
Począwszy od 15 marca 2018 r. każdy ma dostęp przez Internet do składanych przez podmioty gospodarcze dokumentów finansowych. Ta funkcjonalność dostępna jest bez posiadania konta użytkownika ani logowania na konto w wyszukiwarce na stronie Ministerstwa Sprawiedliwości. Wystarczy podać numer KRS, aby wyszukać dokumenty przypisane do podmiotu z tym numerem.
Wyszukiwarka dokumentów złożonych w RDF nie jest przeznaczona do masowego dostępu do dokumentów. Wyszukiwanie jest zabezpieczone przed działaniem robotów pobierających dokumenty mechanizmem reCAPTCHA v3. Co więcej, część dokumentów udostępniana jest w formie plików XML z podpisem cyfrowym, co uniemożliwia ich odczyt w popularnych programach.
Nasz interfejs programistyczny umożliwia masowe pobieranie dokumentów bez opóźnień związanych z wyszukiwaniem oraz bez problemów, które nierzadko występują przy pobieraniu pojedynczych plików. Wszystkie udostępniane przez nas dokumenty są gotowe do odczytu w popularnych programach.
Dla wszystkich dokumentów złożonych w RDF w formacie innym niż PDF udostępniamy dodatkową opcję podglądu takiego dokumentu po konwersji do formatu PDF. Dotyczy to również sprawozdań finansowych sporządzonych w formacie XML, które w surowej postaci nie są czytelne dla odbiorcy. Dla tych sprawozdań udostępniamy ujednolicony oraz łatwy w użytkowaniu podgląd w formacie HTML oraz PDF.
Aby sprawdzić opcje podglądu dokumentów, skorzystaj z wyszukiwarki dokumentów.
GET /v1/rdf/documents
Pobiera informacje o dokumentach złożonych do Repozytorium Dokumentów Finansowych KRS spełniających podane kryteria.
W przypadku sukcesu w treści odpowiedzi zwracana jest lista dokumentów spełniających kryteria określone w parametrach metody, posortowanych malejąco według daty publikacji w RDF.
W przypadku, gdy żaden dokument nie spełnia podanych kryteriów, zwracana jest pusta lista. W przypadku, gdy liczba dokumentów spełniających kryteria jest większa niż 100, lista zawiera 100 pierwszych dokumentów.
Authorizations:
query Parameters
| krs | string 10 characters Example: krs=0000028860 Numer KRS podmiotu, którego dotyczy dokument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string Example: type=financial_statement Identyfikator rodzaju dokumentu Pokaż możliwe opcje
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| period_end_year | integer Example: period_end_year=2019 Rok z daty końcowej okresu, którego dotyczy dokument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| period_major_year | integer Example: period_major_year=2018 Zasadniczy rok, którego dotyczy dokument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| filing_date_from | string <date> Example: filing_date_from=2020-01-01 Początek zakresu dla daty publikacji dokumentu w RDF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| filing_date_to | string <date> Example: filing_date_to=2020-12-31 Koniec zakresu dla daty publikacji dokumentu w RDF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| crawling_date_from | string <date> Example: crawling_date_from=2020-07-01 Początek zakresu dla daty pobrania dokumentu z RDF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| crawling_date_to | string <date> Example: crawling_date_to=2020-07-31 Koniec zakresu dla daty pobrania dokumentu z RDF |
Responses
Request samples
- Shell
# Wyszukaj dokumenty dla podmiotu z numerem KRS `0000028860` curl https://api.imsig.pl/v1/rdf/documents?krs=0000028860 --header \"Authorization: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"
Response samples
- 200
- 400
- 401
- 403
- 429
[- {
- "id": 2047606,
- "crawling_date": "2019-08-14",
- "file_content_type": "string",
- "file_format": "pdf",
- "file_root": "0000028860_2018_financial_statement_2047606",
- "file_root_pl": "0000028860_2018_sprawozdanie_finansowe_2047606",
- "filing_date": "2019-06-27",
- "ias_standard": true,
- "is_correction": false,
- "krs": 28860,
- "language": "pl",
- "period_end_year": 2019,
- "period_from": "2018-01-01",
- "period_major_year": 2018,
- "period_to": "2019-02-28",
- "preparation_date": "2019-03-29",
- "submission_id": 845399,
- "type": "financial_statement"
}
]GET /v1/rdf/documents/{id}
Pobiera informacje o dokumencie złożonym do Repozytorium Dokumentów Finansowych KRS o podanym identyfikatorze.
W przypadku sukcesu w treści odpowiedzi zwracany jest dokument o podanym identyfikatorze.
W przypadku, gdy dokument o podanym identyfikatorze nie istnieja w odpowiedzi zwracany jest błąd.
Authorizations:
path Parameters
| id required | string Example: 2047606 Wewnętrzy identyfikator zgłoszenia w RDF |
Responses
Request samples
- Shell
# Wyszukaj dokument o identyfikatorze `2047606` curl https://api.imsig.pl/v1/rdf/documents/2047606 --header \"Authorization: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "id": 2047606,
- "crawling_date": "2019-08-14",
- "file_content_type": "string",
- "file_format": "pdf",
- "file_root": "0000028860_2018_financial_statement_2047606",
- "file_root_pl": "0000028860_2018_sprawozdanie_finansowe_2047606",
- "filing_date": "2019-06-27",
- "ias_standard": true,
- "is_correction": false,
- "krs": 28860,
- "language": "pl",
- "period_end_year": 2019,
- "period_from": "2018-01-01",
- "period_major_year": 2018,
- "period_to": "2019-02-28",
- "preparation_date": "2019-03-29",
- "submission_id": 845399,
- "type": "financial_statement"
}