Stream Records - Dokumentacja MGBI API

Pobiera rekordy z danymi podmiotów z Wykazu Podatników VAT (Białej Listy VAT) spełniające podane kryteria w postaci strumienia danych.

Endpoint wymaga przekazania identyfikatora zlecenia odświeżenia danych w parametrze refresh_id. Więcej informacji o tworzeniu takich zleceń znajdziesz w sekcji Zlecanie odświeżenia danych.

W przypadku sukcesu w odpowiedzi zwraca listę rekordów posortowaną według daty i czasu wersji danych.

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

api_search_results o 1, jeśli zwrócono co najmniej jeden rekord

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Lista rekordów

application/json

Lista rekordów

Bodyapplication/json

Example

[
    {
        "_id": "674706cb585d7bc7e9207c4b",
        "content": {
            "raw_result": {
                "requestDateTime": "31-10-2024 15:49:51",
                "requestId": "NGORD-917cegf",
                "subject": {
                    "accountNumbers": [
                        "20102030170000240204460663",
                        "25102030170000220204460671",
                        "28102030170000270205043536",
                        "97102030170000240205150208"
                    ],
                    "authorizedClerks": [],
                    "hasVirtualAccounts": false,
                    "krs": "0000245778",
                    "name": "APINEX TECHNIKA TWORZYW SZTUCZNYCH SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
                    "nip": "1010001148",
                    "partners": [],
                    "registrationLegalDate": "2005-12-01",
                    "regon": "020159328",
                    "representatives": [],
                    "statusVat": "Czynny",
                    "workingAddress": "GNIEWOMIERZ 179A, 59-241 GNIEWOMIERZ"
                }
            }
        },
        "identifiers": {
            "pl_krs": "0000245778",
            "pl_nip": "1010001148",
            "pl_regon": "020159328"
        },
        "meta": {
            "first_update_datetime": "2024-11-27T11:47:20.325",
            "last_update_datetime": "2024-11-27T11:47:20.325"
        },
        "version": {
            "from_datetime": "2023-12-30T23:00:00.000",
            "latest": true,
            "to_datetime": "2023-12-31T23:00:00.000"
        }
    }
]

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests