openapi: 3.0.1 info: title: GeoStats description: 'The service is based on data from the BIK Individual Client database, presenting predefined credit statistics for a selected geographical area (address or UTM coordinates). / Usługa oparta o dane z bazy BIK Klient Indywidualny, prezentujących predefiniowane statystyk kredytowe dla wybranego obszaru geograficznego (adres lub współrzędne UTM).' version: '1.0' servers: - url: http://gateway.oapi.bik.pl/bik-api-6 - url: https://gateway.oapi.bik.pl/bik-api-6 paths: /utmloc: post: tags: - geostats-api-controller summary: geostatsByUtmLoc description: Download static information showing the credit situation of people living in the area (based on utm coordinates) for the indicated type of product. / Pobranie informacji statycznej obrazującej sytuację kredytową osób zamieszkujących dany obszar (na podstawie współrzędnych utm) dla wskazanego rodzaju produktu. operationId: geostatsByUtmLoc requestBody: content: application/json: schema: $ref: '#/components/schemas/GeostatsByLocalizationRequest' example: size: STAT_100M productCode: GENERAL section: AMOUNT_6M localization: utm_x: 391400 utm_y: 5734600 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GeostatsResponse' example: geostats: inputDataAdress: inputDataCoordinates: utm_x: 391400 utm_y: 5734600 nearestPoint: size: STAT_100M productCode: GENERAL section: AMOUNT_6M result: 935 date: /address: post: tags: - geostats-api-controller summary: geostatsByAddress description: Download static information showing the credit situation of people living in the area (based on address) for the indicated type of product. / Pobranie informacji statycznej obrazującej sytuację kredytową osób zamieszkujących dany obszar (na podstawie adresu) dla wskazanego rodzaju produktu. operationId: geostatsByAddress requestBody: content: application/json: schema: $ref: '#/components/schemas/GeostatsByAddressRequest' example: size: STAT_100M productCode: GENERAL section: AMOUNT_3M address: code: '90626' city: Łódź street: ŻEROMSKIEGO building_number: '58' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GeostatsResponse' example: geostats: - inputDataAdress: code: '90626' city: Łódź street: ŻEROMSKIEGO building_number: '58' inputDataCoordinates: utm_x: 392842 utm_y: 5736081 nearestPoint: size: STAT_100M productCode: GENERAL section: AMOUNT_3M result: '0934-09-01' date: components: schemas: ProductCode: enum: - SALES_FINANCE_LOAN - CASH_LOAN - MORTGAGE_LOAN - CREDIT_LIMIT - CREDIT_CARD - GENERAL - GENERAL_BANK - GENERAL_NON_BANK - ALL type: string description: "Rodzaj statystyki:\n * SALES_FINANCE_LOAN - \"Credit for the purchase of goods and services. / Kredyt na zakup towarów i usług\"\n * CASH_LOAN - \"Cash credit \\ Kredyt gotówkowy\"\n * MORTGAGE_LOAN - \"Housing credit \\ Kredyt mieszkaniowy\"\n * CREDIT_LIMIT - \"Credit limit \\ Limit kredytowy\"\n * CREDIT_CARD - \"Credit card \\ Karta kredytowa\"\n * GENERAL - \"General statistics (banking and non-banking sector) / Statystki ogólne (sektor bankowy i pozabankowy)\"\n * GENERAL_BANK - \"Total (banking sector) / Ogółem (sektor bankowy)\"\n * GENERAL_NON_BANK - \"Total (non-banking sector) / Ogółem (pozabankowy)\"\n * ALL - \"Wszystkie\"\n" example: GENERAL CoordinatesUtm: type: object properties: utm_x: type: number format: double utm_y: type: number format: double GridSize: enum: - STAT_100M - STAT_250M - STAT_500M type: string description: "grid size / wielkość siatki:\n * STAT_100M - 100 m from the point / 100 m od punktu\n * STAT_250M - 250 m from the point / 250 m od punktu\n * STAT_500M - 500 m from the point / 500 m od punktu\n" Address: required: - building_number - city - code - street type: object properties: code: pattern: '[0-9]{2}-[0-9]{3}' type: string city: maxLength: 255 minLength: 2 type: string street: type: string building_number: maxLength: 12 minLength: 1 type: string GeostatsResponse: type: object properties: geostats: type: array items: $ref: '#/components/schemas/Geostats' Geostats: type: object properties: inputDataAdress: $ref: '#/components/schemas/Address' inputDataCoordinates: $ref: '#/components/schemas/CoordinatesUtm' nearestPoint: $ref: '#/components/schemas/Address' size: $ref: '#/components/schemas/GridSize' productCode: $ref: '#/components/schemas/ProductCode' result: type: string GeostatsByAddressRequest: type: object properties: size: $ref: '#/components/schemas/GridSize' productCode: $ref: '#/components/schemas/ProductCode' section: $ref: '#/components/schemas/Section' localization: $ref: '#/components/schemas/CoordinatesUtm' address: $ref: '#/components/schemas/Address' date: type: string GeostatsByLocalizationRequest: type: object properties: size: $ref: '#/components/schemas/GridSize' productCode: $ref: '#/components/schemas/ProductCode' section: $ref: '#/components/schemas/Section' localization: $ref: '#/components/schemas/CoordinatesUtm' date: type: string Section: enum: - NUMBER_3M - DYN_NUMBER_3M - NUMBER_6M - DYN_NUMBER_6M - AMOUNT_3M - DYN_AMOUNT_3M - AMOUNT_6M - DYN_AMOUNT_6M - AV_AMOUNT_3M - DYN_AV_AMOUNT_3M - AV_AMOUNT_6M - DYN_AV_AMOUNT_6M - BALANCE_T0 - DEF_BALANCE_T0 - N_CLIENTS_T0 - SHARE_CLIENTS_T0 - AV_DEBTS_T0 - AV_AGE_BORROWER - AV_CR3_BORROWER - AV_AGE_HOLDER_T0 - AV_CR3_HOLDER_T0 type: string description: "Sekcja:\n * NUMBER_3M - \"Number of credit/loan sales over 3 months / Liczba sprzedaży kredytów/pożyczek w okresie 3 miesięcy\"\n * DYN_NUMBER_3M - \"Dynamics of credit/loan sales over the last 3 months / Dynamika sprzedaży kredytów/pożyczek z ostatnich 3 miesięcy\"\n * NUMBER_6M - \"Number of credit/loan sales 4-6 months ago / Liczba sprzedaży kredytów/pożyczek w okresie 4-6 miesięcy temu\"\n * DYN_NUMBER_6M - \"Dynamics of credit/loan sales from 4-6 months ago. / Dynamika sprzedaży kredytów/pożyczek z okresu 4-6 miesięcy temu\"\n * AMOUNT_3M - \"The value of sales of loans/advances (in thousands) over a period of 3 months / Wartość sprzedaży kredytów/pożyczek (w tysiącach) w okresie 3 miesięcy\"\n * DYN_AMOUNT_3M - \"Sales dynamics of the value of credits/loans from the last 3 months / Dynamika sprzedaży wartości kredytów/pożyczek z ostatnich 3 miesięcy\"\n * AMOUNT_6M - \"Sales value of loans/advances (in thousands) over 4-6 months ago / Wartość sprzedaży kredytów/pożyczek (w tysiącach) w okresie 4-6 miesięcy temu\"\n * DYN_AMOUNT_6M - \"Sales dynamics of the value of credits/loans from 4-6 months ago / Dynamika sprzedaży wartości kredytów/pożyczek z okresie 4-6 miesięcy temu\"\n * AV_AMOUNT_3M - \"Average amount of credits/loans (in thousands) over a period of 3 months ago / Średnia kwota kredytów/pożyczek (w tysiącach) w okresie 3 miesięcy\"\n * DYN_AV_AMOUNT_3M - \"Annual dynamics of the average amount of loans/advances over a period of 3 months / Dynamika roczna średniej kwoty kredytów/pożyczek w okresie 3 miesięcy\"\n * AV_AMOUNT_6M - \"Average amount of loans/advances (in thousands) over a period of 4-6 months / Średnia kwota kredytów/pożyczek (w tysiącach) w okresie 4-6 miesięcy\"\n * DYN_AV_AMOUNT_6M - \"Annual dynamics of the average amount of credits/loans in the period of 4-6 months / Dynamika roczna średniej kwoty kredytów/pożyczek w okresie 4-6 miesięcy\"\n * BALANCE_T0 - \"Value of credits/loans (in thousands) / Wartość kredytów/pożyczek (w tysiącach)\"\n * DEF_BALANCE_T0 - \"Share of credits/loans delayed more than 90 days (in value) / Udział kredytów/pożyczek opóźnionych pow. 90 dni (wartościowo)\"\n * N_CLIENTS_T0 - \"Number of borrowers/borrowers at the time of observation / Liczba kredytobiorców/pożyczkobiorców na moment obserwacji\"\n * SHARE_CLIENTS_T0 - \"Share of borrowers/borrowers among residents 20+ / Udział kredytobiorców/pożyczkobiorców wśród mieszkańców 20+\"\n * AV_DEBTS_T0 - \"Average customer debt (in thousands) / Średnie zadłużenie klienta (w tysiącach)\"\n * AV_AGE_BORROWER - \"Average age of borrowers/borrowers (refers to customers who have contracted within a 3-month period) / Średni wiek kredytobiorców/ pożyczkobiorców (dotyczy klientów, którzy zawarli umowę w okresie 3miesięcy)\"\n * AV_CR3_BORROWER - \"Average CR3 score (applies to customers who have contracted within a 3-month period) from the moment before contracting / Średnia punktacja CR3 (dotyczy klientów, którzy zawarli umowę w okresie 3 miesięcy) z momentu poprzedzającego zawarcie umowy\"\n * AV_AGE_HOLDER_T0 - \"Average current age of the loan/loan holder at the time of observation / Średni aktualny wiek posiadacza kredytu/ pożyczki w momencie obserwacji\"\n * AV_CR3_HOLDER_T0 - \"Average CR3 score of the credit/loan holders at the time of observation / Średnia punktacja CR3 posiadaczy kredytu/pożyczki w momencie obserwacji\"\n" securitySchemes: apiKeyHeader: type: apiKey name: BIK-OAPI-Key in: header apiKeyQuery: type: apiKey name: bik-oapi-Key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]