المطوّرون

نقاط النهاية تحت https://akilli.futbol/api/v1؛ والطلبات والاستجابات بصيغة JSON.

المرجع كاملًا متوفر أيضًا كمستند OpenAPI 3.1 يمكنك تحميله في Postman أو Insomnia أو في مولّد عملاء.

ملخصات نقاط النهاية وملاحظاتها مأخوذة مباشرة من مستند OpenAPI، لذا فهي بالإنجليزية.

118 نقطة نهاية في 17 قسمًا.

1. 1

   أنشئ حسابًا أو سجّل الدخول: أرسل اسم المستخدم وكلمة المرور بصيغة JSON إلى POST /api/auth/sign-up/username أو POST /api/auth/sign-in/username.

   curl -i -X POST https://akilli.futbol/api/auth/sign-in/username \
     -H "content-type: application/json" \
     -d '{"username": "deniz", "password": "kale-direği-1905"}'

2. 2

   احفظ الرمز المميّز الموقَّع من ترويسة الاستجابة set-auth-token في مكان آمن على الجهاز. لا يعمل رمزًا مميّزًا من نوع Bearer إلا هذا الرمز: أما token في جسم الاستجابة فهو رمز الجلسة الخام ويُرفض.

   HTTP/1.1 200 OK
   set-auth-token: P4cTUK….9e7wV6…=
   content-type: application/json
   
   {
     "redirect": false,
     "token": "P4cTUK…",
     "user": { "id": "0193…", "username": "deniz", "name": "Deniz", … }
   }

3. 3

   أرسل Authorization: Bearer <token> مع كل طلب.

   curl https://akilli.futbol/api/v1/me \
     -H "Authorization: Bearer P4cTUK….9e7wV6…="

في المتصفح تعمل ملفات تعريف ارتباط جلسة الويب أيضًا. كلمة المرور الخاطئة واسم المستخدم غير الموجود يحصلان على الخطأ نفسه (401)؛ والحسابات الموقوفة تحصل على 403 BANNED_USER. محاولات تسجيل الدخول محدودة لكل IP ولكل اسم مستخدم (429).

لتسجيل الخروج، أرسل POST /api/auth/sign-out؛ ولتسجيل الخروج من كل الأجهزة الأخرى، POST /api/auth/revoke-other-sessions. لا يحتاج أيٌّ منهما إلى جسم. لا تنتهي الجلسة إلا حين يردّ الطلب بـ 200، لذا تحقّق من رمز الحالة. تغيير كلمة المرور عبر POST /api/auth/change-password يُنهي كل الجلسات، بما فيها هذه الجلسة، ويردّ برمز مميّز جديد في set-auth-token: احفظه بدلًا من القديم.

تحمل الاستجابات الناجحة النتيجة في data. وتحمل الأخطاء في error رمزًا ورسالة مقروءة، وعند الحاجة رموز أخطاء لكل حقل (fields).

{
  "data": { … }
}

{
  "error": {
    "code": "INVALID",
    "message": "Some fields are invalid",
    "fields": { "name": "tooShort" }
  }
}

رموز الأخطاء

• 401UNAUTHENTICATEDلا توجد جلسة، أو الرمز المميّز غير صالح: سجّل الدخول مرة أخرى.
• 403FORBIDDENغير مسموح لك بفعل هذا.
• 404NOT_FOUNDغير موجود، أو لا يمكنك رؤيته.
• 409CONFLICTيتعارض الطلب مع الحالة الحالية؛ ويوضح fields السبب.
• 422INVALIDالجسم أو بعض الحقول غير صالحة؛ ويحتوي fields على رمز لكل حقل.
• 429RATE_LIMITEDطلبات كثيرة جدًا: انتظر قليلًا ثم حاول مرة أخرى.
• 500INTERNALحدث خطأ في الخادم: حاول مرة أخرى لاحقًا.

المسار غير المعروف تحت /api/v1 يردّ أيضًا بـ 404 NOT_FOUND بهذا الشكل؛ أما الطريقة التي لا يدعمها المسار فتحصل على 405 بجسم فارغ.

نقاط النهاية تحت /api/auth تابعة لـ Better Auth: تأتي استجاباتها بلا غلاف data، وتحمل أخطاؤها code وmessage.

• GET/api/v1/sign-up

  Whether new accounts can be made

  لا يحتاج إلى جلسة

  The apps hide sign-up while this is false; the sign-up endpoints then answer 403 SIGN_UP_CLOSED.

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • openbooleanإلزامي

    false during the private beta: only sign-in

• POST/api/auth/sign-up/username

  Create an account and sign in

  لا يحتاج إلى جلسة

  The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>. 403 SIGN_UP_CLOSED during the private beta (GET /api/v1/sign-up says whether sign-up is open). Rate-limited per IP: 20 per 10 minutes (429). 400 INVALID_SIGN_UP with an error code per field in errors: displayName: displayName; username: username (3–20 characters of a–z, 0–9 and _); password: password (12–128 characters), passwordIsUsername or passwordCommon; adult, privacyNotice, terms: required; form: generic (positions or locale not valid). 400 USERNAME_IS_ALREADY_TAKEN with errors.username = usernameTaken (reserved names count as taken). 400 VALIDATION_ERROR when a field is missing or has the wrong type. 403 for a sign-up a browser sends from another site.

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • displayNamestringإلزامي

    2–40 characters

  • usernamestringإلزامي

    3–20: a-z, 0-9, _ (stored lower-case)

  • passwordstringإلزامي

    12–128 characters; not a common password, not built from the username or name

  • positionsstring[]اختياري

    القيم: "goalkeeper", "defender", "midfielder", "forward"

  • adultbooleanإلزامي

    القيم: true

  • privacyNoticebooleanإلزامي

    القيم: true

  • termsbooleanإلزامي

    القيم: true

  • localestringإلزامي

    القيم: "tr", "en", "ru", "ar"

  جسم الاستجابة

  • userobjectإلزامي
    • idstringإلزامي
    • usernamestringإلزامي
• POST/api/auth/sign-in/username

  Sign in

  لا يحتاج إلى جلسة

  The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>. 401 INVALID_USERNAME_OR_PASSWORD for any wrong name or password; 403 BANNED_USER; 429 TOO_MANY_ATTEMPTS after repeated wrong passwords for the username, from any address, or 429 without a code past the per-IP limit (3 per 10 seconds).

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • usernamestringإلزامي
  • passwordstringإلزامي
  • rememberMebooleanاختياري

  جسم الاستجابة

  • redirectbooleanإلزامي

    Always false

  • tokenstringإلزامي

    The raw session token. It is refused as a bearer token: use the set-auth-token header. The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>.

  • userobjectإلزامي
    • idstringإلزامي
    • usernamestringإلزامي

      Lower-case; the profile address, /p/{username}

    • displayUsernamestringإلزامي
    • namestringإلزامي

      The display name

    • emailstringإلزامي

      Not an address: a random placeholder Better Auth needs (accounts have no email). Ignore it

    • emailVerifiedbooleanإلزامي
    • imagestring | nullإلزامي
    • rolestring | nullإلزامي

      "admin" or "user"

    • bannedboolean | nullإلزامي
    • banReasonstring | nullإلزامي
    • banExpiresstring | nullإلزامي
    • createdAtstringإلزامي
    • updatedAtstringإلزامي
• POST/api/auth/sign-in/apple

  Sign in with Apple (and create the account on first use)

  لا يحتاج إلى جلسة

  The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>. An Apple ID that already has an account signs in (403 BANNED_USER for a banned one). During the private beta a new Apple ID answers 403 SIGN_UP_CLOSED. Otherwise a new Apple ID answers 409 APPLE_SIGN_UP_REQUIRED with suggestion: { username, displayName } (from the email Apple shares, or the name; the email is never stored and never signs anyone in) until the call comes back with username, displayName, and adult, privacyNotice and terms true: then the account is made like sign-up's, with no password. Field errors as sign-up's: 400 INVALID_SIGN_UP with errors, 400 USERNAME_IS_ALREADY_TAKEN. 401 INVALID_APPLE_TOKEN when the token does not verify (signature, issuer, audience, expiry or nonce); 503 APPLE_UNAVAILABLE when Apple's keys cannot be fetched. Rate-limited per IP: 30 per 10 minutes.

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • identityTokenstringإلزامي

    The identity token from Sign in with Apple on the device

  • noncestringإلزامي

    The raw nonce the app made for this request; the token carries its SHA-256 hex

  • authorizationCodestringاختياري

    Lets the server revoke Apple's tokens when the account is deleted

  • givenNamestringاختياري

    Apple shares the name on the first authorization only: pass it on

  • familyNamestringاختياري
  • usernamestringاختياري

    For a new account: 3–20 a-z, 0-9, _ (start from suggestion.username)

  • displayNamestringاختياري

    For a new account: 2–40 characters (start from suggestion.displayName)

  • positionsstring[]اختياري

    القيم: "goalkeeper", "defender", "midfielder", "forward"

  • adultbooleanاختياري

    For a new account: true

  • privacyNoticebooleanاختياري

    For a new account: true

  • termsbooleanاختياري

    For a new account: true

  • localestringإلزامي

    القيم: "tr", "en", "ru", "ar"

  جسم الاستجابة

  • userobjectإلزامي
    • idstringإلزامي
    • usernamestringإلزامي
  • createdbooleanإلزامي

    true when this call made the account

• POST/api/auth/is-username-available

  Check whether a username is free

  لا يحتاج إلى جلسة

  What the sign-up form asks as you type. Reserved names (staff words, the brand, app routes such as destek or developers) and names in use answer available: false, as sign-up would refuse them. 422 USERNAME_TOO_SHORT, USERNAME_TOO_LONG or INVALID_USERNAME (3–20 characters of a–z, 0–9 and _). Rate-limited per IP: 30 per minute (429).

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • usernamestringإلزامي

    As typed: it is checked after the same normalising as sign-up (Turkish letters folded, lower-cased)

  جسم الاستجابة

  • availablebooleanإلزامي
• POST/api/auth/sign-out

  Sign out (ends this session)

  يحتاج إلى جلسة

  The session ends only when this answers 200 { success: true }; after any other answer the token may still work. Forget the stored token either way.

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  لا توجد حقول.

  جسم الاستجابة

  • successbooleanإلزامي
• GET/api/auth/get-session

  The current session and user

  يحتاج إلى جلسة

  Answers 200 with null, not 401, when there is no valid session.

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الاستجابة

  • sessionobjectإلزامي
    • idstringإلزامي
    • userIdstringإلزامي
    • tokenstringإلزامي

      The raw session token. It is refused as a bearer token: use the set-auth-token header. The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>.

    • expiresAtstringإلزامي

      ISO 8601. A session lasts 7 days and is extended, at most once a day, while it is used

    • createdAtstringإلزامي
    • updatedAtstringإلزامي
    • ipAddressstring | nullإلزامي
    • userAgentstring | nullإلزامي
    • impersonatedBystring | nullإلزامي
  • userobjectإلزامي
    • idstringإلزامي
    • usernamestringإلزامي

      Lower-case; the profile address, /p/{username}

    • displayUsernamestringإلزامي
    • namestringإلزامي

      The display name

    • emailstringإلزامي

      Not an address: a random placeholder Better Auth needs (accounts have no email). Ignore it

    • emailVerifiedbooleanإلزامي
    • imagestring | nullإلزامي
    • rolestring | nullإلزامي

      "admin" or "user"

    • bannedboolean | nullإلزامي
    • banReasonstring | nullإلزامي
    • banExpiresstring | nullإلزامي
    • createdAtstringإلزامي
    • updatedAtstringإلزامي
• POST/api/auth/change-password

  Change the password

  يحتاج إلى جلسة

  Signs every session out, this one included, and starts a new one: replace the stored token with the new set-auth-token response header (a browser gets a new cookie). Every other device has to sign in again. A revokeOtherSessions field is ignored. 400 INVALID_PASSWORD (the current password is wrong), PASSWORD_TOO_SHORT, PASSWORD_TOO_LONG, PASSWORD_IS_USERNAME or PASSWORD_TOO_COMMON (a common word or a password built from the username or name); 401 without a valid session.

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • currentPasswordstringإلزامي
  • newPasswordstringإلزامي

    12–128 characters; not the username, nothing common or built from the username or name

  جسم الاستجابة

  • tokenstringإلزامي

    The raw session token. It is refused as a bearer token: use the set-auth-token header. The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>.

  • userobjectإلزامي
    • idstringإلزامي
    • usernamestringإلزامي

      Lower-case; the profile address, /p/{username}

    • displayUsernamestringإلزامي
    • namestringإلزامي

      The display name

    • emailstringإلزامي

      Not an address: a random placeholder Better Auth needs (accounts have no email). Ignore it

    • emailVerifiedbooleanإلزامي
    • imagestring | nullإلزامي
    • rolestring | nullإلزامي

      "admin" or "user"

    • bannedboolean | nullإلزامي
    • banReasonstring | nullإلزامي
    • banExpiresstring | nullإلزامي
    • createdAtstringإلزامي
    • updatedAtstringإلزامي
• POST/api/auth/revoke-other-sessions

  Sign out every other device

  يحتاج إلى جلسة

  This device stays signed in. The other sessions end only when this answers 200 { status: true }; after any other answer they may still work, so try again.

  نقطة نهاية من Better Auth: تأتي الاستجابة بلا غلاف data.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  لا توجد حقول.

  جسم الاستجابة

  • statusbooleanإلزامي

• GET/api/v1/me

  Your profile settings

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • idstringإلزامي

    The player id

  • userIdstringإلزامي
  • usernamestringإلزامي

    Fixed: the profile address, /p/{username}

  • handlestringإلزامي
  • displayNamestringإلزامي
  • positionsstring[]إلزامي

    القيم: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullإلزامي

    Your profile photo (PUT /api/v1/me/photo), or null

    • smallstringإلزامي

      128 px

    • mediumstringإلزامي

      512 px

    • largestringإلزامي

      1024 px

  • visibilitystringإلزامي

    Who sees your stats, teams and match history. public: everyone; teammates: people who share a team with you or a match you took part in; private: nobody else

    القيم: "public", "teammates", "private"

  • rolestring | nullإلزامي

    "admin" or "user"

  • activeSessionsintegerإلزامي

    Signed-in devices, this one included

  • appleLinkedbooleanإلزامي

    Sign in with Apple opens this account (POST/DELETE /api/v1/me/apple)

  • hasPasswordbooleanإلزامي

    The account has a password; an account made with Sign in with Apple has none

• PATCH/api/v1/me

  Change your display name, positions or visibility

  يحتاج إلى جلسة

  422 INVALID with fields.displayName = required | tooShort | tooLong | invalid, or fields.username = immutable when a different username is sent (the username never changes). Change the password at /api/auth/change-password; sign out other devices at /api/auth/revoke-other-sessions.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • displayNamestringاختياري

    1 أحرف على الأقل

  • positionsstring[]اختياري

    القيم: "goalkeeper", "defender", "midfielder", "forward"

  • visibilitystringاختياري

    القيم: "public", "teammates", "private"

  data في الاستجابة

  • idstringإلزامي

    The player id

  • userIdstringإلزامي
  • usernamestringإلزامي

    Fixed: the profile address, /p/{username}

  • handlestringإلزامي
  • displayNamestringإلزامي
  • positionsstring[]إلزامي

    القيم: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullإلزامي

    Your profile photo (PUT /api/v1/me/photo), or null

    • smallstringإلزامي

      128 px

    • mediumstringإلزامي

      512 px

    • largestringإلزامي

      1024 px

  • visibilitystringإلزامي

    Who sees your stats, teams and match history. public: everyone; teammates: people who share a team with you or a match you took part in; private: nobody else

    القيم: "public", "teammates", "private"

  • rolestring | nullإلزامي

    "admin" or "user"

  • activeSessionsintegerإلزامي

    Signed-in devices, this one included

  • appleLinkedbooleanإلزامي

    Sign in with Apple opens this account (POST/DELETE /api/v1/me/apple)

  • hasPasswordbooleanإلزامي

    The account has a password; an account made with Sign in with Apple has none

• DELETE/api/v1/me

  Delete your account

  يحتاج إلى جلسة

  Signs out everywhere and deletes the login (password, Sign in with Apple, whose tokens are revoked), push devices, the photo and team memberships; the username is free again. Matches you played keep their scores and stats under the name "Silinmiş oyuncu" (Deleted player), with no profile. A team you captain passes to a co-captain or the longest-standing member; a team left empty is archived. Answers to coming matches become "no" and pending booking requests are withdrawn. Forget the stored token afterwards. 422 fields.confirm = mismatch.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • confirmstringإلزامي

    Your username, as a confirmation (any case)

  data في الاستجابة

  • deletedbooleanإلزامي

    القيم: true

• POST/api/v1/me/apple

  Link Sign in with Apple to your account

  يحتاج إلى جلسة

  From then on Sign in with Apple (POST /api/auth/sign-in/apple) opens this account. The email Apple may share is not stored. 401 UNAUTHENTICATED with fields.identityToken = invalid for a token that does not verify; 409 CONFLICT with fields.form = appleTaken (the Apple ID belongs to another account) or appleLinked (another Apple ID is linked).

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • identityTokenstringإلزامي

    The identity token from Sign in with Apple on the device

  • noncestringإلزامي

    The raw nonce the app made for this request; the token carries its SHA-256 hex

  • authorizationCodestringاختياري

    Lets the server revoke Apple's tokens when the account is deleted

  data في الاستجابة

  • linkedbooleanإلزامي

    القيم: true

• DELETE/api/v1/me/apple

  Unlink Sign in with Apple

  يحتاج إلى جلسة

  Apple's tokens are revoked. 409 CONFLICT with fields.form = lastSignInMethod when the account has no password (Apple is its only way in).

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • linkedbooleanإلزامي

    القيم: false

• POST/api/v1/me/devices

  Register this phone for pushes

  يحتاج إلى جلسة

  Send the APNs device token after sign-in and whenever iOS hands out a new one. The same token registered again refreshes it; signed in to another account on the phone, it moves to that account. Pushes so far: a match invitation (when you or one of your teams is invited), payload { "aps": { "alert": { "title", "body" }, "sound": "default", "category": "MATCH_INVITE", "thread-id": "match-<matchId>" }, "type": "matchInvite", "matchId", "teamName"? }, written in locale. The app's MATCH_INVITE category carries the buttons RSVP_YES, RSVP_MAYBE and RSVP_NO; answer with POST /api/v1/matches/{id}/rsvp. A person keeps their 10 most recently seen devices. 422 fields.token = invalid (not hex), fields.bundleId = unknown (not the Akıllı Futbol app). 429 after 30 registrations an hour.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • tokenstringإلزامي

    The APNs device token as hex (64 characters today)

  • platformstringإلزامي

    القيم: "ios"

  • environmentstringإلزامي

    sandbox for development builds (Xcode), production for TestFlight and the App Store

    القيم: "sandbox", "production"

  • bundleIdstringإلزامي

    The app's bundle identifier

    1–200 حرفًا

  • localestringإلزامي

    The language pushes are written in

    القيم: "tr", "en", "ru", "ar"

  data في الاستجابة

  • idstringإلزامي

    The device id

  • tokenstringإلزامي

    The token as stored: lower-case hex

• DELETE/api/v1/me/devices/{token}

  Stop pushes to one of your devices

  يحتاج إلى جلسة

  Call it at sign-out, before the session ends. Another person's token is left alone.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • tokenstringإلزامي

  data في الاستجابة

  • removedbooleanإلزامي

    False when the token was not registered to you

• GET/api/v1/me/photo

  Your profile photo

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • photoobject | nullإلزامي

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringإلزامي

      128 px

    • mediumstringإلزامي

      512 px

    • largestringإلزامي

      1024 px

• PUT/api/v1/me/photo

  Upload or replace your profile photo

  يحتاج إلى جلسة

  Send the photo as the body (Content-Type: image/jpeg, image/png or image/webp), or as multipart/form-data with the file in the photo field. Up to 10 MB, at least 256 px on its shorter side. The server turns it upright by its EXIF orientation, cuts the largest centred square (crop it yourself first to choose), and stores WebP copies without any metadata: location, camera and time are dropped. The photo is seen by whoever may see your stats (your visibility), and never used to recognise anyone in match videos. 422 INVALID with fields.file = required | type | tooBig | dimensions.

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • photoobject | nullإلزامي

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringإلزامي

      128 px

    • mediumstringإلزامي

      512 px

    • largestringإلزامي

      1024 px

• DELETE/api/v1/me/photo

  Remove your profile photo

  يحتاج إلى جلسة

  Your initials show again. Fine without a photo.

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • photoobject | nullإلزامي

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringإلزامي

      128 px

    • mediumstringإلزامي

      512 px

    • largestringإلزامي

      1024 px

• GET/api/v1/teams

  Teams the caller plays for (archived teams left out)

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  النوع: object[]

  حقول كل عنصر:

  • idstring (uuid)إلزامي
  • slugstringإلزامي

    URL slug, e.g. kartallar-7k2m

  • namestringإلزامي
  • citystring | nullإلزامي
  • kitHomeHexstringإلزامي

    #rrggbb, lower-case

  • kitAwayHexstring | nullإلزامي

    #rrggbb, lower-case

  • crestobject | nullإلزامي

    Custom crest, or null to use the team name and kit colours

    • shapestringإلزامي

      القيم: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringإلزامي
    • secondarystringإلزامي
    • letterstringإلزامي
    • patternstringاختياري

      القيم: "plain", "split", "stripes", "sash", "chevron", "hoops"الافتراضي: "plain"

    • detailstringاختياري

      القيم: "none", "star", "ball", "crown", "laurel", "wings"الافتراضي: "none"

  • rolestringإلزامي

    The caller's role in the team

    القيم: "captain", "co_captain", "member"

  • memberCountintegerإلزامي
• POST/api/v1/teams

  Start a team. The caller becomes captain and a 6-letter invite code is issued. Name and city are stored NFKC-normalised with single spaces. An optional crest has a shape, two distinct #rrggbb colours, one Unicode letter, a pattern (default plain) and a detail (default none). Field errors: name required/tooShort/tooLong/invalid (hidden or text-direction characters)/staffWord (reads as staff: “Akıllı Futbol”, “Admin”, “Destek”…), city tooLong/invalid, kitHomeHex required/invalid, kitAwayHex invalid/sameAsHome, crest.shape/primary/secondary/letter/pattern/detail invalid (equal colours: crest.secondary=differentColour).

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • namestringإلزامي

    2–40 حرفًا

  • citystring | nullاختياري

    60 حرفًا على الأكثر

  • kitHomeHexstringإلزامي
  • kitAwayHexstring | nullاختياري
  • crestobject | nullاختياري
    • shapestringإلزامي

      القيم: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringإلزامي
    • secondarystringإلزامي
    • letterstringإلزامي
    • patternstringاختياري

      القيم: "plain", "split", "stripes", "sash", "chevron", "hoops"الافتراضي: "plain"

    • detailstringاختياري

      القيم: "none", "star", "ball", "crown", "laurel", "wings"الافتراضي: "none"

  data في الاستجابة

  • idstring (uuid)إلزامي
  • slugstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • kitHomeHexstringإلزامي

    #rrggbb, lower-case

  • kitAwayHexstring | nullإلزامي

    #rrggbb, lower-case

  • crestobject | nullإلزامي
    • shapestringإلزامي

      القيم: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringإلزامي
    • secondarystringإلزامي
    • letterstringإلزامي
    • patternstringاختياري

      القيم: "plain", "split", "stripes", "sash", "chevron", "hoops"الافتراضي: "plain"

    • detailstringاختياري

      القيم: "none", "star", "ball", "crown", "laurel", "wings"الافتراضي: "none"

  • archivedAtstring (date-time) | nullإلزامي
  • createdAtstring (date-time)إلزامي
  • memberCountintegerإلزامي
  • viewerobjectإلزامي
    • rolestring | nullإلزامي

      Null for an admin who is not a member

      القيم: "captain", "co_captain", "member"

    • canEditbooleanإلزامي
    • canRotateCodebooleanإلزامي
    • canArchivebooleanإلزامي
    • mustHandOverbooleanإلزامي

      The caller is the last captain: leaving needs a new captain first

    • onlyMemberbooleanإلزامي

      Leaving would archive the team

  • codestring | nullإلزامي

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullإلزامي

    The link to share (a short /j/<code> link that opens the join page)

  • membersobject[]إلزامي

    Captains first, then co-captains, then players

    • playerIdstring (uuid)إلزامي
    • displayNamestringإلزامي
    • handlestring | nullإلزامي

      Null for guests

    • kindstringإلزامي

      القيم: "registered", "guest"

    • positionsstring[]إلزامي

      Follows the member's visibility, as on their profile: empty when it is private, unless it is your own or you are an admin

      القيم: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullإلزامي

      Follows the member's visibility, like the positions

      • smallstringإلزامي

        128 px

      • mediumstringإلزامي

        512 px

      • largestringإلزامي

        1024 px

    • rolestringإلزامي

      القيم: "captain", "co_captain", "member"

    • numberinteger | nullإلزامي
    • joinedAtstring (date-time)إلزامي
    • isViewerbooleanإلزامي
    • canobjectإلزامي
      • rolesstring[]إلزامي

        Roles the caller may give this member

        القيم: "captain", "co_captain", "member"

      • removebooleanإلزامي
  • matchesobjectإلزامي

    Up to 5 each

    • upcomingobject[]إلزامي
      • idstring (uuid)إلزامي
      • startsAtstring (date-time)إلزامي
      • statusstringإلزامي

        القيم: "planned", "played", "cancelled"

      • titlestring | nullإلزامي
      • venueobject | nullإلزامي
        • namestringإلزامي
        • verifiedbooleanإلزامي
      • sidesobject[]إلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsinteger | nullإلزامي
        • oursbooleanإلزامي

          This team plays on this side

    • recentobject[]إلزامي
      • idstring (uuid)إلزامي
      • startsAtstring (date-time)إلزامي
      • statusstringإلزامي

        القيم: "planned", "played", "cancelled"

      • titlestring | nullإلزامي
      • venueobject | nullإلزامي
        • namestringإلزامي
        • verifiedbooleanإلزامي
      • sidesobject[]إلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsinteger | nullإلزامي
        • oursbooleanإلزامي

          This team plays on this side

• GET/api/v1/teams/{slug}

  A team: roster, the caller's permissions, the invite code and matches. 404 unless the caller is a member or an admin.

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • slugstringإلزامي

  data في الاستجابة

  • idstring (uuid)إلزامي
  • slugstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • kitHomeHexstringإلزامي

    #rrggbb, lower-case

  • kitAwayHexstring | nullإلزامي

    #rrggbb, lower-case

  • crestobject | nullإلزامي
    • shapestringإلزامي

      القيم: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringإلزامي
    • secondarystringإلزامي
    • letterstringإلزامي
    • patternstringاختياري

      القيم: "plain", "split", "stripes", "sash", "chevron", "hoops"الافتراضي: "plain"

    • detailstringاختياري

      القيم: "none", "star", "ball", "crown", "laurel", "wings"الافتراضي: "none"

  • archivedAtstring (date-time) | nullإلزامي
  • createdAtstring (date-time)إلزامي
  • memberCountintegerإلزامي
  • viewerobjectإلزامي
    • rolestring | nullإلزامي

      Null for an admin who is not a member

      القيم: "captain", "co_captain", "member"

    • canEditbooleanإلزامي
    • canRotateCodebooleanإلزامي
    • canArchivebooleanإلزامي
    • mustHandOverbooleanإلزامي

      The caller is the last captain: leaving needs a new captain first

    • onlyMemberbooleanإلزامي

      Leaving would archive the team

  • codestring | nullإلزامي

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullإلزامي

    The link to share (a short /j/<code> link that opens the join page)

  • membersobject[]إلزامي

    Captains first, then co-captains, then players

    • playerIdstring (uuid)إلزامي
    • displayNamestringإلزامي
    • handlestring | nullإلزامي

      Null for guests

    • kindstringإلزامي

      القيم: "registered", "guest"

    • positionsstring[]إلزامي

      Follows the member's visibility, as on their profile: empty when it is private, unless it is your own or you are an admin

      القيم: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullإلزامي

      Follows the member's visibility, like the positions

      • smallstringإلزامي

        128 px

      • mediumstringإلزامي

        512 px

      • largestringإلزامي

        1024 px

    • rolestringإلزامي

      القيم: "captain", "co_captain", "member"

    • numberinteger | nullإلزامي
    • joinedAtstring (date-time)إلزامي
    • isViewerbooleanإلزامي
    • canobjectإلزامي
      • rolesstring[]إلزامي

        Roles the caller may give this member

        القيم: "captain", "co_captain", "member"

      • removebooleanإلزامي
  • matchesobjectإلزامي

    Up to 5 each

    • upcomingobject[]إلزامي
      • idstring (uuid)إلزامي
      • startsAtstring (date-time)إلزامي
      • statusstringإلزامي

        القيم: "planned", "played", "cancelled"

      • titlestring | nullإلزامي
      • venueobject | nullإلزامي
        • namestringإلزامي
        • verifiedbooleanإلزامي
      • sidesobject[]إلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsinteger | nullإلزامي
        • oursbooleanإلزامي

          This team plays on this side

    • recentobject[]إلزامي
      • idstring (uuid)إلزامي
      • startsAtstring (date-time)إلزامي
      • statusstringإلزامي

        القيم: "planned", "played", "cancelled"

      • titlestring | nullإلزامي
      • venueobject | nullإلزامي
        • namestringإلزامي
        • verifiedbooleanإلزامي
      • sidesobject[]إلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsinteger | nullإلزامي
        • oursbooleanإلزامي

          This team plays on this side

• PATCH/api/v1/teams/{slug}

  Edit name, city, kits and crest (captains and co-captains). Only the top-level fields sent change; send the whole crest to replace it. Null clears city, kitAwayHex or crest. A crest has a shape, two distinct #rrggbb colours, one Unicode letter, a pattern (default plain) and a detail (default none). Crest errors use crest.shape/primary/secondary/letter/pattern/detail; equal colours give crest.secondary=differentColour. The slug never changes.

  يحتاج إلى جلسة

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • slugstringإلزامي

  جسم الطلب

  • namestringاختياري

    2–40 حرفًا

  • citystring | nullاختياري

    60 حرفًا على الأكثر

  • kitHomeHexstringاختياري
  • kitAwayHexstring | nullاختياري
  • crestobject | nullاختياري
    • shapestringإلزامي

      القيم: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringإلزامي
    • secondarystringإلزامي
    • letterstringإلزامي
    • patternstringاختياري

      القيم: "plain", "split", "stripes", "sash", "chevron", "hoops"الافتراضي: "plain"

    • detailstringاختياري

      القيم: "none", "star", "ball", "crown", "laurel", "wings"الافتراضي: "none"

  data في الاستجابة

  • idstring (uuid)إلزامي
  • slugstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • kitHomeHexstringإلزامي

    #rrggbb, lower-case

  • kitAwayHexstring | nullإلزامي

    #rrggbb, lower-case

  • crestobject | nullإلزامي
    • shapestringإلزامي

      القيم: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringإلزامي
    • secondarystringإلزامي
    • letterstringإلزامي
    • patternstringاختياري

      القيم: "plain", "split", "stripes", "sash", "chevron", "hoops"الافتراضي: "plain"

    • detailstringاختياري

      القيم: "none", "star", "ball", "crown", "laurel", "wings"الافتراضي: "none"

  • archivedAtstring (date-time) | nullإلزامي
  • createdAtstring (date-time)إلزامي
  • memberCountintegerإلزامي
  • viewerobjectإلزامي
    • rolestring | nullإلزامي

      Null for an admin who is not a member

      القيم: "captain", "co_captain", "member"

    • canEditbooleanإلزامي
    • canRotateCodebooleanإلزامي
    • canArchivebooleanإلزامي
    • mustHandOverbooleanإلزامي

      The caller is the last captain: leaving needs a new captain first

    • onlyMemberbooleanإلزامي

      Leaving would archive the team

  • codestring | nullإلزامي

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullإلزامي

    The link to share (a short /j/<code> link that opens the join page)

  • membersobject[]إلزامي

    Captains first, then co-captains, then players

    • playerIdstring (uuid)إلزامي
    • displayNamestringإلزامي
    • handlestring | nullإلزامي

      Null for guests

    • kindstringإلزامي

      القيم: "registered", "guest"

    • positionsstring[]إلزامي

      Follows the member's visibility, as on their profile: empty when it is private, unless it is your own or you are an admin

      القيم: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullإلزامي

      Follows the member's visibility, like the positions

      • smallstringإلزامي

        128 px

      • mediumstringإلزامي

        512 px

      • largestringإلزامي

        1024 px

    • rolestringإلزامي

      القيم: "captain", "co_captain", "member"

    • numberinteger | nullإلزامي
    • joinedAtstring (date-time)إلزامي
    • isViewerbooleanإلزامي
    • canobjectإلزامي
      • rolesstring[]إلزامي

        Roles the caller may give this member

        القيم: "captain", "co_captain", "member"

      • removebooleanإلزامي
  • matchesobjectإلزامي

    Up to 5 each

    • upcomingobject[]إلزامي
      • idstring (uuid)إلزامي
      • startsAtstring (date-time)إلزامي
      • statusstringإلزامي

        القيم: "planned", "played", "cancelled"

      • titlestring | nullإلزامي
      • venueobject | nullإلزامي
        • namestringإلزامي
        • verifiedbooleanإلزامي
      • sidesobject[]إلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsinteger | nullإلزامي
        • oursbooleanإلزامي

          This team plays on this side

    • recentobject[]إلزامي
      • idstring (uuid)إلزامي
      • startsAtstring (date-time)إلزامي
      • statusstringإلزامي

        القيم: "planned", "played", "cancelled"

      • titlestring | nullإلزامي
      • venueobject | nullإلزامي
        • namestringإلزامي
        • verifiedbooleanإلزامي
      • sidesobject[]إلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsinteger | nullإلزامي
        • oursbooleanإلزامي

          This team plays on this side

• POST/api/v1/teams/{slug}/code

  Replace the invite code (captains and co-captains); the old code stops working at once

  يحتاج إلى جلسة

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • slugstringإلزامي

  data في الاستجابة

  • codestringإلزامي
  • inviteUrlstring (uri)إلزامي
• PATCH/api/v1/teams/{slug}/members/{playerId}

  Change a member's role. Captains and co-captains manage players and co-captains; only captains make or change captains (403 fields.form=captainOnly). The last captain cannot step down (409 fields.form=lastCaptain). A player who is not (or no longer) on the team: 404 fields.form=memberGone.

  يحتاج إلى جلسة

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • slugstringإلزامي
  • playerIdstringإلزامي

  جسم الطلب

  • rolestringإلزامي

    القيم: "captain", "co_captain", "member"

  data في الاستجابة

  • playerIdstring (uuid)إلزامي
  • rolestringإلزامي

    القيم: "captain", "co_captain", "member"

• DELETE/api/v1/teams/{slug}/members/{playerId}

  Remove a member (same rules as roles; 404 fields.form=memberGone when they are not on the team). Removing yourself is leaving.

  يحتاج إلى جلسة

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • slugstringإلزامي
  • playerIdstringإلزامي

  data في الاستجابة

  • archivedbooleanإلزامي
• POST/api/v1/teams/{slug}/leave

  Leave the team. The last captain must make someone else captain first (409 fields.form=handOver); the last member leaving archives the team.

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • slugstringإلزامي

  data في الاستجابة

  • archivedbooleanإلزامي

    The team is archived after this

• POST/api/v1/teams/{slug}/archive

  Archive the team (captains only): it leaves everyone's list and its code stops working; matches and stats stay

  يحتاج إلى جلسة

  403 fields.form=captainOnly for co-captains and players.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • slugstringإلزامي

  data في الاستجابة

  • archivedAtstring (date-time)إلزامي

• GET/api/v1/join/{code}

  What a six-letter code opens: a team or a match

  لا يحتاج إلى جلسة

  Codes are case-insensitive; dashes and spaces are ignored. Signed out, the preview has counts but no names. The code a match had when it was cancelled, and the code a team had when it was closed, keep opening the preview (state: cancelled, archived: true) so the link explains itself; codes replaced before that are revoked. 404 NOT_FOUND with fields.code: invalid (not six code letters), unknown or revoked (replaced by a newer code). 429 RATE_LIMITED after 20 wrong codes in 15 minutes (per account; signed out, per address, or in one count shared by every caller whose address cannot be trusted); malformed codes are not counted.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • codestringإلزامي

  data في الاستجابة

  • kindstringإلزامي

    القيم: "team", "match"

  • codestringإلزامي

    The canonical code: six capital letters

  • teamobjectاختياري
    • idstringإلزامي
    • slugstringإلزامي
    • namestringإلزامي
    • citystring | nullإلزامي
    • kitHomeHexstringإلزامي

      #rrggbb

    • kitAwayHexstring | nullإلزامي
    • memberCountintegerإلزامي
    • captainobject | nullإلزامي

      Null when signed out

      • idstringإلزامي
      • displayNamestringإلزامي
      • handlestring | nullإلزامي
      • photoobject | nullإلزامي

        Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

        • smallstringإلزامي

          128 px

        • mediumstringإلزامي

          512 px

        • largestringإلزامي

          1024 px

    • archivedbooleanإلزامي

      Closed teams take no new members

  • viewerobjectإلزامي
    • signedInbooleanإلزامي
    • memberbooleanإلزامي
    • rolestring | nullإلزامي

      القيم: "captain", "co_captain", "member"

    • canJoinbooleanإلزامي
  • matchobjectاختياري
    • idstringإلزامي
    • kindstringإلزامي

      القيم: "fixture", "pickup"

    • statusstringإلزامي

      القيم: "planned", "played", "cancelled"

    • statestringإلزامي

      Answers are taken while open: not cancelled, not played and no score in yet. Kick-off does not close a match, so people can still join one they played.

      القيم: "open", "cancelled", "finished"

    • titlestring | nullإلزامي
    • startsAtstringإلزامي

      ISO 8601

    • durationMinintegerإلزامي
    • venueobject | nullإلزامي
      • namestringإلزامي
      • citystring | nullإلزامي
      • districtstring | nullإلزامي
      • addressstring | nullإلزامي
      • verifiedbooleanإلزامي
    • pitchobject | nullإلزامي
      • namestringإلزامي
      • indoorbooleanإلزامي
    • sidesobject[]إلزامي
      • sidestringإلزامي

        القيم: "A", "B"

      • labelstringإلزامي
      • goalsinteger | nullإلزامي
      • teamobject | nullإلزامي
        • slugstringإلزامي
        • namestringإلزامي
    • comingobjectإلزامي

      Yes answers per side (none: no side yet) and the number of maybes

      • Aintegerإلزامي
      • Bintegerإلزامي
      • noneintegerإلزامي
      • totalintegerإلزامي
      • maybeintegerإلزامي
    • playersobject[]إلزامي

      Who said yes or maybe; empty when signed out

      • idstringإلزامي
      • displayNamestringإلزامي
      • sidestring | nullإلزامي

        القيم: "A", "B"

      • rsvpstringإلزامي

        القيم: "yes", "maybe"

      • youbooleanإلزامي
      • photoobject | nullإلزامي

        Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

        • smallstringإلزامي

          128 px

        • mediumstringإلزامي

          512 px

        • largestringإلزامي

          1024 px

    • organizerobject | nullإلزامي

      Null when signed out

      • displayNamestringإلزامي
• POST/api/v1/join/{code}

  Use a code: join the team, or answer the match invitation

  يحتاج إلى جلسة

  A team code makes you a member (again is a no-op: alreadyMember); closed teams answer 409 with fields.team = archived. A match code records your answer and puts you on your team's side; cancelled matches and matches with a score answer 409 with fields.match = cancelled | finished. 404 NOT_FOUND with fields.code: invalid (not six code letters), unknown or revoked (replaced by a newer code). 429 RATE_LIMITED after 20 wrong codes in 15 minutes (per account; signed out, per address, or in one count shared by every caller whose address cannot be trusted); malformed codes are not counted.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • codestringإلزامي

  جسم الطلب

  • rsvpstringاختياري

    Match codes only; defaults to yes. Ignored for team codes.

    القيم: "yes", "maybe", "no"

  data في الاستجابة

  • kindstringإلزامي

    القيم: "team", "match"

  • teamobjectاختياري
    • idstringإلزامي
    • slugstringإلزامي
    • namestringإلزامي
  • rolestringاختياري

    القيم: "captain", "co_captain", "member"

  • alreadyMemberbooleanاختياري
  • matchobjectاختياري
    • idstringإلزامي
  • participantobjectاختياري
    • rsvpstringإلزامي

      القيم: "invited", "yes", "maybe", "no"

    • sidestring | nullإلزامي

      The side of the person's team, when they are in one

      القيم: "A", "B"

    • respondedAtstring | nullإلزامي

• GET/api/v1/matches

  My matches: upcoming (soonest first) and past (latest first)

  يحتاج إلى جلسة

  At most 60 upcoming matches and the 40 latest past ones, with no further pages yet.

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • upcomingobject[]إلزامي
    • idstringإلزامي
    • titlestring | nullإلزامي
    • kindstringإلزامي

      القيم: "pickup", "fixture"

    • statusstringإلزامي

      القيم: "planned", "played", "cancelled"

    • startsAtstringإلزامي

      ISO 8601 (UTC)

    • durationMinnumberإلزامي
    • scoreStatestringإلزامي

      القيم: "none", "entered", "confirmed"

    • venueobject | nullإلزامي
      • namestringإلزامي
      • districtstring | nullإلزامي
      • citystring | nullإلزامي
      • addressstring | nullإلزامي
      • verifiedbooleanإلزامي
      • latitudenumber | nullإلزامي

        WGS84, when the venue set its location (for directions); null otherwise

      • longitudenumber | nullإلزامي

        WGS84, when the venue set its location (for directions); null otherwise

    • pitchobject | nullإلزامي
      • namestringإلزامي
    • sidesobjectإلزامي
      • Aobjectإلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsnumber | nullإلزامي

          Null until the score is entered

        • bibHexstring | nullإلزامي
        • teamIdstring | nullإلزامي
        • teamNamestring | nullإلزامي
      • Bobjectإلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsnumber | nullإلزامي

          Null until the score is entered

        • bibHexstring | nullإلزامي
        • teamIdstring | nullإلزامي
        • teamNamestring | nullإلزامي
    • comingnumberإلزامي

      How many said "yes"

    • meobjectإلزامي
      • rsvpstring | nullإلزامي

        القيم: "invited", "yes", "maybe", "no"

      • sidestring | nullإلزامي

        القيم: "A", "B"

      • isOrganizerbooleanإلزامي
    • canRespondbooleanإلزامي
  • pastobject[]إلزامي
    • idstringإلزامي
    • titlestring | nullإلزامي
    • kindstringإلزامي

      القيم: "pickup", "fixture"

    • statusstringإلزامي

      القيم: "planned", "played", "cancelled"

    • startsAtstringإلزامي

      ISO 8601 (UTC)

    • durationMinnumberإلزامي
    • scoreStatestringإلزامي

      القيم: "none", "entered", "confirmed"

    • venueobject | nullإلزامي
      • namestringإلزامي
      • districtstring | nullإلزامي
      • citystring | nullإلزامي
      • addressstring | nullإلزامي
      • verifiedbooleanإلزامي
      • latitudenumber | nullإلزامي

        WGS84, when the venue set its location (for directions); null otherwise

      • longitudenumber | nullإلزامي

        WGS84, when the venue set its location (for directions); null otherwise

    • pitchobject | nullإلزامي
      • namestringإلزامي
    • sidesobjectإلزامي
      • Aobjectإلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsnumber | nullإلزامي

          Null until the score is entered

        • bibHexstring | nullإلزامي
        • teamIdstring | nullإلزامي
        • teamNamestring | nullإلزامي
      • Bobjectإلزامي
        • sidestringإلزامي

          القيم: "A", "B"

        • labelstringإلزامي
        • goalsnumber | nullإلزامي

          Null until the score is entered

        • bibHexstring | nullإلزامي
        • teamIdstring | nullإلزامي
        • teamNamestring | nullإلزامي
    • comingnumberإلزامي

      How many said "yes"

    • meobjectإلزامي
      • rsvpstring | nullإلزامي

        القيم: "invited", "yes", "maybe", "no"

      • sidestring | nullإلزامي

        القيم: "A", "B"

      • isOrganizerbooleanإلزامي
    • canRespondbooleanإلزامي
• POST/api/v1/matches

  Create a match

  يحتاج إلى جلسة

  You come ("yes") on side A, or on B when you belong to side B's team only. Teams playing a side and invited teams get every member invited, on their team's side. Set alreadyPlayed: true to record a past match; it stays planned with no score or attendance until PUT /api/v1/matches/{id}/score saves them and changes its status to played. The squad can still be completed and invited players can answer before that. 422 fields codes: required, invalid (also hidden or text-direction characters in the title, a side's label or the notes), staffWord (the title or a side's label reads as staff: “Akıllı Futbol”, “Admin”, “Destek”…), tooLong, notMember (a team you are not in), sameTeam, noOfficialCamera; date or startsAt = notEnded when an already-played match has not finished; reservationId = invalid (not your confirmed booking, or combined with alreadyPlayed), unavailable (it has a match, or its time passed) or mismatch (the venue, pitch, start or length you sent differ). 429 fields.form = tooManyMatches: 20 new matches a day per person.

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • titlestring | nullاختياري

    Up to 60 characters

  • kindstringاختياري

    pickup (default): sides picked among friends; fixture: two teams

    القيم: "pickup", "fixture"

  • datestringاختياري

    Kick-off date on an Istanbul clock, YYYY-MM-DD (with time)

  • timestringاختياري

    Kick-off on an Istanbul clock, HH:MM (with date)

  • startsAtstringاختياري

    Instead of date + time: an ISO 8601 instant with an offset

  • durationMinnumberاختياري

    Default 60

    القيم: 60, 90, 120

  • venueIdstring | nullاختياري
  • pitchIdstring | nullاختياري

    A pitch of the venue (sets the venue when venueId is left out)

  • recordingstringاختياري

    official only on a pitch with an official camera

    القيم: "upload", "official"

  • sidesobjectاختياري

    Default labels "Turuncular" and "Maviler"

    • Aobjectإلزامي
      • labelstringإلزامي

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullاختياري

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullاختياري

        The bib colour as #rrggbb, or null for no bibs

    • Bobjectإلزامي
      • labelstringإلزامي

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullاختياري

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullاختياري

        The bib colour as #rrggbb, or null for no bibs

  • invitedTeamIdsstring[]اختياري

    Your teams whose members all get an invitation

  • notesstring | nullاختياري

    Up to 500 characters

  • alreadyPlayedbooleanاختياري

    Default false. True requires kick-off plus duration to have passed. The match stays planned until score and attendance are saved separately. Cannot be combined with reservationId.

  • reservationIdstringاختياري

    One of your confirmed bookings (GET /api/v1/reservations) that has no match yet: the match takes its venue, pitch, start and length and is linked to it (ADR-005)

  data في الاستجابة

  • idstringإلزامي
  • codestringإلزامي
  • inviteUrlstring (uri)إلزامي

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page.

• GET/api/v1/matches/{id}

  A match with its sides, people, place and code

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  data في الاستجابة

  • idstringإلزامي
  • titlestring | nullإلزامي
  • kindstringإلزامي

    القيم: "pickup", "fixture"

  • statusstringإلزامي

    القيم: "planned", "played", "cancelled"

  • startsAtstringإلزامي
  • endsAtstringإلزامي
  • durationMinnumberإلزامي
  • recordingstringإلزامي

    القيم: "upload", "official"

  • scoreStatestringإلزامي

    القيم: "none", "entered", "confirmed"

  • notesstring | nullإلزامي
  • cancelledAtstring | nullإلزامي
  • organizerobjectإلزامي
    • playerIdstringإلزامي
    • displayNamestringإلزامي
    • handlestring | nullإلزامي
  • venueobject | nullإلزامي
    • idstringإلزامي
    • namestringإلزامي
    • citystring | nullإلزامي
    • districtstring | nullإلزامي
    • addressstring | nullإلزامي
    • verifiedbooleanإلزامي
    • slugstring | nullإلزامي

      The venue's public booking page is /venues/<slug> while its pitch admin login is on; null otherwise

    • latitudenumber | nullإلزامي

      WGS84, when the venue set its location (for directions); null otherwise

    • longitudenumber | nullإلزامي

      WGS84, when the venue set its location (for directions); null otherwise

  • pitchobject | nullإلزامي
    • idstringإلزامي
    • namestringإلزامي
    • indoorbooleanإلزامي
    • officialCamerabooleanإلزامي
  • cameraobject | nullإلزامي

    Set when the match waits for the pitch's official camera

    • idstringإلزامي
    • labelstringإلزامي
    • officialbooleanإلزامي
  • sidesobjectإلزامي
    • Aobjectإلزامي
      • sidestringإلزامي

        القيم: "A", "B"

      • labelstringإلزامي
      • goalsnumber | nullإلزامي

        Null until the score is entered

      • bibHexstring | nullإلزامي
      • teamIdstring | nullإلزامي
      • teamNamestring | nullإلزامي
    • Bobjectإلزامي
      • sidestringإلزامي

        القيم: "A", "B"

      • labelstringإلزامي
      • goalsnumber | nullإلزامي

        Null until the score is entered

      • bibHexstring | nullإلزامي
      • teamIdstring | nullإلزامي
      • teamNamestring | nullإلزامي
  • participantsobject[]إلزامي
    • playerIdstringإلزامي
    • displayNamestringإلزامي
    • handlestring | nullإلزامي

      Null for guests

    • kindstringإلزامي

      القيم: "registered", "guest"

    • sidestring | nullإلزامي

      القيم: "A", "B"

    • rsvpstringإلزامي

      القيم: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullإلزامي
    • attendedbooleanإلزامي
    • isOrganizerbooleanإلزامي
    • positionsstring[]إلزامي

      Where the person likes to play, as on their profile; empty when they gave none or their visibility hides it from you, and for guests

      القيم: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullإلزامي

      Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

      • smallstringإلزامي

        128 px

      • mediumstringإلزامي

        512 px

      • largestringإلزامي

        1024 px

  • teamsobject[]إلزامي
    • teamIdstringإلزامي
    • namestringإلزامي
    • sidestring | nullإلزامي

      القيم: "A", "B"

    • membersnumberإلزامي
  • codestring | nullإلزامي

    The live 6-letter join code; null once the match is cancelled

  • inviteUrlstring (uri) | nullإلزامي

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page. Null with the code

  • hasVideobooleanإلزامي
  • kickedOffbooleanإلزامي
  • endedbooleanإلزامي

    Kick-off plus the duration has passed

  • viewerobjectإلزامي
    • playerIdstringإلزامي

      Your player id, to find yourself in participants

    • canManagebooleanإلزامي
    • isOrganizerbooleanإلزامي
    • isAdminbooleanإلزامي
    • rsvpstring | nullإلزامي

      القيم: "invited", "yes", "maybe", "no"

    • sidestring | nullإلزامي

      القيم: "A", "B"

    • canRespondbooleanإلزامي
• PATCH/api/v1/matches/{id}

  Change a match (managers)

  يحتاج إلى جلسة

  Answers are kept. A team newly set on a side gets its members invited there, and a team moved to the other side takes its people along. Once the score is in, the details can still be corrected but a side's team cannot change (409 fields.form = scored). A match with a booking at its venue moves the booking with it: 409 fields.form = bookingSlotTaken when the new time or pitch is not free on the venue's grid, bookingVenue when the match would leave the booking's venue (cancel the booking first). Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  جسم الطلب

  • titlestring | nullاختياري

    Up to 60 characters

  • kindstringاختياري

    pickup (default): sides picked among friends; fixture: two teams

    القيم: "pickup", "fixture"

  • datestringاختياري

    Kick-off date on an Istanbul clock, YYYY-MM-DD (with time)

  • timestringاختياري

    Kick-off on an Istanbul clock, HH:MM (with date)

  • startsAtstringاختياري

    Instead of date + time: an ISO 8601 instant with an offset

  • durationMinnumberاختياري

    Default 60

    القيم: 60, 90, 120

  • venueIdstring | nullاختياري
  • pitchIdstring | nullاختياري

    A pitch of the venue (sets the venue when venueId is left out)

  • recordingstringاختياري

    official only on a pitch with an official camera

    القيم: "upload", "official"

  • notesstring | nullاختياري

    Up to 500 characters

  • sidesobjectاختياري

    Only the fields you send change; a newly set team gets its members invited

    • Aobjectاختياري
      • labelstringاختياري

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullاختياري

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullاختياري

        The bib colour as #rrggbb, or null for no bibs

    • Bobjectاختياري
      • labelstringاختياري

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullاختياري

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullاختياري

        The bib colour as #rrggbb, or null for no bibs

  data في الاستجابة

  • idstringإلزامي
  • titlestring | nullإلزامي
  • kindstringإلزامي

    القيم: "pickup", "fixture"

  • statusstringإلزامي

    القيم: "planned", "played", "cancelled"

  • startsAtstringإلزامي
  • endsAtstringإلزامي
  • durationMinnumberإلزامي
  • recordingstringإلزامي

    القيم: "upload", "official"

  • scoreStatestringإلزامي

    القيم: "none", "entered", "confirmed"

  • notesstring | nullإلزامي
  • cancelledAtstring | nullإلزامي
  • organizerobjectإلزامي
    • playerIdstringإلزامي
    • displayNamestringإلزامي
    • handlestring | nullإلزامي
  • venueobject | nullإلزامي
    • idstringإلزامي
    • namestringإلزامي
    • citystring | nullإلزامي
    • districtstring | nullإلزامي
    • addressstring | nullإلزامي
    • verifiedbooleanإلزامي
    • slugstring | nullإلزامي

      The venue's public booking page is /venues/<slug> while its pitch admin login is on; null otherwise

    • latitudenumber | nullإلزامي

      WGS84, when the venue set its location (for directions); null otherwise

    • longitudenumber | nullإلزامي

      WGS84, when the venue set its location (for directions); null otherwise

  • pitchobject | nullإلزامي
    • idstringإلزامي
    • namestringإلزامي
    • indoorbooleanإلزامي
    • officialCamerabooleanإلزامي
  • cameraobject | nullإلزامي

    Set when the match waits for the pitch's official camera

    • idstringإلزامي
    • labelstringإلزامي
    • officialbooleanإلزامي
  • sidesobjectإلزامي
    • Aobjectإلزامي
      • sidestringإلزامي

        القيم: "A", "B"

      • labelstringإلزامي
      • goalsnumber | nullإلزامي

        Null until the score is entered

      • bibHexstring | nullإلزامي
      • teamIdstring | nullإلزامي
      • teamNamestring | nullإلزامي
    • Bobjectإلزامي
      • sidestringإلزامي

        القيم: "A", "B"

      • labelstringإلزامي
      • goalsnumber | nullإلزامي

        Null until the score is entered

      • bibHexstring | nullإلزامي
      • teamIdstring | nullإلزامي
      • teamNamestring | nullإلزامي
  • participantsobject[]إلزامي
    • playerIdstringإلزامي
    • displayNamestringإلزامي
    • handlestring | nullإلزامي

      Null for guests

    • kindstringإلزامي

      القيم: "registered", "guest"

    • sidestring | nullإلزامي

      القيم: "A", "B"

    • rsvpstringإلزامي

      القيم: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullإلزامي
    • attendedbooleanإلزامي
    • isOrganizerbooleanإلزامي
    • positionsstring[]إلزامي

      Where the person likes to play, as on their profile; empty when they gave none or their visibility hides it from you, and for guests

      القيم: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullإلزامي

      Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

      • smallstringإلزامي

        128 px

      • mediumstringإلزامي

        512 px

      • largestringإلزامي

        1024 px

  • teamsobject[]إلزامي
    • teamIdstringإلزامي
    • namestringإلزامي
    • sidestring | nullإلزامي

      القيم: "A", "B"

    • membersnumberإلزامي
  • codestring | nullإلزامي

    The live 6-letter join code; null once the match is cancelled

  • inviteUrlstring (uri) | nullإلزامي

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page. Null with the code

  • hasVideobooleanإلزامي
  • kickedOffbooleanإلزامي
  • endedbooleanإلزامي

    Kick-off plus the duration has passed

  • viewerobjectإلزامي
    • playerIdstringإلزامي

      Your player id, to find yourself in participants

    • canManagebooleanإلزامي
    • isOrganizerbooleanإلزامي
    • isAdminbooleanإلزامي
    • rsvpstring | nullإلزامي

      القيم: "invited", "yes", "maybe", "no"

    • sidestring | nullإلزامي

      القيم: "A", "B"

    • canRespondbooleanإلزامي
• POST/api/v1/matches/{id}/cancel

  Cancel a match (managers)

  يحتاج إلى جلسة

  The code stops working, and the bookings linked to the match that have not started are cancelled with it (their answer reads @matchCancelled). 409 fields.form = scored once the score is in. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  data في الاستجابة

  • idstringإلزامي
  • statusstringإلزامي

    القيم: "cancelled"

• POST/api/v1/matches/{id}/code

  Renew the match's join code (managers)

  يحتاج إلى جلسة

  The old code stops working at once; share the new one again. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  data في الاستجابة

  • codestringإلزامي

    6 letters A–Z without I and O

  • inviteUrlstring (uri)إلزامي

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page.

• POST/api/v1/matches/{id}/rsvp

  Answer an invitation

  يحتاج إلى جلسة

  For invited people and members of invited teams (who join on their team's side). 409 fields.form = cancelled or scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  جسم الطلب

  • answerstringإلزامي

    القيم: "yes", "maybe", "no"

  data في الاستجابة

  • rsvpstringإلزامي

    القيم: "invited", "yes", "maybe", "no"

  • sidestring | nullإلزامي

    القيم: "A", "B"

• POST/api/v1/matches/{id}/teams

  Invite one of your teams (managers)

  يحتاج إلى جلسة

  Every member not yet in the match is invited. A team playing a side is invited on that side (422 fields.side = teamPlaysSide for the other one); otherwise members without a side, or still on the team's earlier side, take side. 422 fields.teamId = notMember for a team you are not in. Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  جسم الطلب

  • teamIdstringإلزامي
  • sidestring | nullاختياري

    القيم: "A", "B"

  data في الاستجابة

  • invitednumberإلزامي
  • membersnumberإلزامي
• POST/api/v1/matches/{id}/participants

  Invite a person by username, or add a guest by name (managers)

  يحتاج إلى جلسة

  A guest is a player without an account, counted as coming; the name follows the same rules as a display name (422 fields.guestName = required, tooShort, tooLong or invalid). 422 fields.username = notFound; 409 fields.username = already. Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  جسم الطلب

  • usernamestringاختياري
  • sidestring | nullاختياري

    القيم: "A", "B"

  • guestNamestringاختياري

    2–40 characters

  data في الاستجابة

  • playerIdstringإلزامي
  • displayNamestringإلزامي
  • handlestring | nullإلزامي

    Null for guests

  • kindstringإلزامي

    القيم: "registered", "guest"

  • sidestring | nullإلزامي

    القيم: "A", "B"

  • rsvpstringإلزامي

    القيم: "invited", "yes", "maybe", "no"

  • respondedAtstring | nullإلزامي
  • attendedbooleanإلزامي
  • isOrganizerbooleanإلزامي
  • positionsstring[]إلزامي

    Where the person likes to play, as on their profile; empty when they gave none or their visibility hides it from you, and for guests

    القيم: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullإلزامي

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringإلزامي

      128 px

    • mediumstringإلزامي

      512 px

    • largestringإلزامي

      1024 px

• PATCH/api/v1/matches/{id}/participants/{playerId}

  Move a player to a side, or answer for a guest (managers)

  يحتاج إلى جلسة

  403 when rsvp is sent for a registered player (people answer for themselves); 422 fields.rsvp = invalid for any other value. Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي
  • playerIdstringإلزامي

  جسم الطلب

  • sidestring | nullاختياري

    القيم: "A", "B"

  • rsvpstringاختياري

    Guests only

    القيم: "yes", "maybe", "no"

  data في الاستجابة

  • playerIdstringإلزامي
  • sidestring | nullإلزامي

    القيم: "A", "B"

  • rsvpstringإلزامي

    القيم: "invited", "yes", "maybe", "no"

• DELETE/api/v1/matches/{id}/participants/{playerId}

  Take a player off the match (managers)

  يحتاج إلى جلسة

  409 fields.form = organizer (the organiser stays). Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي
  • playerIdstringإلزامي

  data في الاستجابة

  • playerIdstringإلزامي
  • removedbooleanإلزامي

    القيم: true

• GET/api/v1/venues

  Search venues

  يحتاج إلى جلسة

  Verified venues first, then by name; at most 12. An empty q lists venues the same way.

  اعرض الحقولأخفِ الحقول

  معاملات الاستعلام

  • qstringاختياري

    Words that must all appear in the name, district or city; Turkish letters optional ("kadikoy" finds "Kadıköy")

  data في الاستجابة

  النوع: object[]

  حقول كل عنصر:

  • idstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • districtstring | nullإلزامي
  • addressstring | nullإلزامي
  • verifiedbooleanإلزامي

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]إلزامي
    • idstringإلزامي
    • namestringإلزامي

      e.g. "1. Saha"

    • indoorbooleanإلزامي
    • officialCamerabooleanإلزامي

      The pitch has the venue's own recorder: a match here can wait for its recording

• POST/api/v1/venues

  Add a venue

  يحتاج إلى جلسة

  New venues are unverified until an admin checks them. When a venue with the same name, city and district is already listed (ignoring case and Turkish letters), that venue comes back instead of a copy. 422 with fields (required, tooShort, tooLong, invalid for hidden characters, staffWord when the name reads as staff: “Akıllı Futbol”, “Resmi”…). 429 RATE_LIMITED after 20 new venues in 24 hours (admins are not limited).

  اعرض الحقولأخفِ الحقول

  جسم الطلب

  • namestringإلزامي

    2–80 characters

  • citystringإلزامي

    2–40 characters

  • districtstring | nullاختياري

    Up to 40 characters

  • addressstring | nullاختياري

    Up to 160 characters

  • pitchNamestring | nullاختياري

    A first pitch, e.g. "1. Saha"

  • indoorbooleanاختياري

    Whether that first pitch is indoors

  data في الاستجابة

  • idstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • districtstring | nullإلزامي
  • addressstring | nullإلزامي
  • verifiedbooleanإلزامي

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]إلزامي
    • idstringإلزامي
    • namestringإلزامي

      e.g. "1. Saha"

    • indoorbooleanإلزامي
    • officialCamerabooleanإلزامي

      The pitch has the venue's own recorder: a match here can wait for its recording

• GET/api/v1/venues/recent

  Venues of your latest matches, then venues you added (at most five)

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  النوع: object[]

  حقول كل عنصر:

  • idstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • districtstring | nullإلزامي
  • addressstring | nullإلزامي
  • verifiedbooleanإلزامي

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]إلزامي
    • idstringإلزامي
    • namestringإلزامي

      e.g. "1. Saha"

    • indoorbooleanإلزامي
    • officialCamerabooleanإلزامي

      The pitch has the venue's own recorder: a match here can wait for its recording

• GET/api/v1/venues/{id}

  A venue with its pitches

  يحتاج إلى جلسة

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  data في الاستجابة

  • idstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • districtstring | nullإلزامي
  • addressstring | nullإلزامي
  • verifiedbooleanإلزامي

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]إلزامي
    • idstringإلزامي
    • namestringإلزامي

      e.g. "1. Saha"

    • indoorbooleanإلزامي
    • officialCamerabooleanإلزامي

      The pitch has the venue's own recorder: a match here can wait for its recording

• POST/api/v1/venues/{id}/pitches

  Add a pitch to a venue

  يحتاج إلى جلسة

  Admins, or the person who added the venue while it is unverified (403 otherwise). 409 fields.name = taken for a duplicate name.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  جسم الطلب

  • namestringإلزامي

    1–40 characters, unique within the venue

  • indoorbooleanاختياري

  data في الاستجابة

  • idstringإلزامي
  • namestringإلزامي
  • citystring | nullإلزامي
  • districtstring | nullإلزامي
  • addressstring | nullإلزامي
  • verifiedbooleanإلزامي

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]إلزامي
    • idstringإلزامي
    • namestringإلزامي

      e.g. "1. Saha"

    • indoorbooleanإلزامي
    • officialCamerabooleanإلزامي

      The pitch has the venue's own recorder: a match here can wait for its recording

• GET/api/v1/venues/{id}/logo/{version}

  A venue's logo

  لا يحتاج إلى جلسة

  Public, no sign-in. Take the path from the venue's logo field rather than building it: the version names one picture for good, so the answer is cached for a year (Cache-Control: public, max-age=31536000, immutable). A replaced or removed logo's version answers 404 NOT_FOUND. A PNG, JPEG or WebP of at most 1024 pixels a side, its type read from the file's bytes when it was uploaded; sent with X-Content-Type-Options: nosniff, Content-Security-Policy: default-src 'none' and Cross-Origin-Resource-Policy: same-site.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي
  • versionstringإلزامي

• GET/api/v1/venues/{id}/profile

  A venue's public page

  لا يحتاج إلى جلسة

  Works signed out. 404 unless the venue has a login that is switched on (only those venues have a page).

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  data في الاستجابة

  • idstringإلزامي
  • slugstringإلزامي

    The page's address: /venues/<slug>

  • namestringإلزامي
  • verifiedbooleanإلزامي

    Checked by an admin; show the verified mark

  • districtstring | nullإلزامي
  • citystring | nullإلزامي
  • addressstring | nullإلزامي
  • descriptionstring | nullإلزامي

    Plain text, line breaks kept

  • logostring | nullإلزامي

    A path to the logo (immutable, cache it), or null

  • directionsobjectإلزامي

    Driving directions: to the coordinates when known, else a search for the name and address

    • googlestring (uri)إلزامي
    • applestring (uri)إلزامي
  • whatsappobject | nullإلزامي

    Only when the venue shows it

    • digitsstringإلزامي

      International, without +

    • linkstring (uri)إلزامي

      https://wa.me/<digits>

  • reservationsEnabledbooleanإلزامي

    The venue takes requests in the app; otherwise point people to WhatsApp

  • autoConfirmbooleanإلزامي

    Requests from people who already had a booking confirmed here are confirmed at once, while they hold fewer than 2 coming bookings and requests here

  • slotMinutesnumberإلزامي

    Start times every 30 or 60 minutes from opening

    القيم: 30, 60

  • openingHoursobjectإلزامي

    Istanbul clock; null: closed

    • monobject | nullإلزامي
      • openstringإلزامي

        "10:00"

      • closestringإلزامي

        "01:00"; at or before open means after midnight

    • tueobject | nullإلزامي
      • openstringإلزامي

        "10:00"

      • closestringإلزامي

        "01:00"; at or before open means after midnight

    • wedobject | nullإلزامي
      • openstringإلزامي

        "10:00"

      • closestringإلزامي

        "01:00"; at or before open means after midnight

    • thuobject | nullإلزامي
      • openstringإلزامي

        "10:00"

      • closestringإلزامي

        "01:00"; at or before open means after midnight

    • friobject | nullإلزامي
      • openstringإلزامي

        "10:00"

      • closestringإلزامي

        "01:00"; at or before open means after midnight

    • satobject | nullإلزامي
      • openstringإلزامي

        "10:00"

      • closestringإلزامي

        "01:00"; at or before open means after midnight

    • sunobject | nullإلزامي
      • openstringإلزامي

        "10:00"

      • closestringإلزامي

        "01:00"; at or before open means after midnight

  • todaystringإلزامي

    The venue day open now (YYYY-MM-DD): the first day to offer. A venue day is named by the date it opens: Friday 10:00–02:00 holds Saturday 01:00

  • pitchesobject[]إلزامي
    • idstringإلزامي
    • namestringإلزامي
    • indoorbooleanإلزامي
• GET/api/v1/venues/{id}/availability

  Free times on a venue day, per pitch

  لا يحتاج إلى جلسة

  States only, never who or why: confirmed bookings and blocked time make a time taken; requests the venue has not answered make it requested (still askable). With a bearer token the lead time is the person's own. 422 fields.date = outOfRange.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  معاملات الاستعلام

  • datestringاختياري

    The venue day, YYYY-MM-DD (default: the venue day open now); from yesterday up to 31 days ahead

  • durationMinstringاختياري

    60 (default), 90 or 120

  data في الاستجابة

  • datestringإلزامي
  • durationMinnumberإلزامي
  • slotMinutesnumberإلزامي
  • hoursobject | nullإلزامي

    That venue day's hours; null when closed

    • openstringإلزامي

      "10:00"

    • closestringإلزامي

      "01:00"; at or before open means after midnight

  • leadMinutesnumberإلزامي

    How long before its start a time can still be asked for: 150 minutes, or 30 for someone the venue confirms at once

  • pitchesobject[]إلزامي
    • idstringإلزامي
    • namestringإلزامي
    • slotsobject[]إلزامي
      • timestringإلزامي

        Istanbul wall clock, "21:00"

      • datestringإلزامي

        The calendar date the time falls on (the next date after midnight)

      • startsAtstringإلزامي

        ISO 8601 (UTC)

      • nextDaybooleanإلزامي

        After the venue day's midnight: show it as "Friday night 01:00 (Saturday 9 November)"

      • statestringإلزامي

        requested: someone asked and the venue has not answered; it can still be asked for

        القيم: "free", "requested", "taken", "soon", "tooFar"

• POST/api/v1/venues/{id}/reservations

  Ask a venue for a booking

  يحتاج إلى جلسة

  The booking waits for the venue (pending) and lapses 2 hours before its start if not answered; it is confirmed at once where the venue auto-confirms and you already had a booking confirmed there. 404 for a venue without a page (no login, or switched off). 409 fields.form: bookingsOff (the venue takes no requests now; use its WhatsApp), alreadyAsked, tooManyOpen (2 requests already waiting at this venue); fields.time = taken. 422 fields: pitchId.invalid, teamId.notMember, phone.invalid, matchId (invalid, booked, otherTime, otherPlace), time (closed, offGrid, soon, tooFar). 429 RATE_LIMITED after 6 requests in an hour (refused requests do not count).

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  جسم الطلب

  • pitchIdstringإلزامي
  • datestringإلزامي

    The venue day, YYYY-MM-DD

  • timestringإلزامي

    One of that day's start times (a slot's time), HH:MM

  • durationMinnumberإلزامي

    القيم: 60, 90, 120

  • teamIdstring | nullاختياري

    One of your teams: side A of the match made on confirmation

  • notestring | nullاختياري

    Up to 300 characters, for the venue

  • phonestring | nullاختياري

    Shared with this venue only and erased 30 days after the start (or when the booking is declined, cancelled or lapses). "0532 123 45 67", "+90…"

  • wantsMatchbooleanاختياري

    Default true: when the venue confirms, your match is made (this venue, pitch and time, your team on side A) and linked

  • matchIdstring | nullاختياري

    Instead: one of your own matches at exactly this time with no booking yet, to link

  data في الاستجابة

  • idstringإلزامي
  • venueobjectإلزامي
    • idstringإلزامي
    • namestringإلزامي
    • verifiedbooleanإلزامي
    • slugstring | nullإلزامي

      Null once the venue's page is gone

  • pitchobjectإلزامي
    • idstringإلزامي
    • namestringإلزامي
  • startsAtstringإلزامي
  • endsAtstringإلزامي
  • durationMinnumberإلزامي
  • venueDatestringإلزامي

    The venue day it belongs to

  • nextDaybooleanإلزامي
  • statusstringإلزامي

    lapsed: the venue did not answer by 2 hours before the start

    القيم: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullإلزامي

    The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

  • cancelledBystring | nullإلزامي

    القيم: "person", "venue"

  • teamobject | nullإلزامي
    • idstringإلزامي
    • namestringإلزامي
  • matchobject | nullإلزامي

    The match made from (or linked to) the booking, while it is not cancelled

    • idstringإلزامي
  • wantsMatchbooleanإلزامي
  • canCancelbooleanإلزامي
  • canMakeMatchbooleanإلزامي

    Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

• GET/api/v1/reservations

  Your bookings

  يحتاج إلى جلسة

  upcoming: coming bookings whatever their answer (until they start; a confirmed one until it ends), soonest first. past: those of the last 30 days, latest first.

  اعرض الحقولأخفِ الحقول

  data في الاستجابة

  • upcomingobject[]إلزامي
    • idstringإلزامي
    • venueobjectإلزامي
      • idstringإلزامي
      • namestringإلزامي
      • verifiedbooleanإلزامي
      • slugstring | nullإلزامي

        Null once the venue's page is gone

    • pitchobjectإلزامي
      • idstringإلزامي
      • namestringإلزامي
    • startsAtstringإلزامي
    • endsAtstringإلزامي
    • durationMinnumberإلزامي
    • venueDatestringإلزامي

      The venue day it belongs to

    • nextDaybooleanإلزامي
    • statusstringإلزامي

      lapsed: the venue did not answer by 2 hours before the start

      القيم: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullإلزامي

      The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

    • cancelledBystring | nullإلزامي

      القيم: "person", "venue"

    • teamobject | nullإلزامي
      • idstringإلزامي
      • namestringإلزامي
    • matchobject | nullإلزامي

      The match made from (or linked to) the booking, while it is not cancelled

      • idstringإلزامي
    • wantsMatchbooleanإلزامي
    • canCancelbooleanإلزامي
    • canMakeMatchbooleanإلزامي

      Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

  • pastobject[]إلزامي
    • idstringإلزامي
    • venueobjectإلزامي
      • idstringإلزامي
      • namestringإلزامي
      • verifiedbooleanإلزامي
      • slugstring | nullإلزامي

        Null once the venue's page is gone

    • pitchobjectإلزامي
      • idstringإلزامي
      • namestringإلزامي
    • startsAtstringإلزامي
    • endsAtstringإلزامي
    • durationMinnumberإلزامي
    • venueDatestringإلزامي

      The venue day it belongs to

    • nextDaybooleanإلزامي
    • statusstringإلزامي

      lapsed: the venue did not answer by 2 hours before the start

      القيم: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullإلزامي

      The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

    • cancelledBystring | nullإلزامي

      القيم: "person", "venue"

    • teamobject | nullإلزامي
      • idstringإلزامي
      • namestringإلزامي
    • matchobject | nullإلزامي

      The match made from (or linked to) the booking, while it is not cancelled

      • idstringإلزامي
    • wantsMatchbooleanإلزامي
    • canCancelbooleanإلزامي
    • canMakeMatchbooleanإلزامي

      Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

• DELETE/api/v1/reservations/{id}

  Cancel one of your bookings

  يحتاج إلى جلسة

  Waiting or confirmed, before it starts; the time is free again. 404 for someone else's booking; 409 fields.form: notActive, started.

  اعرض الحقولأخفِ الحقول

  معاملات المسار

  • idstringإلزامي

  data في الاستجابة

  • idstringإلزامي
  • venueobjectإلزامي
    • idstringإلزامي
    • namestringإلزامي
    • verifiedbooleanإلزامي
    • slugstring | nullإلزامي

      Null once the venue's page is gone

  • pitchobjectإلزامي
    • idstringإلزامي
    • namestringإلزامي
  • startsAtstringإلزامي
  • endsAtstringإلزامي
  • durationMinnumberإلزامي
  • venueDatestringإلزامي

    The venue day it belongs to

  • nextDaybooleanإلزامي
  • statusstringإلزامي

    lapsed: the venue did not answer by 2 hours before the start

    القيم: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullإلزامي

    The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

  • cancelledBystring | nullإلزامي

    القيم: "person", "venue"

  • teamobject | nullإلزامي
    • idstringإلزامي
    • namestringإلزامي
  • matchobject | nullإلزامي

    The match made from (or linked to) the booking, while it is not cancelled

    • idstringإلزامي
  • wantsMatchbooleanإلزامي
  • canCancelbooleanإلزامي
  • canMakeMatchbooleanإلزامي

    Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId