NAV Navbar
Curl

API KRS/REGON/CEIDG

Poniższa dokumentacja oraz dostępne w niej metody mają zastosowanie przy korzystaniu z klasy API_KRS/REGON/CEIDG.

Wstęp

Wszystkie wywołania do API są standardowymi wywołaniami HTTP. API dostępne jest pod adresem https://api.transparentdata.pl/

Każde wywołanie API dokonywane jest metodą GET.

Uwierzytelnianie

Aby mieć dostęp do poszczególnych zasobów, API wymaga uwierzytelnienia. Jest ono realizowane za pomocą standardowych mechanizmów HTTP Basic Auth. Każdy użytkownik dostaje swój indywidualny url pod którym dostępne są wszystkie adresy wymienione poniżej.

Przykład uwierzytelniania:

 curl --user:pass https://api.transparentdata.pl/key/

Każdemu użytkownikowi przekazywany jest zestaw parametrów wymaganych do uruchomienia usługi:

Taki zestaw parametrów wystarczy, aby w łatwy sposób pobierać dane z bazy Transparent Data. Wszystkie wywołania API działają z SSL.

Działanie API można sprawdzić również w przeglądarce internetowej przez wywołanie adresu zbudowanego według wzorca: https://user:pass@api.transparentdata.pl/key/

Wymagane parametry

Przykład wykorzystania API

curl --user:pass https://api.transparentdata.pl/key/krsData?number=0000487824

Każde wywołanie ma kilka wymaganych parametrów:

Dostępne zasoby

Wyszukiwanie

KRS

krsData

 curl --user:pass https://api.transparentdata.pl/key/krsData?number=0000023302

{
    "name": "KGHM POLSKA MIEDŹ SPÓŁKA AKCYJNA",
    "legal_form": "SPÓŁKA AKCYJNA",
    "krs": "0000023302",
    "nip": "6920000013",
    "regon": "390021764",
    "address":
    {
        "street": "ul. MARII SKŁODOWSKIEJ-CURIE",
        "number": "48",
        "local": "---",
        "post": "LUBIN",
        "city": "LUBIN",
        "county": "LUBIŃSKI",
        "region": "DOLNOŚLĄSKIE",
        "country": "POLSKA",
        "postcode": "00-000"
    },
    "equity": "2000000000",
    "stock":
    {
        "quantity": "200000000",
        "value": "10.00"
    },
    "incorporation": "1991-09-10",
    "created_at": "2001-06-29",
    "last_registry_update": "2016-10-27",
    "removed_at": null,
    "pkd": "0729Z",
    "representation": "1. DO SKŁADANIA OŚWIADCZEŃ W IMIENIU SPÓŁKI WYMAGANE JEST WSPÓŁDZIAŁANIE DWÓCH
CZŁONKÓW ZARZĄDU ALBO JEDNEGO CZŁONKA ZARZĄDU ŁĄCZNIE Z PROKURENTEM.
2. JEŻELI ZARZĄD JEST JEDNOOSOBOWY, DO SKŁADANIA OŚWIADCZEŃ W IMIENIU SPÓŁKI
UPRAWNIONY JEST JEDEN CZŁONEK ZARZĄDU.",
    "court":
    {
        "name": "SĄD REJONOWY DLA  WROCŁAWIA-FABRYCZNEJ WE WROCŁAWIU, IX WYDZIAŁ GOSPODARCZY KRAJOWEGO REJESTRU SĄDOWEGO",
        "ident": "WR.IX NS-REJ.KRS/23224/16/694"
    },
    "www": "KGHM.COM",
    "email": null,
    "relation":
    [
        {
            "name": "ANNA NOWAK",
            "first_name": "ANNA",
            "last_name": "NOWAK",
            "relation": "board_member",
            "relation_extra_info": "I WICEPREZES ZARZĄDU",
            "ident":
            {
                "name": "pesel",
                "value": "xxxxxxxxxxxx"
            }
        },
        {
            "name": "KRZYSZTOF NOWACKI",
            "first_name": "KRZYSZTOF",
            "last_name": "NOWACKI",
            "relation": "board_member",
            "relation_extra_info": "PREZES ZARZĄDU",
            "ident":
            {
                "name": "pesel",
                "value": "xxxxxxxxxxxx"
            }
        },
                ...
      ]
}

Metoda zwraca zasób z dostępnymi danymi z KRS

Parametry

Nazwa Czy wymagany Opis
number Tak Numer KRS podmiotu, może być wcześniej wyszukany za pomocą searchByName

Zwracane pola:

getCeidg()

Przykładowa opdowiedź API:


{
  "first_name": "DOMINIK",
  "last_name": "CZAJKOWSKI",
  "name": "RS DOMINIK CZAJKOWSKI",
  "nip": "6262985804",
  "regon": "365357080",
  "main_address": {
    "street": "ul. Księdza Franciszka Nawrota",
    "number": "11",
    "local": "11",
    "post": "Bytom",
    "city": "",
    "county": "Bytom",
    "region": "ŚLĄSKIE"
  },
  "post_address": {
    "street": "ul. Księdza Franciszka Nawrota",
    "number": "11",
    "local": "11",
    "post": "Bytom",
    "city": "",
    "county": "Bytom",
    "region": "ŚLĄSKIE"
  },
  "begin_date": "2016-09-20",
  "www": null,
  "email": null,
  "phone": null
}

Metoda zwraca zasób z podstawowymi danymi o podmiocie z CEIDG.

Przyjmowana forma parametru number: string

Parametr może przyjmować wartości takie jak:

Zwracane pola:

getRegon()

Przykładowa opdowiedź API:


{
  "name": "KGHM POLSKA MIEDŹ SPÓŁKA AKCYJNA",
  "first_name": null,
  "last_name": null,
  "nip": "6920000013",
  "regon": "390021764",
  "pesel": null,
  "legal_form_code1": "1",
  "legal_form_code2": "116",
  "ownership_code": "235",
  "date_creation": "1991-09-13",
  "date_hang": null,
  "date_resume": null,
  "date_termination": null,
  "teryt_code_city": "0954142",
  "teryt_code_post": "0954142",
  "teryt_code_street": "20068",
  "address": [
    {
      "street": "ul. Marii Skłodowskiej-Curie",
      "number": "48",
      "postcode": "59-301",
      "city": "Lubin",
      "post": "Lubin",
      "county": "lubiński",
      "region": "DOLNOŚLĄSKIE",
      "country": "PL"
    }
  ],
  "registry_type": "REJESTR PRZEDSIĘBIORCÓW",
  "registry_number": "xxxxxxxxxxxx",
  "www": null,
  "email": "xxxxxxxxxxxx",
  "phone": "xxxxxxxxxxxx",
  "fax": "xxxxxxxxxxxx"
}

Metoda zwraca zasób z podstawowymi danymi o podmiocie z REGON.

Przyjmowana forma parametru number: string

Parametr może przyjmować wartości takie jak:

Zwracane pola: