本文へ移動

API ドキュメント

v1.0.0

オークション

GET /api/v1/auctions

スコープ:auctions:read 1 クレジット

破産に関連するオークションを、案件との関連付けと出所とともに返します。

クエリパラメーター

クエリパラメーター
名前型説明
q

検索テキスト

string | null検索テキスト
closing enum | null today, 7d, 30d, null
category[] enum[] construction_machinery, vehicles, tools, stock, office_it, hospitality, real_estate, other
provider[] string[]
linked boolean | null
sector enum | null A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, null
curator string | null
postcode string | null
radius enum | null 10, 25, 50, 100, null
province enum | null Groningen, Fryslân, Drenthe, Overijssel, Flevoland, Gelderland, Utrecht, Noord-Holland, Zuid-Holland, Zeeland, Noord-Brabant, Limburg, null
sort

並べ替え

enum | null並べ替え closing, distance, newest, null
group enum | null case, null
page

ページ番号

integer | nullページ番号

応答、HTTP 200

応答、HTTP 200

応答、HTTP 200
名前型説明
data 必須 mixed[]
meta 必須 object
meta.total 必須 integer
meta.page 必須 integer
meta.last_page 必須 integer

応答、HTTP 422

Validation error

応答、HTTP 422

応答、HTTP 422
名前型説明
error 必須 object
error.code 必須

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message 必須

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

応答のフィールドは openapi.json に記載されています。各値が出典とともにどのように構成されているかは、次をご覧ください: データと出典文書