GET/carsEksportimi

Eksportoni automjete me një kursor

Transmetoni çdo makinë aktive në burimet tuaja, me raporte të plota, përmes një kursori në anën e serverit. Ndërtuar për të mbajtur një kopje lokale të sinkronizuar.

vehicle_type=automobile / 1 është parazgjedhja; motorcycle / 2 zgjedh motoçikleta në /search, /search/count dhe /cars. Përdorni të njëjtin lloj në fjalorë.
Hierarki e plotë: brands[] → models[] → generations[] → variants[] / trims[]. Çdo objekt marke, modeli dhe gjenerate kërkon id. OSE midis fqinjëve dhe vlerave variants/trims; DHE midis kushteve brenda një dege. Lista e munguar ose bosh nënkupton të gjithë pasardhësit. Deri në 100 elemente për listë. ID të panjohura ose të papajtueshme japin rezultat bosh; format i pavlefshëm — 422.
Në /cars lloji dhe hierarkia fiksohen për kursorin. Ndiqni next_url pa ndryshime ose dërgoni vetëm scroll_id. Renditja e filtrave ekuivalentë mund të ndryshojë; kushte të reja ose filtra të shprehur pa gjendje të ruajtur japin 422. Nisni kursor të ri. Kursorët e vjetër pa parametra të rinj ruajnë kërkesën e tyre.
is_auction pranon true/false/1/0. False përfshin false, null dhe flamurin e munguar; pa parametër nuk ka filtër. Duhet të përputhet me is_leasing në të njëjtin njoftim aktiv të domenit të lejuar; njoftime të tjera mund të mbeten në listings[].
Vendosni is_auction në kërkesën e parë: next_url dhe scroll_id ruajnë vlerën, përfshirë false. Ndryshimi i filtrit ose vlera e shprehur pa gjendje të ruajtur kthen 422.
Filloni pa scroll_id, pastaj kërkoni çdo next_url të pandryshuar derisa scroll_id të jetë null. Shihni udhëzuesin e sinkronizimit.
limit është 1–500 (parazgjedhja 500). scroll_time është 1–15 minuta (parazgjedhja 10).
Mbajini domains[] dhe is_leasing të njëjta për gjithë kalimin. Ndryshimi i tyre kthen 422.
total mund të jetë null nëse hyrja e tij në cache ka humbur.

Parametrat e query-t

limitinteger1–500 · default 500

Elemente për grup. Parazgjedhja 500; maksimumi 500. Për një eksportim të përdorshëm kërkohen vlera pozitive.

scroll_timeinteger1–15 · default 10

Jetëgjatësia e kursorit në minuta. Parazgjedhja 10, maksimumi 15.

scroll_idstring

Kursor i errët nga përgjigja e mëparshme. Preferohet ndjekja e next_url.

domains[]integer[]≥ 1

Shtrirje opsionale e burimeve. Përdorni ID-të e kthyera nga GET /domains. Hiqeni për të përdorur të gjitha domenet e aktivizuara. Përsëritni parametrin me kllapa: domains[]=33&domains[]=34. Çdo ID duhet të jetë e aktivizuar për këtë çelës.

is_leasingboolean

Filtër opsional i lizingut. Dërgoni true (ose 1) për shpalljet e shënuara shprehimisht is_leasing=true. Dërgoni false (ose 0) për të përjashtuar true, duke përfshirë false të ruajtur, null dhe fushat që mungojnë. Hiqeni për të mos filtruar sipas lizingut; vlerat bosh ose të pavlefshme kthejnë 422. Një makinë duhet të ketë të paktën një shpallje aktive që përputhet në shtrirjen e domeneve të aktivizuara/zgjedhura. Shpalljet e tjera mund të mbeten në përgjigje, prandaj makinat me lloje të përziera shpalljesh mund të përputhen me të dyja vlerat. Për /cars, vendoseni këtë në kërkesën e parë dhe ndiqni next_url të pandryshuar; false ruhet. Vazhdimi vetëm me scroll_id e ruan filtrin. Ndryshimi ose shtimi i filtrit gjatë scroll-it kthen 422. Nëse gjendja e filtrit në cache humbet ose scroll-i është më i vjetër se ky parametër, një vlerë eksplicite kthen 422; filloni një scroll të ri.

is_auctionboolean

Optional auction filter. Send true (or 1) for listings explicitly marked is_auction=true. Send false (or 0) to exclude true, including stored false, null and missing fields. Omit for no auction filter; empty or invalid values return 422. Combined is_auction and is_leasing must match the same listing. A car must have at least one matching active listing in the enabled/selected domain scope. Other listings can remain in the response, so cars with mixed listing types can match both values. For /cars, set this on the first request and follow next_url unchanged; false is preserved. Continuing with only scroll_id retains the filter. Changing or adding the filter mid-scroll returns 422. If cached filter state is lost or the scroll predates this parameter, an explicit value returns 422; start a new scroll.

vehicle_typestringdefault automobile

vehicle_type=automobile / 1 është parazgjedhja; motorcycle / 2 zgjedh motoçikleta në /search, /search/count dhe /cars. Përdorni të njëjtin lloj në fjalorë.

interior_colors[]integer[]≤ 100 items

ID-të e ngjyrave të brendshme nga fjalori i ngjyrave. Vlerat lidhen me OSE; vlerat që mungojnë nuk përputhen. Zbatohet në /search, /search/count dhe /cars. Mos e ndryshoni gjatë vazhdimit të scroll.

cylinders[]integer[]1–99 · ≤ 99 items

Numri i saktë i cilindrave (1–99), OSE brenda listës; vlerat e panjohura nuk përputhen. Zbatohet në /search, /search/count dhe /cars. Mos e ndryshoni gjatë vazhdimit të scroll.

brands[0][id]integer≥ 1

Hierarki e plotë: brands[] → models[] → generations[] → variants[] / trims[]. Çdo objekt marke, modeli dhe gjenerate kërkon id. OSE midis fqinjëve dhe vlerave variants/trims; DHE midis kushteve brenda një dege. Lista e munguar ose bosh nënkupton të gjithë pasardhësit. Deri në 100 elemente për listë. ID të panjohura ose të papajtueshme japin rezultat bosh; format i pavlefshëm — 422.

brands[0][models][]integer[]≥ 1 · ≤ 100 items

brands[0][models][]=573 ekzistues funksionon. Për pasardhës përdorni brands[0][models][0][id]=573. Pastroni fushën e vjetër të ID para objekteve të modeleve për atë markë, përndryshe PHP mbishkruan indeksin 0.

brands[0][models][0][id]integer≥ 1

brands[0][models][0][generations][0][id]integer≥ 1

brands[0][models][0][generations][0][variants][]integer[]≥ 1 · ≤ 100 items

brands[0][models][0][generations][0][trims][]integer[]≥ 1 · ≤ 100 items

langstring

Gjuha e përgjigjes. Përkthimet e opsioneve kufizohen gjithashtu nga gjuhët e llogarisë. Faqja e zgjedh automatikisht gjuhën e saj aktuale.

Fusha shtesë të njoftimeve

Ngarkoni /listing-fields pasi të kontrolloni çelësin. Përkufizimet, kufizimet, operatorët dhe shënimet vlejnë vetëm për atë çelës dhe domenet e zgjedhura.

Tekst: eq, in, exists. Numra dhe data edhe gt, gte, lt, lte. Boolean: eq ose exists. Përdorni eq, in, exists ose interval; exists veçmas. Deri në 20 fusha dhe 100 vlera në in.

Të gjitha kushtet, domenet dhe gjendja aktive duhet të përputhen në një njoftim. Zero dhe false janë vlera. Te vargjet mjafton një element që përputhet. Fushat/operatorët e panjohur ose të palejuar kthejnë 422.

Filtroni vetëm fushat filterable. Vlerat e indeksuara: listings[].custom_fields; të tjerat: listings[].source_data. Publikimi aktivizon filtrat; importet e zakonshme pasuese plotësojnë vlerat. Dokumentet e vjetra nuk plotësohen veçmas.

Në /cars kushtet ruhen për tërë scroll. Përkufizimi i papajtueshëm ose humbja e gjendjes së ruajtur kërkon scroll të ri. Renditja dhe agregimet nuk mbështeten.

Zëvendësoni FIELD_KEY me një çelës nga katalogu i lejuar. Për krahasime monetare vendosni monedhën e njoftimit; konvertimi Buy Now nuk zbatohet.

Vlerësimet historike të tregut nga burimi janë vlera informative pa indeksim. Përshkruajnë shitje të krahasueshme, jo çmimin, ofertën ose rezervën e këtij listimi. Kontrolloni përshkrimin e fushës, kriteret e krahasimit dhe datën e llogaritjes; mos supozoni monedhën e listimit. Fushat numerike të regjistruara mund të jenë null kur mungon vlerësimi.

custom_fields[FIELD_KEY][gte]=2
custom_fields[FIELD_KEY][in][]=a&custom_fields[FIELD_KEY][in][]=b
custom_fields[FIELD_KEY][eq]=false
custom_fields[FIELD_KEY][lte]=15000&custom_fields[FIELD_KEY][currency]=cad

Fusha shtesë të njoftimeve

Lidhni një çelës për të parë fushat e domeneve të lejuara.

Kthen · Një grup objektesh të plota Car në data, me next_url, scroll_id dhe total. Faqja e fundit ka scroll_id: null, data bosh dhe message: "No more data".

GET/cars

curl -g "https://api.auctionsapi.com/cars?limit=5&api_key=$CARS_API_KEY" \
  -H "Accept: application/json"

ShembujI regjistruar

{4 keys

"data": [1 item

0: {20 keys

"id": "290nw54Bkl-iPxZqEe_N"

"has_inspections": false

"has_history_reports": false

"year": 2007

"vin": "kmhdu46d27u158653"

"brand": {2 keys

}

"model": {2 keys

}

"engine_volume": 2000

"cylinders": 4

"body_type": {2 keys

}

"fuel": {2 keys

}

"color": {2 keys

}

"power_hp": 138

"market_origin": {2 keys

}

"drive_wheels": {2 keys

}

"option_ids": []

"listings": [1 item

]

"inspections": []

"vehicle_history_reports": []

"hash": "473326c69c007f50506c0cffdf30b08cf28e978d9ff2d5e7dca0dc75a54a3f6c"

}

]

"next_url": "https://api.carstat.dev/cars?scroll_id=FGluY2x1ZGVfY29udGV4dF91…&lang=en&api_key=YOUR_API_KEY&limit=2"

"scroll_id": "FGluY2x1ZGVfY29udGV4dF91…"

"total": 3217391

}

Merrni qasje në API

Lidhni çelësin për të ekzekutuar çdo kërkesë nga këto faqe me të dhënat tuaja. Ende pa çelës? Na kërkoni një çelës demo: i njëjti JSON si në planet me pagesë.

Kam një çelës