Skip to main content
POST
/
api
/
banki
/
banks
/
search
/banki/banks/search
curl --request POST \
  --url https://api.anysite.io/api/banki/banks/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "region_scope": "all",
  "ownership": "all",
  "sort": "name"
}
'
[
  {
    "alias": "<string>",
    "name": "<string>",
    "@type": "@banki_bank_search_result",
    "id": 123,
    "image": "<string>",
    "region": "<string>",
    "licence": "<string>",
    "financial_rating_place": 123,
    "review_count": 123,
    "url": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required

Number of banks to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
region_scope
enum<string>
default:all

Whether to include all banks or only those registered in the region

Available options:
all,
registered
​
ownership
enum<string>
default:all

Filter by bank ownership type

Available options:
all,
state,
foreign
​
sort
enum<string>
default:name

Sort order of the bank list

Available options:
name,
financial_rating,
licence

Response

Successful Response

​
alias
string
required
​
name
string
required
​
@type
string
default:@banki_bank_search_result
​
id
integer | null
​
image
string | null
​
region
string | null
​
licence
string | null
​
financial_rating_place
integer | null
​
review_count
integer | null
​
url
string | null